Deskwoot logoDeskwoot

Entwicklerdokumentation

Alles, was du brauchst, um Deskwoot in deinen Stack zu integrieren - bette das Chat-Widget ein oder steuere die Plattform programmatisch aus deinem Backend.

Deskwoot ist API-first gebaut, sodass alles, was du im Dashboard machen kannst, auch über HTTP verfügbar ist. Die REST-API erlaubt dir, Konversationen zu erstellen und zu beantworten, Kontakte zu verwalten, benutzerdefinierte Attribute zu synchronisieren, auf Webhook-Events zu hören und Analysen in dein eigenes BI-Tool zu ziehen. Die Authentifizierung erfolgt über ein einfaches Bearer-Token, das du in Einstellungen → API-Tokens generierst, mit pro-Token-Scopes, sodass du einem Reporting-Job nur Lesezugriff und deiner Backoffice-Integration vollen Zugriff geben kannst.

Das JavaScript-Widget-SDK bringt Deskwoot-Live-Chat auf deine Website. Es ist ein einzelnes Script-Tag plus ein winziges Config-Objekt und übernimmt Echtzeit-Messaging, Identitäts-Vorbefüllung für angemeldete Nutzer, proaktive Chat-Trigger, CSP-Härtung, Dateianhänge und den KI-Bot-Fallback automatisch. Wenn du tiefere Kontrolle möchtest - Farben zur Laufzeit ändern, das Widget aus deinem eigenen Button öffnen, Seitenkontext tracken - bietet das SDK eine kleine JavaScript-API auf window.$deskwoot.

Wenn du gerade erst anfängst, empfehlen wir, zuerst das Widget-SDK zu lesen (die meisten Teams haben es in unter 10 Minuten live) und dann zur REST-API zu wechseln, sobald du CRM-Daten synchronisieren oder Ticket-Erstellung aus deinen eigenen Apps automatisieren musst.

Widget-SDK

JavaScript-Chat-Widget

Bette das Deskwoot-Live-Chat-Widget auf deiner Website ein. Kopiere das Skript-Snippet, konfiguriere Farben und Verhalten und lass Besucher deine Agenten erreichen.

  • Embed-Snippet
  • Konfigurationsoptionen
  • JavaScript-API
  • Identitäts-Vorbefüllung
  • CSP-Hinweise
Doku öffnen
REST-API

HTTP-API

Programmatischer Zugriff auf Konversationen, Kontakte, Posteingänge, Teams und mehr. Authentifiziere dich mit einem API-Token und steuere Deskwoot aus deinem Backend.

  • Auth + Tokens
  • Konversationen
  • Kontakte
  • Posteingänge
  • Webhooks
Doku öffnen

Verwandtes im Dashboard

Integrations-Bereiche, die noch keine eigene Doku-Seite haben, leben direkt in deinem Deskwoot-Dashboard:

  • Einstellungen → Webhooks - abonniere Konversations-, Nachrichten- und Kontakt-Events via HTTP-Callbacks
  • Einstellungen → Integrationen - Ein-Klick-Konnektoren für Shopify, Stripe, WooCommerce, Slack, Zapier und mehr
  • Einstellungen → API-Tokens - erstelle scoped Tokens für die REST-API

Fehlt eine Integration oder brauchst du Hilfe beim Verkabeln? Erreiche uns unter hello@deskwoot.com.

Häufig gestellte Fragen

Entwicklerfragen zur Deskwoot API und Webhooks.

Hat Deskwoot eine REST API?

Ja. Deskwoot bietet eine vollständige REST API für Konversationen, Kontakte, Nachrichten, Inboxes, Teams, Agenten, Labels, eigene Attribute, Automatisierungsregeln und Help Center Artikel. Die API treibt die offizielle Mobile App und ist auf deskwoot.com/docs/api mit Beispielen in curl und JavaScript dokumentiert.

Wie authentifiziere ich API Anfragen?

Erzeuge einen API Token unter Einstellungen > Developer Access. Übergib ihn als Bearer Token im Authorization Header bei jeder Anfrage. Tokens sind auf einen Workspace beschränkt und können jederzeit widerrufen werden ohne andere Tokens zu beeinflussen.

Gibt es Webhooks für neue Konversationen und Nachrichten?

Ja. Deskwoot feuert Webhooks bei Konversationsereignissen (erstellt, Status geändert, zugewiesen, gelöst) und Nachrichtenereignissen (neu eingehend, neu ausgehend, neue private Notiz). Du registrierst Webhook URLs pro Inbox oder Workspace und Deskwoot signiert jede Auslieferung damit du die Quelle verifizieren kannst.

Kann ich mit der Deskwoot API einen eigenen Kanal bauen?

Ja. Die REST API akzeptiert eingehende Nachrichten unter jedem Source Identifier den du definierst, damit du In-App Chat aus einer Mobile App, In-Game Chat, IoT Geräte oder jede eigene Oberfläche integrieren kannst. Ausgehende Antworten laufen über dieselbe API und triggern deinen eigenen Delivery Callback.

Wo finde ich die API Rate Limits?

Das Basis Rate Limit liegt bei 60 Anfragen pro Minute pro Token für die meisten Endpoints, mit höheren Limits für Bulk Operationen. Die vollständige Tabelle pro Endpoint ist auf deskwoot.com/docs/api/rate-limits dokumentiert. Bei einem Limit Hit liefert die Antwort einen Retry-After Header damit dein Client sauber zurückzieht.

Gibt es ein OpenAPI Spec oder Postman Collection?

Ein OpenAPI 3 Spec ist auf deskwoot.com/docs/api/openapi.json veröffentlicht und kann in Postman, Insomnia oder jedes OpenAPI-kompatible Tool importiert werden um Clients in jeder Sprache zu generieren. Das Spec bleibt mit der Live API bei jedem Release synchron.