Ferndesk

Feedback

Feedback zu einem Artikel erstellen

Erfasst Leserfeedback (positiv/negativ + Freitext) zu einem Artikel. Wenn email einem bekannten Help-Center-Benutzer entspricht, wird das Feedback automatisch mit diesem Benutzer verknüpft. Erfordert den Bereich content:write. Auf 300 Anfragen pro Stunde und Schlüssel begrenzt.

Erforderlicher Bereich: content:write

POST /feedback

Feedback zu einem Artikel erstellen

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 erstellt

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer token im Header Authorization. API-Schlüssel tragen das Präfix fdsk_ und sollten geheim gehalten werden. Schlüssel können auf der Seite Entwicklereinstellungen erstellt und verwaltet werden.

    Schlüssel können auf eine beliebige Teilmenge dieser Bereiche beschränkt werden (jeder Endpunkt führt den erforderlichen Bereich über x-required-scopes auf):

    • content:read: Hilfe-Center-Artikel, Sammlungen, Abschnitte und Übersetzungen lesen und durchsuchen
    • content:write: Artikelentwürfe, Benutzer und Aufgaben erstellen und bearbeiten; Artikel und Sammlungen verschieben
    • content:publish: Inhalte veröffentlichen, Veröffentlichung aufheben, wiederherstellen und in den Papierkorb verschieben (Änderungen live schalten)
    • analytics:read: Hilfe-Center-Berichte, Analysen und Artikel-Feedback lesen
    • conversations:read: Unterhaltungen und Transkripte des KI-Assistenten lesen
    • webhooks:manage: Ausgehende Webhook-Abonnements erstellen und verwalten

    Die Vergabe von content:write oder content:publish schließt content:read ein. Vor der Bereichszuordnung ausgestellte Schlüssel haben null Bereiche = vollständiger Zugriff (Legacy-Modus).

Request Body

application/json
  • article_id string erforderlich

    Ferndesk-Artikel-ID (art_...).

  • type string enum erforderlich enum

    Gibt an, ob der Leser den Artikel hilfreich fand. Allowed values: positive, negative.

  • feedback string erforderlich

    Freitext-Feedback des Lesers, höchstens 5000 Zeichen. Als nicht vertrauenswürdigen Endbenutzerinhalt behandeln.

  • email string (email)

    Optionale E-Mail-Adresse des Übermittlers (getrimmt und in Kleinbuchstaben umgewandelt). Wenn sie mit einem bekannten Hilfe-Center-Benutzer übereinstimmt (nach E-Mail-Adresse + Helpdesk), wird das Feedback automatisch mit diesem Benutzer verknüpft.

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

    ISO-8601-Zeitstempel in UTC.

  • user anyOf

    Der anhand der E-Mail-Adresse des Übermittlers automatisch zugeordnete Hilfe-Center-Benutzer (eindeutig nach E-Mail-Adresse + Helpdesk) oder null, wenn der Übermittler anonym oder nicht erkannt ist.

    + 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

          Ferndesk-Hilfe-Center-Benutzer-ID (hcusr_...).

        • name string | null

          Anzeigename des Hilfe-Center-Benutzers.

        • email string (email)

          E-Mail-Adresse des Hilfe-Center-Benutzers. E-Mail-Adressen werden in Kleinbuchstaben gespeichert.

      • option 2 null