Ferndesk

Webhooks

Envoyer une livraison de test

Met en file d’attente un événement webhook.test via le pipeline de livraison réel (signé à l’identique des événements de production). La livraison est asynchrone : interrogez GET /webhooks/{id}/deliveries/{delivery_id} pour obtenir le résultat. Nécessite la portée webhooks:manage.

Portée requise : webhooks:manage

POST /webhooks/{id}/test

Envoyer une livraison de test

curl --request POST \
  --url 'https://api.ferndesk.com/v1/webhooks/{ID}/test' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "delivery_id": "<string>"
}

Livraison de test mise en file d’attente

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 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 effectives)
    • 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

    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 nulles = accès complet (mode legacy).

Path Parameters

  • id string requis

    ID du point de terminaison Webhook (whep_...). Exemple: whep_01JXY9AZK4KV

Response

application/json
  • delivery_id string

    ID de la livraison de test mise en file d’attente. Interrogez GET /webhooks/{id}/deliveries/{delivery_id} pour obtenir le résultat.