Ferndesk

Webhooks

Webhook-Endpunkt löschen

Löscht einen Endpunkt und dessen Zustellungsverlauf dauerhaft. Erfordert den Scope webhooks:manage.

Erforderlicher Scope: webhooks:manage

DELETE /webhooks/{id}

Webhook-Endpunkt löschen

curl --request DELETE \
  --url 'https://api.ferndesk.com/v1/webhooks/{ID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "<string>",
  "deleted": true
}

Gelöscht

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, die 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 implizit content:read. Vor der Einführung von Scopes ausgestellte Schlüssel haben null Scopes = Vollzugriff (Legacy-Modus).

Path Parameters

  • id string erforderlich

    Webhook-Endpunkt-ID (whep_...). Beispiel: whep_01JXY9AZK4KV

Response

application/json
  • id string
  • deleted boolean