Ferndesk

Webhooks

Webhook-Endpunkt abrufen

Gibt einen einzelnen Endpunkt sowie seine 20 neuesten Zustellungen zurück. Erfordert den Scope webhooks:manage.

Erforderlicher Scope: webhooks:manage

GET /webhooks/{id}

Webhook-Endpunkt abrufen

curl --request GET \
  --url 'https://api.ferndesk.com/v1/webhooks/{ID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "<string>",
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "enabled": true,
  "description": "<string>",
  "failureCount": 1,
  "lastSuccessAt": "<string>",
  "lastFailureAt": "<string>",
  "disabledAt": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "deliveries": [
    {
      "id": "<string>",
      "eventType": "<string>",
      "status": "pending",
      "responseStatus": 1,
      "attempts": 1,
      "error": "<string>",
      "createdAt": "<string>",
      "deliveredAt": "<string>",
      "nextRetryAt": "<string>"
    }
  ]
}

Endpunkt mit neuesten Zustellungen

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Authorization-Header. API-Schlüssel tragen 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 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, 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 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
  • id string

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

  • url string

    HTTPS-URL, die POSTed-Webhook-Nutzdaten 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

    Optionales, für Menschen lesbares Label.

  • failureCount integer

    Aufeinanderfolgende fehlgeschlagene Zustellungen. 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.

  • deliveries[] object array

    Bis zu 20 neuesten Zustellungen für diesen Endpunkt, neueste zuerst. Datensatz für einen einzelnen Zustellversuch eines Webhooks.

    + Show Child Attributes
    • id string

      Zustellungs-ID (whdl_...).

    • eventType string

      Zugestellter Ereignistyp.

    • status string enum enum

      Status im Lebenszyklus der Zustellung. Allowed values: pending, success, failed.

    • responseStatus integer | null

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

    • attempts integer

      Bisher durchgeführte Zustellversuche.

    • error string | null

      Letzte Fehlermeldung, sofern 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 geschehen ist.

    • nextRetryAt string | null

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