ข้ามไปยังเนื้อหา
Sursa Developers

ออบเจ็กต์

WebhookCreated

ฟิลด์

  • idintegerจำเป็น
  • urlstringจำเป็น
  • descriptionstringจำเป็น
  • eventsarray of WebhookEventFilterจำเป็น
  • activebooleanจำเป็น
  • statusWebhookStatusจำเป็น
  • paused_atstring (date-time) | null
  • paused_reasonstring | null

    failures: ความพยายามส่งล้มเหลว 10 ครั้งติดต่อกัน feature_disabled: แพ็กเกจไม่มีเว็บฮุก

  • disabled_reasonstring | null

    gone: เซิร์ฟเวอร์ผู้รับตอบกลับด้วย 410 manual: ผู้ดูแลระบบปิดใช้งาน

    ค่าที่ใช้ได้: gonemanualnull

  • disabled_atstring (date-time) | null
  • roleWebhookRoleจำเป็น
  • data_profile_idinteger | null

    โปรไฟล์ข้อมูลของเว็บฮุก (null หมายถึงไม่มีโปรไฟล์ เหมือนคีย์ API ที่มีบทบาทเดียวกัน)

  • collection_idsarray of integerจำเป็น

    คอลเลกชันที่เว็บฮุกรับอีเวนต์ ว่างหมายถึงทุกคอลเลกชันที่บทบาทและโปรไฟล์ข้อมูลเข้าถึงได้

  • tagsarray of stringจำเป็น

    อีเวนต์ของการ์ดเฉพาะการ์ดที่มีแท็กใดแท็กหนึ่งในนี้ ว่างหมายถึงไม่กรอง

  • payloadWebhookPayloadModeจำเป็น
  • headersarray of WebhookHeaderจำเป็น
  • auth_typestring | null

    ประเภทของการอนุญาตขาออก (null หมายถึงไม่มี)

    ค่าที่ใช้ได้: bearerbasicnull

  • auth_setbooleanจำเป็น

    ตั้งค่าการอนุญาตขาออกไว้หรือไม่ (ระบบไม่ส่งคืนค่าเหล่านี้)

  • previous_secret_valid_untilstring (date-time) | null

    การส่งจะลงนามด้วยข้อมูลลับเดิมควบคู่ไปจนถึงเวลานี้ (null หมายถึงไม่มีช่วงเปลี่ยนผ่าน)

  • consecutive_failuresintegerจำเป็น
  • last_delivery_atstring (date-time) | null
  • last_success_atstring (date-time) | null
  • last_errorstring | null
  • created_byinteger | null
  • created_by_namestring | null
  • created_atstring (date-time)จำเป็น
  • updated_atstring (date-time)จำเป็น
  • secretstringจำเป็น

    whsec_ ตามด้วย 32 ไบต์ในรูปแบบ base64 (ข้อมูลลับใหม่ใช้ชุดอักขระมาตรฐานพร้อม padding ส่วนข้อมูลลับเก่าใช้ base64url) จัดเก็บไว้ที่ฝั่งเซิร์ฟเวอร์ผู้รับ ข้อมูลลับนี้จะไม่ปรากฏในการตอบกลับของ API อีก คีย์ลงนามของ Standard Webhooks คือผลการถอดรหัส base64 ของส่วนหลัง whsec_

  • previous_valid_untilstring (date-time) | null

    เวลาที่ยังยอมรับข้อมูลลับเดิมถึง (หลังการหมุนเวียน) เป็น null เมื่อสร้าง

ใช้โดย