Nesneler
WebhookEndpoint
Alanlar
idintegerzorunluurlstringzorunludescriptionstringzorunluactivebooleanzorunlupaused_atstring (date-time) | nullpaused_reasonstring | nullfailures: art arda 10 başarısız deneme;feature_disabled: plan webhook’ları içermiyor.disabled_reasonstring | nullgone: alıcı 410 ile yanıt verdi;manual: bir yönetici tarafından devre dışı bırakıldı.Geçerli değerler:
gonemanualnulldisabled_atstring (date-time) | nulldata_profile_idinteger | nullWebhook’un veri profili (
null, aynı role sahip bir API anahtarındaki gibi profil olmadığı anlamına gelir).collection_idsarray of integerzorunluWebhook’un hakkında olay aldığı koleksiyonlar; boş liste, rolün ve veri profilinin erişebildiği tüm koleksiyonlar anlamına gelir.
tagsarray of stringzorunluKart olayları yalnızca bu etiketlerden herhangi birine sahip kartlar için; boş liste, filtre olmadığı anlamına gelir.
auth_typestring | nullGiden yetkilendirmenin türü (
null, yetkilendirme olmadığı anlamına gelir).Geçerli değerler:
bearerbasicnullauth_setbooleanzorunluGiden yetkilendirmenin ayarlanıp ayarlanmadığı (değerler hiçbir zaman döndürülmez).
previous_secret_valid_untilstring (date-time) | nullTeslimlerin ne zamana kadar önceki gizli değerle de imzalanacağı (
null, örtüşme süresi olmadığı anlamına gelir).healthWebhookHealthconsecutive_failuresintegerzorunlulast_delivery_atstring (date-time) | nulllast_success_atstring (date-time) | nulllast_errorstring | nullcreated_byinteger | nullcreated_by_namestring | nullcreated_atstring (date-time)zorunluupdated_atstring (date-time)zorunlu
Kullanıldığı yerler
- GET
/v1/webhooks/{webhook_id}Webhook’u getirme - PATCH
/v1/webhooks/{webhook_id}Webhook’u güncelleme - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretÖnceki gizli değeri iptal etme - POST
/v1/webhooks/{webhook_id}/resumeWebhook’u yeniden etkinleştirme