Passer au contenu principal
PATCH
Modifie un webhook. Envoie uniquement les champs que tu veux modifier. Envoie status: "enabled" pour réactiver un webhook désactivé. Voir Avis d’échec.
Nécessite le scope webhooks_manage.

Requête

Paramètres de chemin

string
requis
Identifiant du webhook (UUID).

Paramètres du corps

string
Nouvelle URL HTTPS. Mêmes règles que pour Créer.
string[]
Nouvelle liste de types d’événements. Remplace l’ancienne liste.
string[]
Nouvelle liste de 1 à 5 adresses. Remplace l’ancienne liste.
string
Nouvelle description, 500 caractères maximum. null l’efface.
string
enabled ou disabled. La désactivation annule les livraisons en attente.

Réponse

En cas de succès, l’API renvoie 200 OK avec le webhook mis à jour.
string
requis
Identifiant du webhook (UUID).
string
requis
L’URL HTTPS vers laquelle Aniva envoie les événements.
string
Texte libre pour ta propre référence. Peut être null.
string[]
requis
Types d’événements que ce webhook reçoit. * signifie tous les types.
string[]
requis
Adresses auxquelles Aniva envoie un e-mail lorsque les livraisons continuent d’échouer.
string
requis
enabled ou disabled.
string
Instant ISO 8601 UTC de désactivation du webhook. null tant qu’il est activé.
string
Raison de la désactivation du webhook. Voir Avis d’échec. null tant qu’il est activé.
string
Instant ISO 8601 UTC de début de la série d’échecs actuelle. null lorsque la dernière livraison a réussi.
string
Instant ISO 8601 UTC auquel le secret précédent cesse de signer. null lorsqu’aucune rotation n’est en cours.
string
requis
Instant ISO 8601 UTC de création du webhook.
string
requis
Instant ISO 8601 UTC de la dernière modification.

Réponses d’erreur