Du nutzt die ChatWerk Inbox bereits im Frontend – vielleicht möchtest du aber auch über unsere API automatisiert auf bestimmte Funktionen zugreifen? Diese Seite hilft dir, einen leichten Einstieg zu finden, selbst wenn du noch keine API-Erfahrung hast.
Was ist eine API eigentlich?
Eine API (Application Programming Interface) ist eine Schnittstelle, über die Softwareprogramme miteinander kommunizieren können – in unserem Fall: dein System mit der ChatWerk Inbox. So kannst du automatisiert Nachrichten versenden, Kontakte importieren oder Chatbots steuern, ohne dich in der Oberfläche einloggen zu müssen. Die Schnittstelle teilt sich auf in Core und Inbox API, die jeweils unten beschrieben sind.
Die Unified API ist für dich als Inbox Kunde uninteressant, da sie ausschließlich für eine Messaging-Nutzung ohne Inbox geeignet ist.
Was brauche ich für den Start?
Um mit der API zu arbeiten, brauchst du:
✅ Organisation ID und Channel ID
Beides findest du in der URL, wenn du in der Inbox Einstellungen aufrufst.
Beispiel:https://inbox.chatwerk.de/settings/organization/{organization_id}/channel/{channel_id}✅ Gateway ID (nur für manche Funktionen wie z. B. Templates oder Campaigns)
Diese erhältst du per API-Call:https://api.chatwerk.de/core/gateways?channel_id={channel_id}✅ Authentifizierung per Login
Mit deinem normalen ChatWerk-Login erhältst du einen sogenannten Bearer Token, den du für weitere API-Aufrufe nutzen musst.
POST:https://api.chatwerk.de/core/auth/login
Wie teste ich die API?
Du brauchst ein Tool, um API-Aufrufe zu testen. Dafür empfehlen wir z.B. Postman. Postman ist ein kostenloses Tool, mit dem du API-Calls einfach ausführen und testen kannst – ohne Programmierkenntnisse. Du kannst damit die Anfrage-URLs eingeben, deine Zugangsdaten hinterlegen und die Ergebnisse direkt einsehen.
API-Dokumentation
Alle verfügbaren Endpunkte und Beispiele findest du hier:
📘 API Dokumentation Link
Tipp: Wenn du dir unsicher bist, mit welchem Endpunkt du starten sollst – weiter unten findest du eine Übersicht mit häufig genutzten Calls und Anwendungsbeispielen.
_______________________________
Häufig genutzte API-Calls
Hier eine kleine Auswahl von häufig verwendeten Endpunkten im Self-Service:
💎 Core API 🔗
Mit der Core API steuerst du alle Themen rund um dein Basis-Setup.
Campaigns/Chatbots/core/channels/:channel_id/campaigns
Für das Set-up von Chatbots: "type": "bot_workflow"
Für das Set-up von Campaigns:
Push-Newsletter: "type": "proactive"
Keywordcampaign: "type": "reactive"
Botmanager/core/channel
Da den ganzen channel holen und den bot manager teil aktualisiert und channel updaten
Template Set-up/core/templates
Erstelle über diesen Call Templates, die unser System automatisch bei WhatsApp einreicht. Die Bestätigung durch WhatsApp dauert meist 5-50 Minuten. Nur bestätigte Templates können für Campaigns und Template Send-out genutzt werden. Für Buchungsbestätigungen nutze Templates mit Parametern, die du flexibel ausfüllen kannst, um sie wiederzuverwenden.
📨 Inbox API 🔗
Die Inbox API steuert die aktive Kommunikation, Messaging und Contacts.
Template Send-out /inbox/channels/:channel_id/messages/templates
Import | Kontakte importieren (ohne Benachrichtigung)/inbox/channels/:channel_id/gateways/:gateway_id/import-conversations
Mit diesem Call kannst du Kontakte hochladen, für die du bereits ein Opt-in zur Kommunikation hast. Beim Upload werden keine Benachrichtigungen versendet. Die Kommunikation startet erst mit deiner ersten Nachricht oder Kampagne. Dieser Call funktioniert für alle Messenger-Plattformen.
Mehr hier ->
Import | WhatsApp Kontakte einladen (mit Benachrichtigung)/inbox/channels/:channel_id/import-contacts/whatsapp
Kontakte in deiner Inbox erhalten automatisch ein Opt-in-Template. Mit der Bestätigung stimmen sie der WhatsApp-Kommunikation zu. Ideal für Kontakte ohne bisherige Zustimmung. Gilt nur für WhatsApp.
Mehr hier ->
Hinweis: Das Template "whatsapp_opt_in" ist in jeder Inbox standardmäßig verfügbar, kann jedoch via API (/core/templates) oder Support ersetzt werden. Beachte die Payload des Buttons.
Export | Kontakte herunterladen/inbox/channels/:channel_id/conversations
Kontakte aus deiner Inbox kannst du über diesen Call exportieren. Dieses Feature steht nicht im Frontend zur Verfügung, sondern ist ausschließlich über die API verfügbar.
Export | Chatverlauf herunterladen (Download)/inbox/organizations/:organization_id/export-messages
Kontakte und Chatverläufe können mit diesem Call heruntergeladen werden.