Ferndesk

Webhooks

Obtenir une livraison

Renvoie un seul enregistrement de livraison pour un endpoint, notamment son état, son code de réponse, le nombre de tentatives et le calendrier des nouvelles tentatives. Nécessite la portée webhooks:manage.

Portée requise : webhooks:manage

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

Obtenir une livraison

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

Enregistrement de livraison

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 du 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 des brouillons d’articles, des utilisateurs et des tâches ; déplacer des articles et des collections
    • content:publish : publier, dépublier, restaurer et supprimer définitivement du contenu (rendre les modifications accessibles)
    • analytics:read : consulter les rapports, analyses et retours sur les articles du centre d’aide
    • conversations:read : consulter les conversations et transcriptions de l’assistant IA
    • webhooks:manage : créer et gérer les abonnements aux webhooks sortants

    L’attribution de 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 null = accès complet (mode legacy).

Path Parameters

  • deliveryId string requis

    ID de livraison (whdl_...). Exemple: whdl_01JXY9AZK4KV

  • id string requis

    ID de l’endpoint webhook (whep_...). Exemple: whep_01JXY9AZK4KV

Response

application/json
  • id string

    ID de livraison (whdl_...).

  • eventType string

    Type d’événement livré.

  • status string enum enum

    État du cycle de vie de la livraison. Allowed values: pending, success, failed.

  • responseStatus integer | null

    Code d’état HTTP renvoyé par l’endpoint, ou null avant la première tentative ou en cas d’erreur réseau.

  • attempts integer

    Nombre de tentatives de livraison effectuées jusqu’à présent.

  • error string | null

    Dernier message d’erreur, si la tentative la plus récente a échoué.

  • createdAt string

    Horodatage ISO 8601 en UTC.

  • deliveredAt string | null

    Moment où la livraison a réussi pour la première fois, le cas échéant.

  • nextRetryAt string | null

    Moment où la prochaine tentative est planifiée, pour les livraisons échouées en attente.