Passer au contenu principal
POST
Enregistrer une URL HTTPS qui reçoit les événements webhook. Ta clé API possède le webhook. Il ne reçoit un événement que pour les objets que ta clé peut lire. Une clé API peut posséder au maximum 5 webhooks.
Nécessite le scope webhooks_manage.

Requête

Paramètres du corps

string
requis
URL HTTPS sur le port 443 avec un hôte public et sans identifiants. Aniva ne suit pas les redirections.
string[]
requis
Types d’événements à recevoir, au moins un. ["*"] signifie tous les types. ping ne peut pas être inclus.
string[]
requis
1 à 5 adresses auxquelles Aniva envoie un e-mail lorsque les livraisons continuent d’échouer.
string
Texte libre pour ta propre référence, 500 caractères maximum.

Réponse

En cas de succès, l’API renvoie 201 Created avec le webhook et son secret.
string
requis
Le secret de signature, whsec_ suivi de base64. Aniva ne l’affiche que dans cette réponse. Voir Vérifier la signature.
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