webhook.endpoint.create
Markdownv0.3.0
Déclarer un point de réception des webhooks d'un projet. Son secret n'est rendu qu'une fois.
- API
POST /v1/projects/{projectId}/webhooks - CLI
bastide webhook endpoint create
EX-CTL-120. Chaque événement du catalogue publié (generated/evenements.json) part signé en HMAC-SHA256 vers l'URL, réessayé huit fois sur 24 h, puis mis au rebut et rejouable. L'URL est en https, sans identité ; une adresse interne est refusée, à la déclaration et à chaque envoi.
| Propriété | Valeur |
|---|---|
| Niveau | project |
| Rang minimal | admin |
| Rôle transversal | — |
| Portées | project:write |
| Compte de service | ne la mène pas : elle est réservée à une personne |
| Réversibilité | R — réversible : exécution directe, tracée, annulable |
| Idempotence | une clé d'idempotence est acceptée : le rejeu rend la première réponse |
| Limites de débit, par jeton | 600 appels par 60 secondes (general), et 60 appels par 60 secondes (sensitive) |
API
POST /v1/projects/{projectId}/webhooks — succès en 201.
| Paramètre | Où | Type | Requis | Description |
|---|---|---|---|---|
projectId | chemin | texte, motif ^prj_[0-9A-HJKMNP-TV-Z]{26}$ | oui | Identifiant de projet |
Idempotency-Key | en-tête | texte, de 8 à 128 caractères | non | Clé d'idempotence. Un rejeu portant la même clé retourne le résultat initial sans nouvel effet de bord, et la réponse porte alors « Idempotency-Replayed: true ». Équivaut au champ « idempotencyKey » du corps ; les deux à la fois ne sont acceptés que s'ils sont identiques. |
url | corps | texte, de 8 à 2048 caractères | oui | L'URL https qui reçoit les événements. |
types | corps | liste de 34 éléments au plus — chaque élément : l'un de deployment.created, deployment.built, deployment.ready, deployment.failed, deployment.canceled, deployment.promoted, deployment.restored, deployment.deleted, project.created, project.renamed, project.deleted, domain.added, domain.verified, domain.misconfigured, domain.deleted, domain.certificate.issued, domain.certificate.renewed, domain.certificate.failed, variable.created, variable.updated, variable.deleted, database.branch.created, database.branch.destroyed, database.backup.succeeded, database.backup.failed, database.cron.failed, database.schema.drifted, spend.threshold.reached, spend.cap.reached, project.egress.threshold, project.images.threshold, project.anomaly.detected, team.member.added, team.member.removed | non | Les types reçus ; vide, tous. |
idempotencyKey | corps | texte, de 8 à 128 caractères | non | Clé d'idempotence, obligatoire. Un rejeu portant la même clé rend le résultat initial, sans nouvel effet de bord. |
La réponse :
| Champ | Type | Description |
|---|---|---|
endpointId | texte, motif ^whk_[0-9A-HJKMNP-TV-Z]{26}$ | L'identifiant d'un point de réception (« whk_ »). |
projectId | texte, motif ^prj_[0-9A-HJKMNP-TV-Z]{26}$ | Identifiant de projet |
url | objet (untrusted, source, content) | |
types | liste — chaque élément : l'un de deployment.created, deployment.built, deployment.ready, deployment.failed, deployment.canceled, deployment.promoted, deployment.restored, deployment.deleted, project.created, project.renamed, project.deleted, domain.added, domain.verified, domain.misconfigured, domain.deleted, domain.certificate.issued, domain.certificate.renewed, domain.certificate.failed, variable.created, variable.updated, variable.deleted, database.branch.created, database.branch.destroyed, database.backup.succeeded, database.backup.failed, database.cron.failed, database.schema.drifted, spend.threshold.reached, spend.cap.reached, project.egress.threshold, project.images.threshold, project.anomaly.detected, team.member.added, team.member.removed | Vide : tous les types du catalogue. |
createdAt | texte, format date-time | |
secret | texte | Le secret de signature, préfixé « whsec_ ». Rendu une seule fois, jamais relu. |
undoToken | nul |
En-têtes de la réponse : RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset, RateLimit-Policy, Idempotency-Replayed.
Autres réponses : 400, 401, 403, 404, 409, 429, 500, 503 — communes à toute opération.
Ligne de commande
bastide webhook endpoint create --project-id <valeur> --url <valeur>
| Option | Type | Requise | Défaut | Description |
|---|---|---|---|---|
--project-id | texte | oui | — | Identifiant de projet |
--url | texte | oui | — | L'URL https qui reçoit les événements. |
--types | liste | non | [] | Les types reçus ; vide, tous. |
--idempotency-key | texte | non | — | Clé d'idempotence, obligatoire. Un rejeu portant la même clé rend le résultat initial, sans nouvel effet de bord. |
La commande s'exécute sans confirmation.
MCP
Aucun outil : elle rend la valeur d'un secret, une seule fois, ou la refuse à tous : aucun outil MCP ne renvoie la valeur d'un secret, quelle que soit la portée du jeton (EX-MCP-070, EX-SEC-270).
Erreurs
| Code | Surface | Cause |
|---|---|---|
destination_refusee | les deux | L'URL de réception est refusée : un schéma autre que https, une identité dans l'URL, ou une adresse interne. |
quota_de_points_atteint | les deux | L'organisation a atteint le plafond publié de points de réception. |
idempotency_key_conflict | API | Deux clés d'idempotence différentes ont été présentées, dans le corps et dans l'en-tête. |
secret_store_unavailable | les deux | Le magasin de secrets est injoignable. |
valeur_rendue_une_fois | API | Ce que l'opération crée n'est rendu qu'au premier appel : la plateforme n'en garde pas de copie, et un rejeu ne peut pas le rendre. |
S'y ajoutent les refus communs à toute opération — entrée invalide, authentification, autorisation, cible introuvable, conflit, limite de débit, indisponibilité — que le catalogue des erreurs décrit.
Exemples
Recevoir les déploiements d'un projet sur son intégration :
{
"projectId": "prj_01JQ8ZK4M7NP2RSTVWXYZ34567",
"url": "https://crochets.example.fr/bastide",
"types": [
"deployment.ready",
"deployment.failed"
],
"idempotencyKey": "point-de-reception-2026-09-30"
}