Webhook-Endpunkt erstellen

Registriert einen HTTPS-Endpunkt zum Empfangen von Ereigniszustellungen. Das Signaturgeheimnis wird hier einmalig und danach nicht mehr zurückgegeben.

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"
}

Erstellter Endpunkt einschließlich seines Signaturgeheimnisses

Body

erforderlich application/json

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

Ziel-URL; http:// wird nur für localhost akzeptiert.

events array of string · min items: 1 erforderlich

Ereignistypen, die abonniert werden sollen, oder * für jedes Ereignis.

description string | null

Im Dashboard angezeigte Bezeichnung.

Body

Antworten