API-Schlüssel und Webhooks
So binden Sie Agile Companion über die REST-API und Webhooks an Ihre eigenen Systeme an.
Wo Sie alles finden
Öffnen Sie Einstellungen > Entwickler. Dort gibt es die Bereiche Schnellstart, API-Schlüssel, Webhooks, Protokoll und KI-Assistenten. Die API-Dokumentation finden Sie unter companion.agiledeveloper.de/docs, die Beschreibung im OpenAPI-Format unter /api/openapi.json.
API-Schlüssel anlegen
- Wählen Sie API-Schlüssel und klicken Sie auf Schlüssel anlegen.
- Geben Sie einen Namen ein.
- Wählen Sie die Bereiche, die Ihre Integration braucht.
- Wählen Sie die Gültigkeit: Unbegrenzt, 30 Tage, 90 Tage oder 1 Jahr.
- Klicken Sie auf Anlegen und kopieren Sie den Schlüssel sofort. Er wird nur einmal angezeigt.
Schlüssel beginnen mit agile_companion_. Senden Sie ihn im Kopf Authorization: Bearer agile_companion_…. Ein Schlüssel handelt mit Ihren Rechten. Halten Sie ihn geheim.
Bereiche
| Bereich | Erlaubt |
|---|---|
| meetings:lesen | Meetings, Transkripte, Zusammenfassungen, Aufgaben, Vorlagen und Suche lesen |
| meetings:schreiben | Bot schicken, hochladen, aufnehmen, Meetings bearbeiten, Aufgaben abhaken, teilen, Vorlagen pflegen |
| meetings:loeschen | Meetings und Aufnahmen löschen |
| kalender:lesen | Kalenderquellen, Termine und Companion-Einstellungen lesen |
| kalender:verwalten | Kalender verbinden und trennen, Aufnahme je Termin an oder aus, Companion-Einstellungen ändern |
| ki:nutzen | Fragen an Meetings stellen und Meetings neu auswerten |
| ablage:verwalten | Verbindungen zu Agile Storage und Agile Projektmanagement verwalten, Ablage und Export auslösen |
| team:lesen | Team, Mitglieder und Rollen lesen |
| team:verwalten | Mitglieder einladen, Rollen und Team ändern, Datenschutz-Einstellungen (nur Admins) |
| webhooks:verwalten | Webhook-Endpunkte anlegen, löschen und Zustellungen lesen |
| abrechnung:lesen | Tarif, Minuten, Plätze und Buchungen lesen |
| abrechnung:verwalten | Tarif wechseln, Zusatzplätze, Kostendeckel, Kundenportal (nur Admins) |
Webhooks anlegen (ab Pro)
- Wählen Sie Webhooks und klicken Sie auf Webhook anlegen.
- Geben Sie eine HTTPS-Adresse ein.
- Wählen Sie mindestens ein Ereignis.
- Klicken Sie auf Anlegen und kopieren Sie das Signatur-Geheimnis. Es wird nur jetzt angezeigt.
Mit Testen schicken Sie ein Probe-Ereignis. Unter Zustellungen sehen Sie jeden Versand mit Ergebnis.
Ereignisse
| Ereignis | Bedeutung |
|---|---|
| meeting.scheduled | Companion für ein Meeting eingeplant |
| meeting.joined | Companion ist dem Meeting beigetreten |
| meeting.recording | Aufnahme läuft |
| meeting.completed | Zusammenfassung fertig |
| meeting.failed | Meeting nicht aufgenommen |
| meeting.stopped | Aufnahme nach Widerspruch gestoppt und gelöscht |
| task.created | Aufgabe aus einem Meeting |
| minutes.warning | 80 % der Minuten genutzt |
| minutes.exhausted | Minuten aufgebraucht |
| subscription.changed | Tarif geändert |
Zustellung und Signatur
Wir senden jedes Ereignis per POST mit JSON an Ihre Adresse. Die Kopfzeilen Agile-Event und Agile-Delivery nennen Ereignis und Zustellungs-ID. Die Signatur steht im Kopf Agile-Signature im Format t=<Zeitstempel>,v1=<Signatur>. Die Signatur ist ein HMAC-SHA256 über <Zeitstempel>.<Rohinhalt> mit Ihrem Signatur-Geheimnis. Prüfen Sie sie, bevor Sie ein Ereignis verarbeiten.
Antwortet Ihre Adresse nicht mit einem Status von 200 bis 299, versuchen wir es mehrfach mit wachsendem Abstand erneut.
Protokoll
Unter Protokoll sehen Sie die API-Anfragen der letzten 30 Tage mit Schlüssel, App oder MCP. Gespeichert werden nur Methode, Pfad, Status und Dauer, keine Inhalte.