ออบเจ็กต์
WebhookEndpoint
ฟิลด์
idintegerจำเป็นurlstringจำเป็นdescriptionstringจำเป็นactivebooleanจำเป็นpaused_atstring (date-time) | nullpaused_reasonstring | nullfailures: ความพยายามส่งล้มเหลว 10 ครั้งติดต่อกันfeature_disabled: แพ็กเกจไม่มีเว็บฮุกdisabled_reasonstring | nullgone: เซิร์ฟเวอร์ผู้รับตอบกลับด้วย 410manual: ผู้ดูแลระบบปิดใช้งานค่าที่ใช้ได้:
gonemanualnulldisabled_atstring (date-time) | nulldata_profile_idinteger | nullโปรไฟล์ข้อมูลของเว็บฮุก (
nullหมายถึงไม่มีโปรไฟล์ เหมือนคีย์ API ที่มีบทบาทเดียวกัน)collection_idsarray of integerจำเป็นคอลเลกชันที่เว็บฮุกรับอีเวนต์ ว่างหมายถึงทุกคอลเลกชันที่บทบาทและโปรไฟล์ข้อมูลเข้าถึงได้
tagsarray of stringจำเป็นอีเวนต์ของการ์ดเฉพาะการ์ดที่มีแท็กใดแท็กหนึ่งในนี้ ว่างหมายถึงไม่กรอง
auth_typestring | nullประเภทของการอนุญาตขาออก (
nullหมายถึงไม่มี)ค่าที่ใช้ได้:
bearerbasicnullauth_setbooleanจำเป็นตั้งค่าการอนุญาตขาออกไว้หรือไม่ (ระบบไม่ส่งคืนค่าเหล่านี้)
previous_secret_valid_untilstring (date-time) | nullการส่งจะลงนามด้วยข้อมูลลับเดิมควบคู่ไปจนถึงเวลานี้ (
nullหมายถึงไม่มีช่วงเปลี่ยนผ่าน)healthWebhookHealthconsecutive_failuresintegerจำเป็นlast_delivery_atstring (date-time) | nulllast_success_atstring (date-time) | nulllast_errorstring | nullcreated_byinteger | nullcreated_by_namestring | nullcreated_atstring (date-time)จำเป็นupdated_atstring (date-time)จำเป็น
ใช้โดย
- GET
/v1/webhooks/{webhook_id}ดึงเว็บฮุก - PATCH
/v1/webhooks/{webhook_id}อัปเดตเว็บฮุก - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretเพิกถอนข้อมูลลับก่อนหน้า - POST
/v1/webhooks/{webhook_id}/resumeกลับมาใช้งานเว็บฮุกต่อ