Créer un point de terminaison webhook

Enregistre un point de terminaison HTTPS pour recevoir les livraisons d’événements. Le secret de signature est renvoyé ici une seule fois et jamais plus.

POST /v1/webhooks

Jeton Bearer portée webhooks:manage

curl 'https://api.ferndesk.com/v1/webhooks' \
  --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://example.com/hooks/ferndesk",
  "events": [
    "article.published",
    "article.updated"
  ],
  "description": "Prod sync worker"
}'

{
  "id": "whep_01JXY9AZK4KV",
  "url": "https://example.com/hooks/ferndesk",
  "events": [
    "article.published"
  ],
  "enabled": true,
  "description": "Prod sync worker",
  "failureCount": 0,
  "lastSuccessAt": "2026-01-01T12:00:00Z",
  "lastFailureAt": "2026-01-01T12:00:00Z",
  "disabledAt": "2026-01-15T18:25:43.511Z",
  "createdAt": "2026-01-15T18:25:43.511Z",
  "updatedAt": "2026-01-15T18:25:43.511Z",
  "secret": "whsec_Zm9vYmFyYmF6cXV4"
}

Point de terminaison créé, y compris son secret de signature

Corps

requis application/json

url string · min length: 1· max length: 2048 requis

URL de destination ; http:// est accepté uniquement pour localhost.

events array of string · min items: 1 requis

Types d’événements auxquels s’abonner, ou * pour tous les événements.

description string | null

Libellé affiché dans le tableau de bord.

Corps

Réponses