Ferndesk

Webhooks

Eine Zustellung abrufen

Gibt einen einzelnen Zustellungsdatensatz für einen Endpoint zurück, einschließlich Status, Antwortcode, Versuchen und Wiederholungsplan. Erfordert den Scope webhooks:manage.

Erforderlicher Scope: webhooks:manage

GET /webhooks/{id}/deliveries/{deliveryId}

Eine Zustellung abrufen

curl --request GET \
  --url 'https://api.ferndesk.com/v1/webhooks/{ID}/deliveries/{DELIVERYID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "<string>",
  "eventType": "<string>",
  "status": "pending",
  "responseStatus": 1,
  "attempts": 1,
  "error": "<string>",
  "createdAt": "<string>",
  "deliveredAt": "<string>",
  "nextRetryAt": "<string>"
}

Zustellungsdatensatz

Authorizations

  • Authorization string erforderlich header

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

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

    • 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, deren 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 schließt content:read ein. Vor der Einführung von Scopes ausgestellte Schlüssel haben null Scopes = vollständiger Zugriff (Legacy-Modus).

Path Parameters

  • deliveryId string erforderlich

    Zustellungs-ID (whdl_...). Beispiel: whdl_01JXY9AZK4KV

  • id string erforderlich

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

Response

application/json
  • id string

    Zustellungs-ID (whdl_...).

  • eventType string

    Zugestellter Ereignistyp.

  • status string enum enum

    Lebenszyklusstatus der Zustellung. Allowed values: pending, success, failed.

  • responseStatus integer | null

    Vom Endpoint zurückgegebener HTTP-Status oder null vor dem ersten Versuch bzw. bei einem Netzwerkfehler.

  • attempts integer

    Bisher durchgeführte Zustellungsversuche.

  • error string | null

    Letzte Fehlermeldung, falls der letzte Versuch fehlgeschlagen ist.

  • createdAt string

    ISO-8601-Zeitstempel in UTC.

  • deliveredAt string | null

    Zeitpunkt, zu dem die Zustellung erstmals erfolgreich war, sofern dies der Fall ist.

  • nextRetryAt string | null

    Zeitpunkt, zu dem die nächste Wiederholung für fehlgeschlagene, ausstehende Zustellungen geplant ist.