Webhooks
Les webhooks permettent à une plateforme cliente de renvoyer un événement de déverrouillage dans l’historique d’un conteneur. Comme retarget, cet appel n’existe que dans l’API 2.1 — la v3 n’a pas d’équivalent, et c’est la seconde des deux raisons pour lesquelles une intégration reste sur la 2.1 plutôt que de passer à la v3.
API 2.1
URL de base
{API_BASE}/v2.1 — the base URL is provided with your access
Spécification OpenAPI
Webhooks
Méthode POST
/v2.1/client/{key}/{crid}/webhook/{webhookId}
Scope
client_v2
Envoyer un événement de déverrouillage pour un conteneur. messageUnlockEvent est le seul webhookId accepté.
Paramètres
| Nom | Emplacement | Type | Requis | Description |
|---|---|---|---|---|
key |
Chemin | string |
Requis | Votre clé d’API client 2.1. |
crid |
Chemin | string |
Requis | Le crid du conteneur. |
webhookId |
Chemin | string |
Requis | Le webhook appelé. messageUnlockEvent est la seule valeur acceptée par l’énumération — il n’existe aucun autre webhook au catalogue. |
Réponse
json
200 OK
{
"status": 1,
"error": "processed"
}Remarques
- Cette réponse de succès porte status: 1 et un champ error valant "processed" — partout ailleurs en 2.1, status: 1 signale un appel en échec. Pour cette opération, ne vous fiez pas au seul status ; vérifiez la valeur de error, sinon vous écrirez un test d’intégration qui prend ce succès pour un échec.
- Un webhookId inconnu renvoie le code d’erreur webhook_not_found.