Ferndesk

Feedback

Créer un feedback sur un article

Enregistre le feedback du lecteur (positif/négatif + texte libre) sur un article. Si email correspond à un utilisateur connu du centre d’aide, le feedback est automatiquement associé à cet utilisateur. Nécessite la portée content:write. Limité à 300 requêtes par heure et par clé.

Portée requise : content:write

POST /feedback

Créer un feedback sur un article

curl --request POST \
  --url 'https://api.ferndesk.com/v1/feedback' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "id": "<string>",
  "articleId": "<string>",
  "articleTitle": "<string>",
  "type": "positive",
  "feedback": "<string>",
  "email": "<string>",
  "resolved": true,
  "createdAt": "<string>",
  "user": {
    "id": "<string>",
    "name": "<string>",
    "email": "<email>"
  }
}

Feedback créé

Authorizations

  • Authorization string requis header

    Toutes les requêtes nécessitent un token 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 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 mettre le contenu à la corbeille (rendre les modifications visibles)
    • analytics:read : Lire les rapports, les analytics et les feedbacks 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é).

Request Body

application/json
  • article_id string requis

    ID d’article Ferndesk (art_...).

  • type string enum requis enum

    Indique si le lecteur a trouvé l’article utile. Allowed values: positive, negative.

  • feedback string requis

    Feedback en texte libre du lecteur, de 5000 caractères maximum. À traiter comme du contenu utilisateur final non fiable.

  • email string (email)

    Adresse e-mail facultative de l’expéditeur (supprimée des espaces superflus et convertie en minuscules). Lorsqu’elle correspond à un utilisateur connu du centre d’aide (par e-mail + helpdesk), le feedback est automatiquement associé à cet utilisateur.

Response

application/json
  • id string
  • articleId string | null
  • articleTitle string | null
  • type string enum enum

    Allowed values: positive, negative.

  • feedback string
  • email string | null
  • resolved boolean
  • createdAt string

    Horodatage ISO 8601 en UTC.

  • user anyOf

    Utilisateur du centre d’aide automatiquement identifié à partir de l’adresse e-mail de l’expéditeur (unicité sur e-mail + helpdesk), ou null lorsque l’expéditeur est anonyme ou non reconnu.

    + Show Child Attributes
    • anyOf options 2 variants anyOf

      One or more options can apply.

      + Show Child Attributes
      • option 1 object
        + Show Child Attributes
        • id string

          ID utilisateur du centre d’aide Ferndesk (hcusr_...).

        • name string | null

          Nom d’affichage de l’utilisateur du centre d’aide.

        • email string (email)

          Adresse e-mail de l’utilisateur du centre d’aide. Les adresses e-mail sont stockées en minuscules.

      • option 2 null