Ferndesk

Webhooks

Eine Testzustellung senden

Stellt ein webhook.test-Ereignis über die echte Zustellungspipeline in die Warteschlange (mit identischer Signatur wie bei Produktionsevents). Die Zustellung erfolgt asynchron: Rufen Sie GET /webhooks/{id}/deliveries/{delivery_id} ab, um das Ergebnis zu erhalten. Erfordert den Scope webhooks:manage.

Erforderlicher Scope: webhooks:manage

POST /webhooks/{id}/test

Eine Testzustellung senden

curl --request POST \
  --url 'https://api.ferndesk.com/v1/webhooks/{ID}/test' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "delivery_id": "<string>"
}

Testzustellung in die Warteschlange eingereiht

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Authorization-Header. API-Schlüssel haben das Präfix 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 listet 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: Berichte, Analysen und Artikel-Feedback des Hilfecenters 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 ausgestellte Schlüssel haben null Scopes = vollständiger Zugriff (Legacy-Modus).

Path Parameters

  • id string erforderlich

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

Response

application/json
  • delivery_id string

    ID der in die Warteschlange eingereihten Testzustellung. Rufen Sie GET /webhooks/{id}/deliveries/{delivery_id} ab, um das Ergebnis zu erhalten.