Ferndesk

Webhooks

Webhook-Endpunkte auflisten

Gibt alle Webhook-Endpunkte für Ihre Organisation zurück, beginnend mit dem neuesten. Erfordert den webhooks:manage-Scope.

Erforderlicher Scope: webhooks:manage

GET /webhooks

Webhook-Endpunkte auflisten

curl --request GET \
  --url 'https://api.ferndesk.com/v1/webhooks' \
  --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>"
  }
]

Webhook-Endpunkte

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 Entwicklereinstellungen erstellen und verwalten.

    Schlüssel können auf eine beliebige Teilmenge dieser Scopes beschränkt werden (jeder Endpunkt führt den über x-required-scopes erforderlichen Scope 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).

Response

application/json
  • items[] object array item

    Payload eines Webhook-Endpunkts (enthält niemals das Signaturgeheimnis).

    + Show Child Attributes
    • id string

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

    • url string

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

      Optionales, für Menschen lesbares Label.

    • 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 gegebenenfalls automatisch deaktiviert wurde.

    • createdAt string

      ISO-8601-Zeitstempel in UTC.

    • updatedAt string

      ISO-8601-Zeitstempel in UTC.