Objets

WebhookEndpoint

Champs

idintegerobligatoire
urlstringobligatoire
descriptionstringobligatoire
eventsarray of WebhookEventFilterobligatoire
activebooleanobligatoire
statusWebhookStatusobligatoire
paused_atstring (date-time) | null
paused_reasonstring | null
failures : 10 tentatives échouées d’affilée ; feature_disabled : l’offre n’inclut pas les webhooks.
disabled_reasonstring | null
gone : le récepteur a répondu 410 ; manual : désactivé par un administrateur.
Valeurs autorisées: gonemanualnull
disabled_atstring (date-time) | null
roleWebhookRoleobligatoire
data_profile_idinteger | null
Profil de données du webhook (null signifie aucun profil, comme pour une clé API ayant le même rôle).
collection_idsarray of integerobligatoire
Collections dont le webhook reçoit les événements ; vide signifie toutes les collections accessibles au rôle et au profil de données.
tagsarray of stringobligatoire
Événements de fiches uniquement pour les fiches portant l’une de ces étiquettes ; vide signifie aucun filtre.
payloadWebhookPayloadModeobligatoire
headersarray of WebhookHeaderobligatoire
auth_typestring | null
Type d’autorisation sortante (null signifie aucune).
Valeurs autorisées: bearerbasicnull
auth_setbooleanobligatoire
Indique si une autorisation sortante est définie (les valeurs ne sont jamais renvoyées).
previous_secret_valid_untilstring (date-time) | null
Date jusqu’à laquelle les livraisons sont aussi signées avec l’ancien secret (null signifie qu’il n’y a pas de chevauchement).
healthWebhookHealth
consecutive_failuresintegerobligatoire
last_delivery_atstring (date-time) | null
last_success_atstring (date-time) | null
last_errorstring | null
created_byinteger | null
created_by_namestring | null
created_atstring (date-time)obligatoire
updated_atstring (date-time)obligatoire

Utilisé par

Fait partie de

WebhookCreated WebhookEndpointList