Objectes
WebhookEndpoint
Camps
idintegerobligatoriurlstringobligatoridescriptionstringobligatoriactivebooleanobligatoripaused_atstring (date-time) | nullpaused_reasonstring | nullfailures: 10 intents fallits seguits;feature_disabled: el pla no inclou webhooks.disabled_reasonstring | nullgone: el receptor ha respost 410;manual: desactivat per un administrador.Valors permesos:
gonemanualnulldisabled_atstring (date-time) | nulldata_profile_idinteger | nullPerfil de dades del webhook (
nullvol dir sense perfil, com en una clau d’API amb el mateix rol).collection_idsarray of integerobligatoriCol·leccions sobre les quals el webhook rep esdeveniments; buit vol dir totes les col·leccions disponibles per al rol i el perfil de dades.
tagsarray of stringobligatoriEsdeveniments d’entrades només per a les entrades amb alguna d’aquestes etiquetes; buit vol dir sense filtre.
auth_typestring | nullTipus d’autorització de sortida (
nullvol dir cap).Valors permesos:
bearerbasicnullauth_setbooleanobligatoriIndica si l’autorització de sortida està definida (els valors no es retornen mai).
previous_secret_valid_untilstring (date-time) | nullFins quan els lliuraments també se signen amb el secret anterior (
nullvol dir que no hi ha solapament).healthWebhookHealthconsecutive_failuresintegerobligatorilast_delivery_atstring (date-time) | nulllast_success_atstring (date-time) | nulllast_errorstring | nullcreated_byinteger | nullcreated_by_namestring | nullcreated_atstring (date-time)obligatoriupdated_atstring (date-time)obligatori
S’usa a
- GET
/v1/webhooks/{webhook_id}Obtenir un webhook - PATCH
/v1/webhooks/{webhook_id}Actualitzar un webhook - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretRevocar el secret anterior - POST
/v1/webhooks/{webhook_id}/resumeReprendre un webhook