Objek

WebhookEndpoint

Field

• idintegerwajib
• urlstringwajib
• descriptionstringwajib
• eventsarray of WebhookEventFilterwajib
• activebooleanwajib
• statusWebhookStatuswajib
• paused_atstring (date-time) | null
• paused_reasonstring | null

  failures: 10 upaya gagal berturut-turut; feature_disabled: paket tidak mencakup webhook.

• disabled_reasonstring | null

  gone: penerima menjawab 410; manual: dinonaktifkan oleh administrator.

  Nilai yang diizinkan: gonemanualnull

• disabled_atstring (date-time) | null
• roleWebhookRolewajib
• data_profile_idinteger | null

  Profil data webhook (null berarti tanpa profil, seperti kunci API dengan peran yang sama).

• collection_idsarray of integerwajib

  Koleksi yang peristiwanya diterima webhook; kosong berarti semua koleksi yang tersedia bagi peran dan profil data.

• tagsarray of stringwajib

  Peristiwa kartu hanya untuk kartu dengan salah satu tag ini; kosong berarti tanpa filter.

• payloadWebhookPayloadModewajib
• headersarray of WebhookHeaderwajib
• auth_typestring | null

  Jenis otorisasi keluar (null berarti tidak ada).

  Nilai yang diizinkan: bearerbasicnull

• auth_setbooleanwajib

  Apakah otorisasi keluar ditetapkan (nilainya tidak pernah dikembalikan).

• previous_secret_valid_untilstring (date-time) | null

  Sampai kapan pengiriman juga ditandatangani dengan rahasia sebelumnya (null berarti tidak ada masa tumpang tindih).

• healthWebhookHealth
• consecutive_failuresintegerwajib
• 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)wajib
• updated_atstring (date-time)wajib

Digunakan oleh

• GET/v1/webhooks/{webhook_id}Dapatkan webhook
• PATCH/v1/webhooks/{webhook_id}Perbarui webhook
• POST/v1/webhooks/{webhook_id}/revoke-previous-secretCabut rahasia sebelumnya
• POST/v1/webhooks/{webhook_id}/resumeLanjutkan webhook

Bagian dari

WebhookCreatedWebhookEndpointList