Webhook-Endpunkt aktualisieren

Aktualisiert einen Webhook-Endpunkt. Das erneute Aktivieren eines deaktivierten Endpunkts setzt auch den Fehlerzähler zurück.

PATCH /v1/webhooks/{id}

Bearer-Token Scope webhooks:manage

curl 'https://api.ferndesk.com/v1/webhooks/whep_01JXY9AZK4KV' \
  --request PATCH \
  --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",
  "enabled": true
}'

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

Aktualisierter Endpunkt

Pfadparameter

· 1

id string erforderlich

Bezeichner des Webhook-Endpunkts.

Body

erforderlich application/json

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

Neue Ziel-URL.

events array of string · min items: 1

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

description string | null

Neues Label.

enabled boolean

Das erneute Aktivieren löscht auch den Fehlerzähler und den Status der automatischen Deaktivierung.

Pfadparameter

Body

Antworten