Ferndesk

Webhooks

Webhook-Endpunkt aktualisieren

url, events, description oder enabled aktualisieren. Das Setzen von enabled: true aktiviert einen deaktivierten Endpunkt wieder und setzt seinen Fehlerstatus zurück. Erfordert den Scope webhooks:manage.

Erforderlicher Scope: webhooks:manage

PATCH /webhooks/{id}

Webhook-Endpunkt aktualisieren

curl --request PATCH \
  --url 'https://api.ferndesk.com/v1/webhooks/{ID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "id": "<string>",
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "enabled": true,
  "description": "<string>",
  "failureCount": 1,
  "lastSuccessAt": "<string>",
  "lastFailureAt": "<string>",
  "disabledAt": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Aktualisierter Endpunkt

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Authorization-Header. API-Schlüssel beginnen mit fdsk_ und sollten geheim gehalten werden. Sie können Schlüssel auf der Seite Developer settings erstellen und verwalten.

    Schlüssel können auf eine beliebige Teilmenge dieser Scopes beschränkt werden (jeder Endpunkt führt den erforderlichen Scope über x-required-scopes auf):

    • content:read: Hilfecenter-Artikel, Sammlungen, Abschnitte und Übersetzungen lesen und durchsuchen
    • content:write: Artikelentwürfe, Benutzer und Aufgaben erstellen und bearbeiten; Artikel und Sammlungen verschieben
    • content:publish: Inhalte veröffentlichen, Veröffentlichung aufheben, wiederherstellen und in den Papierkorb verschieben (Änderungen live schalten)
    • analytics:read: Hilfecenter-Berichte, Analysen und Artikel-Feedback lesen
    • conversations:read: Unterhaltungen und Transkripte des KI-Assistenten lesen
    • webhooks:manage: Ausgehende Webhook-Abonnements erstellen und verwalten

    Die Vergabe von content:write oder content:publish beinhaltet content:read. Vor der Einführung von Scopes erstellte Schlüssel haben null Scopes = vollständiger Zugriff (Legacy-Modus).

Path Parameters

  • id string erforderlich

    ID des Webhook-Endpunkts (whep_...). Beispiel: whep_01JXY9AZK4KV

Request Body

application/json
  • url string

    Aktualisierte Ziel-URL.

  • events[] string array

    Ereignistypen, für die dieser Endpunkt abonniert ist. Verwenden Sie exakte Typzeichenfolgen (z. B. article.published) oder den Platzhalter *, um jedes Ereignis zu empfangen.

  • description string | null

    Aktualisierte Bezeichnung.

  • enabled boolean

    Endpunkt aktivieren oder deaktivieren. Das Setzen von enabled: true setzt auch den Fehlerzähler zurück und hebt den Status der automatischen Deaktivierung auf.

Response

application/json
  • id string

    ID des Webhook-Endpunkts (whep_...).

  • url string

    HTTPS-URL, die per POST gesendete Webhook-Payloads empfängt.

  • events[] string array

    Abonnierte Ereignistypen (oder *).

  • enabled boolean

    Gibt an, ob der Endpunkt derzeit Zustellungen empfängt. Endpunkte werden nach anhaltenden Fehlern automatisch deaktiviert.

  • description string | null

    Optionale, für Menschen lesbare Bezeichnung.

  • failureCount integer

    Aufeinanderfolgende Zustellungsfehler. Wird bei jedem Erfolg oder bei erneuter Aktivierung auf 0 zurückgesetzt.

  • lastSuccessAt string | null
  • lastFailureAt string | null
  • disabledAt string | null

    Zeitpunkt, zu dem der Endpunkt automatisch deaktiviert wurde, sofern zutreffend.

  • createdAt string

    ISO-8601-Zeitstempel in UTC.

  • updatedAt string

    ISO-8601-Zeitstempel in UTC.