Ferndesk

Webhooks

Mettre à jour un point de terminaison webhook

Mettre à jour url, events, description ou enabled. Définir enabled: true réactive un point de terminaison désactivé et réinitialise son état d’échec. Nécessite le scope webhooks:manage.

Scope requis : webhooks:manage

PATCH /webhooks/{id}

Mettre à jour un point de terminaison webhook

curl --request PATCH \
  --url 'https://api.ferndesk.com/v1/webhooks/{ID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "id": "<string>",
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "enabled": true,
  "description": "<string>",
  "failureCount": 1,
  "lastSuccessAt": "<string>",
  "lastFailureAt": "<string>",
  "disabledAt": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Point de terminaison mis à jour

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 Developer settings.

    Les clés peuvent être limitées à n’importe quel sous-ensemble de ces scopes (chaque endpoint indique le scope requis 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 visibles)
    • 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 scopes ont des scopes null = accès complet (mode hérité).

Path Parameters

  • id string requis

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

Request Body

application/json
  • url string

    URL de destination mise à jour.

  • events[] string array

    Types d’événements auxquels ce point de terminaison est abonné. Utiliser les chaînes de type exactes (par exemple article.published) ou le caractère générique * pour recevoir tous les événements.

  • description string | null

    Libellé mis à jour.

  • enabled boolean

    Activer ou désactiver le point de terminaison. Définir enabled: true réinitialise également le compteur d’échecs et efface l’état de désactivation automatique.

Response

application/json
  • id string

    ID du point de terminaison webhook (whep_...).

  • url string

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

  • events[] string array

    Types d’événements abonnés (ou *).

  • enabled boolean

    Indique si le point de terminaison reçoit actuellement des livraisons. Les points de terminaison sont automatiquement désactivés après des échecs persistants.

  • description string | null

    Libellé lisible par un humain, facultatif.

  • failureCount integer

    Nombre d’échecs de livraison consécutifs. Réinitialisé à 0 en cas de réussite ou de réactivation.

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

    Moment où le point de terminaison a été automatiquement désactivé, le cas échéant.

  • createdAt string

    Horodatage ISO 8601 en UTC.

  • updatedAt string

    Horodatage ISO 8601 en UTC.