Objektai
WebhookEndpoint
Laukai
idintegerprivalomasurlstringprivalomasdescriptionstringprivalomasactivebooleanprivalomaspaused_atstring (date-time) | nullpaused_reasonstring | nullfailures– 10 nesėkmingų bandymų iš eilės;feature_disabled– plane nėra webhook pranešimų.disabled_reasonstring | nullgone– gavėjas atsakė 410;manual– išjungė administratorius.Leidžiamos reikšmės:
gonemanualnulldisabled_atstring (date-time) | nulldata_profile_idinteger | nullWebhook galinio taško duomenų profilis (
nullreiškia, kad profilio nėra, kaip API raktui su tuo pačiu vaidmeniu).collection_idsarray of integerprivalomasRinkiniai, apie kuriuos webhook galinis taškas gauna įvykius; tuščias sąrašas reiškia visus vaidmeniui ir duomenų profiliui prieinamus rinkinius.
tagsarray of stringprivalomasKortelių įvykiai tik apie korteles, turinčias bent vieną iš šių žymų; tuščias sąrašas reiškia, kad filtro nėra.
auth_typestring | nullSiunčiamųjų užklausų autorizacijos tipas (
nullreiškia, kad jos nėra).Leidžiamos reikšmės:
bearerbasicnullauth_setbooleanprivalomasAr nustatyta siunčiamųjų užklausų autorizacija (reikšmės niekada negrąžinamos).
previous_secret_valid_untilstring (date-time) | nullIki kada pristatymai pasirašomi ir ankstesne paslaptimi (
nullreiškia, kad persidengimo nėra).healthWebhookHealthconsecutive_failuresintegerprivalomaslast_delivery_atstring (date-time) | nulllast_success_atstring (date-time) | nulllast_errorstring | nullcreated_byinteger | nullcreated_by_namestring | nullcreated_atstring (date-time)privalomasupdated_atstring (date-time)privalomas
Naudoja
- GET
/v1/webhooks/{webhook_id}Gauti webhook galinį tašką - PATCH
/v1/webhooks/{webhook_id}Atnaujinti webhook galinį tašką - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretAtšaukti ankstesnę paslaptį - POST
/v1/webhooks/{webhook_id}/resumeVėl įjungti webhook galinį tašką