Create a webhook endpoint

Registers an HTTPS endpoint to receive event deliveries. The signing secret is returned here once and never again.

POST /v1/webhooks

Bearer token scope 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"
}

Created endpoint, including its signing secret

Body

required application/json

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

Destination URL; http:// is accepted only for localhost.

events array of string · min items: 1 required

Event types to subscribe to, or * for every event.

description string | null

Label shown in the dashboard.

Body

Responses