Objekti
WebhookEndpoint
Lauki
idintegerobligātsurlstringobligātsdescriptionstringobligātsactivebooleanobligātspaused_atstring (date-time) | nullpaused_reasonstring | nullfailures: 10 neveiksmīgi mēģinājumi pēc kārtas;feature_disabled: plāns neietver webhook paziņojumus.disabled_reasonstring | nullgone: saņēmējs atbildēja ar 410;manual: atspējojis administrators.Atļautās vērtības:
gonemanualnulldisabled_atstring (date-time) | nulldata_profile_idinteger | nullWebhook galapunkta datu profils (
nullnozīmē, ka profila nav, kā API atslēgai ar to pašu lomu).collection_idsarray of integerobligātsKolekcijas, par kurām webhook galapunkts saņem notikumus; tukšs saraksts nozīmē visas lomai un datu profilam pieejamās kolekcijas.
tagsarray of stringobligātsKartīšu notikumi tikai par kartītēm ar kādu no šīm birkām; tukšs saraksts nozīmē, ka filtra nav.
auth_typestring | nullIzejošās autorizācijas tips (
nullnozīmē, ka tās nav).Atļautās vērtības:
bearerbasicnullauth_setbooleanobligātsVai izejošā autorizācija ir iestatīta (vērtības nekad netiek atgrieztas).
previous_secret_valid_untilstring (date-time) | nullLīdz kuram laikam piegādes tiek parakstītas arī ar iepriekšējo noslēpumu (
nullnozīmē, ka pārklāšanās nav).healthWebhookHealthconsecutive_failuresintegerobligātslast_delivery_atstring (date-time) | nulllast_success_atstring (date-time) | nulllast_errorstring | nullcreated_byinteger | nullcreated_by_namestring | nullcreated_atstring (date-time)obligātsupdated_atstring (date-time)obligāts
Izmanto
- GET
/v1/webhooks/{webhook_id}Iegūt webhook galapunktu - PATCH
/v1/webhooks/{webhook_id}Atjaunināt webhook galapunktu - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretAtsaukt iepriekšējo noslēpumu - POST
/v1/webhooks/{webhook_id}/resumeAtsākt webhook galapunkta darbību