Ferndesk

Webhooks

Lister les endpoints webhook

Renvoie tous les endpoints webhook de votre organisation, du plus récent au plus ancien. Nécessite la portée webhooks:manage.

Portée requise : webhooks:manage

GET /webhooks

Lister les endpoints webhook

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>"
  }
]

Endpoints webhook

Authorizations

  • Authorization string requis header

    Toutes les requêtes nécessitent un jeton Bearer dans l’en-tête Authorization. Les clés API sont préfixées par fdsk_ et doivent rester secrètes. Vous pouvez générer et gérer les clés depuis la page Paramètres développeur.

    Les clés peuvent être limitées à n’importe quel sous-ensemble de ces portées (chaque endpoint indique la portée requise via x-required-scopes) :

    • content:read : Lire et rechercher les articles, collections, sections et traductions du centre d’aide
    • content:write : Créer et modifier les brouillons d’articles, les utilisateurs et les tâches ; déplacer des articles et des collections
    • content:publish : Publier, dépublier, restaurer et mettre à la corbeille du contenu (rendre les modifications accessibles)
    • analytics:read : Lire les rapports, analyses et retours sur les articles du centre d’aide
    • conversations:read : Lire les conversations et transcriptions de l’assistant IA
    • webhooks:manage : Créer et gérer les abonnements aux webhooks sortants

    Accorder content:write ou content:publish implique content:read. Les clés créées avant la mise en place des portées ont des portées nulles = accès complet (mode hérité).

Response

application/json
  • items[] object array item

    Charge utile de l’endpoint webhook (n’inclut jamais le secret de signature).

    + Show Child Attributes
    • id string

      ID de l’endpoint webhook (whep_...).

    • url string

      URL HTTPS qui reçoit les charges utiles webhook envoyées via POST.

    • events[] string array

      Types d’événements auxquels l’abonnement est souscrit (ou *).

    • enabled boolean

      Indique si l’endpoint reçoit actuellement des livraisons. Les endpoints sont automatiquement désactivés après des échecs prolongés.

    • description string | null

      Libellé lisible facultatif.

    • failureCount integer

      Nombre consécutif d’échecs de livraison. Réinitialisé à 0 après toute réussite ou lors de la réactivation.

    • lastSuccessAt string | null
    • lastFailureAt string | null
    • disabledAt string | null

      Date et heure auxquelles l’endpoint a été automatiquement désactivé, le cas échéant.

    • createdAt string

      Horodatage ISO 8601 en UTC.

    • updatedAt string

      Horodatage ISO 8601 en UTC.