Référence APIMettre à jour un webhook
PATCH/v1/webhooks/{id}

Mettre à jour un webhook

Modifie l'URL, les événements souscrits, l'état actif ou la politique de retry.

1 min de lectureTélécharger en PDF

Requête exemple

{
"events": [
"transfer.created"
],
"is_active": true,
"retry_policy": {
"max_attempts": 5,
"disable_after_consecutive_failures": 10
}
}

Réponse exemple

{
"id": "wh_abc123",
"url": "https://example.com/webhooks/coffrify",
"name": "Prod listener",
"events": [
"transfer.created"
],
"is_active": true,
"retry_policy": {
"max_attempts": 5,
"disable_after_consecutive_failures": 10
}
}

Met à jour les champs fournis d'un webhook. Au moins un champ est requis.

Authentification

Requiert une clé API avec le scope webhooks:manage.

Corps de la requête

ChampTypeDescription
namestringNouveau nom.
urlstringNouvelle URL HTTPS.
eventsarrayListe d'événements (au moins un).
is_activebooleanActive ou désactive le webhook.
retry_policyobjectmax_attempts (1 à 10) et disable_after_consecutive_failures (1 à 10000).