Was kann die Deskwoot REST API?

Aktualisiert am 20.10.20263 Min. Lesezeit
Deutsch
Auf dieser Seite

Die Deskwoot REST API gibt dir programmatischen Zugriff auf deine Support-Daten. Du kannst Konversationen lesen und erstellen, Kontakte verwalten, Nachrichten senden und abrufen und Deskwoot an deine eigenen Tools und Skripte anbinden. Die REST API ist eine Enterprise-Funktion, und jede Anfrage authentifizierst du mit einem Token, den du unter Einstellungen > API-Token erstellst.

Was kannst du mit der API machen?

Die REST API deckt die Objekte ab, mit denen du im Helpdesk täglich arbeitest. Mit den passenden Berechtigungen des Tokens kannst du:

  • Konversationen: Konversationen auflisten, lesen, erstellen und ändern, auch ihren Status oder ihre Zuweisung.
  • Nachrichten: die Nachrichten einer Konversation abrufen und neue Antworten oder private Notizen schreiben.
  • Kontakte: die Personen, die dir schreiben, lesen, anlegen und ändern, einschließlich ihrer Attribute.
  • Reports: jede Zahl der Reports-Seite (Volumen, erste Antwortzeit, Lösungszeit, CSAT) pro Agent, Team, Inbox, Kanal, Label, Status, Priorität, Tag oder Woche, mit kombinierbaren Filtern und freiem Zeitraum, dazu jedes Gespräch und jede CSAT-Bewertung als Zeile oder CSV.

Damit eignet sich die API gut, um Tickets mit einem internen System abzugleichen, ein eigenes Dashboard zu bauen, wiederkehrende Änderungen zu automatisieren oder Konversationsdaten in ein anderes Tool zu übertragen.

Welcher Tarif enthält die REST API?

Die REST API ist eine Enterprise-Funktion, und API-Token kannst du nur in einem bezahlten Enterprise-Tarif erstellen. Die 7-tägige Enterprise-Testphase, mit der jedes neue Konto startet, enthält keine API-Token. Wenn du in einem kleineren Tarif bist und API-Zugriff brauchst, musst du auf Enterprise wechseln.

Wie bekomme ich einen Token?

Tokens erstellst und verwaltest du unter Einstellungen > API-Token. Gib jedem Token einen eindeutigen Namen, vergib nur die Berechtigungen, die die Integration braucht, und kopiere ihn gleich nach dem Erstellen, denn der vollständige Wert wird nur einmal angezeigt. Die ganze Anleitung, auch zur Basis-URL und zur Übergabe des Tokens im Authorization-Header, findest du im Artikel zu API-Token.

Und wenn ich lieber einen KI-Agenten möchte, statt Code zu schreiben?

Wenn ein externer KI-Agent den Helpdesk bedienen soll, statt dass du eine eigene Integration schreibst, passt der MCP-Server womöglich besser. Er stellt einem MCP-fähigen Agenten über einen Bot-Token mit begrenzten Berechtigungen einen festen Satz an Werkzeugen bereit. Wie die REST API ist er eine Enterprise-Funktion, funktioniert aber anders als API-Token auch während der 7-tägigen Enterprise-Testphase.

Häufige Fragen

Gibt es die REST API in jedem Tarif?
Nein. Die REST API ist eine Enterprise-Funktion, und API-Token brauchen einen bezahlten Enterprise-Tarif. Die 7-tägige Enterprise-Testphase enthält keine API-Token.
Worauf kann ich über die API zugreifen?
Unter anderem auf Konversationen, Nachrichten und Kontakte. Du kannst Konversationen lesen und erstellen, Antworten und Notizen schreiben und Kontakte verwalten, jeweils im Rahmen der Berechtigungen deines Tokens.
Wo erstelle ich einen API-Token?
Unter Einstellungen > API-Token. Gib dem Token einen Namen, vergib nur die Berechtigungen, die du brauchst, und kopiere ihn sofort, denn der vollständige Wert wird nur einmal angezeigt.
Soll ich die REST API oder den MCP-Server nutzen?
Mit der REST API baust du eigene Integrationen und Skripte. Den MCP-Server nutzt du, wenn ein externer KI-Agent den Helpdesk über einen Bot-Token mit begrenzten Berechtigungen bedienen soll. Beides sind Enterprise-Funktionen.
Kann ich Reports in mein eigenes Dashboard holen?
Ja. Die Reports-Endpunkte liefern dieselben Zahlen wie die Reports-Seite, gefiltert nach Agent, Team, Inbox, Kanal, Label, Status und Priorität für jeden Zeitraum, gruppiert nach Agent, Label, Tag, Woche und mehr, dazu jedes Gespräch und jede CSAT-Bewertung als Zeile. Rufe sie von deinem eigenen Server mit einem Token mit dem Scope conversations:read auf. Die vollständige Referenz steht in der API-Dokumentation.

War diese Anleitung hilfreich?

Weiterlesen

Fynn zu dieser Anleitung fragen

Kurze Antwort aus dieser Anleitung und dem restlichen Hilfecenter.

Noch Hilfe nötig?

Fynn antwortet im Chat aus diesen Anleitungen, und dort erreichst du auch das Team.

E-Mail schreiben