Passer au contenu principal
POST
Créer un endpoint de webhook
Crée un endpoint pour l’équipe. Le secret de signature n’est renvoyé qu’une fois, dans cette réponse uniquement. Conservez-le pour vérifier les signatures. Une équipe peut avoir 10 endpoints au maximum. Les webhooks d’intégration nécessitent une offre Business, Agency Business ou Enterprise active. Modifier un endpoint exige aussi un jeton d’API dont l’accès en écriture a été activé par un Propriétaire ou un Manager. Consultez Webhooks d’intégration et Écrire des données.
string
requis
Jeton bearer de votre équipe.
string
requis
Clé unique pour cette opération, 255 caractères au maximum. Les réponses terminées sont rejouées pendant 24 heures.
string
requis
URL HTTPS publique, 2048 caractères au maximum. Les redirections ne sont pas suivies.
string[]
requis
Au moins un type d’événement : run.completed, run.failed, run.cancelled, pitch_audit.completed, pitch_audit.failed, site_audit.completed, prompt_suggestions.ready, prompt_suggestions.failed ou webhook.test.
string
Description libre, 200 caractères au maximum.
string[]
Limite l’endpoint à ces workspaces, 100 au maximum. Omettez-le ou envoyez un tableau vide pour recevoir les événements de tous les workspaces de l’équipe.
boolean
défaut:"true"
Indique si l’endpoint reçoit les événements immédiatement.

Réponse

Renvoie 201 avec Location, ETag et l’endpoint, plus le secret.
string
Secret de signature. Affiché une seule fois ; il ne peut plus être relu. Renouvelez-le avec Renouveler le secret de signature si vous le perdez.
Les autres champs sont décrits dans Lister les endpoints de webhook.

Requête et réponse synthétiques

Erreurs

Consultez Codes d’erreur pour les erreurs d’authentification, d’offre, d’idempotence et de serveur. Un jeton sans accès en écriture renvoie 403 API_KEY_READ_ONLY. Sur 429, respectez Retry-After. Si le limiteur d’écriture est indisponible ou si les écritures sont suspendues, la requête renvoie 503 SERVICE_UNAVAILABLE et rien ne change.