Wie erstelle ich einen API-Schlüssel und richte Webhooks ein?
Unter Einstellungen › API und Integrationen auf „Schlüssel anlegen“, Rechte je Bereich wählen. Der Schlüssel agile_ks_… wird nur einmal angezeigt. Doku unter /docs.
API-Schlüssel anlegen
- Öffnen Sie Einstellungen › API und Integrationen, Karte API-Schlüssel.
- Klicken Sie Schlüssel anlegen.
- Vergeben Sie einen Name und wählen Sie die Rechte je Bereich: Kein Zugriff, Lesen oder Lesen und schreiben für Gespräche, Kontakte, Wissen und Help Center, Kennzahlen (nur lesen) sowie Einstellungen, Team, Webhooks. Optional ein Ablaufdatum.
- Kopieren Sie den Schlüssel und bestätigen Sie mit Ich habe ihn gespeichert. Er beginnt mit
agile_ks_und wird nur einmal angezeigt.
Nicht mehr benötigte Schlüssel machen Sie mit Widerrufen ungültig. Ein Schlüssel handelt nie mit mehr Rechten als Ihre Rolle.
Die Schnittstelle
- Basis:
https://kundensupport.agiledeveloper.de/api/v1/… - Header:
Authorization: Bearer agile_ks_… - bis zu 600 Anfragen pro Minute,
Idempotency-Keywird 24 Stunden beachtet - Dokumentation: /docs, OpenAPI unter
/api/openapi.json. In der App auch im Menü unter Ihrem Namen: API-Dokumentation.
Webhooks (Admins)
Unter Webhooks mit Webhook eine Empfänger-Adresse (https), Beschreibung und Ereignisse wählen, zum Beispiel neue Gespräche, Nachrichten, Übergaben, Bewertungen, Kontakte oder veröffentlichte Artikel. Das Signaturgeheimnis wird nur einmal angezeigt. Jede Zustellung trägt den Header Agile-Signature: t=…,v1=… (HMAC-SHA256 über Zeitstempel und Inhalt). Fehlgeschlagene Zustellungen werden bis zu 6 Mal wiederholt. Mit Testen und Protokoll prüfen Sie die Zustellung.