Objetos
WebhookEndpoint
Campos
idintegerobligatoriourlstringobligatoriodescriptionstringobligatorioactivebooleanobligatoriopaused_atstring (date-time) | nullpaused_reasonstring | nullfailures: 10 intentos fallidos seguidos;feature_disabled: el plan no incluye webhooks.disabled_reasonstring | nullgone: el receptor respondió 410;manual: lo desactivó un administrador.Valores permitidos:
gonemanualnulldisabled_atstring (date-time) | nulldata_profile_idinteger | nullPerfil de datos del webhook (
nullsignifica sin perfil, como en una clave de API con el mismo rol).collection_idsarray of integerobligatorioColecciones sobre las que el webhook recibe eventos; vacío significa todas las colecciones disponibles para el rol y el perfil de datos.
tagsarray of stringobligatorioEventos de tarjetas solo para las tarjetas con alguna de estas etiquetas; vacío significa sin filtro.
auth_typestring | nullTipo de la autorización saliente (
nullsignifica ninguna).Valores permitidos:
bearerbasicnullauth_setbooleanobligatorioIndica si la autorización saliente está configurada (los valores nunca se devuelven).
previous_secret_valid_untilstring (date-time) | nullHasta cuándo las entregas se firman también con el secreto anterior (
nullsignifica que no hay solapamiento).healthWebhookHealthconsecutive_failuresintegerobligatoriolast_delivery_atstring (date-time) | nulllast_success_atstring (date-time) | nulllast_errorstring | nullcreated_byinteger | nullcreated_by_namestring | nullcreated_atstring (date-time)obligatorioupdated_atstring (date-time)obligatorio
Se usa en
- GET
/v1/webhooks/{webhook_id}Obtener un webhook - PATCH
/v1/webhooks/{webhook_id}Actualizar un webhook - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretRevocar el secreto anterior - POST
/v1/webhooks/{webhook_id}/resumeReanudar un webhook