API und Webhooks für Entwickler
API-Schlüssel anlegen, die REST API nutzen und Ereignisse als signierte Webhooks empfangen.
Überblick
Was die App kann, geht auch per API. Die API ist in jedem Tarif enthalten.
- Basis-URL:
https://workflows.agiledeveloper.de/api/v1 - Dokumentation: https://workflows.agiledeveloper.de/docs
- OpenAPI: https://workflows.agiledeveloper.de/api/openapi.json
API-Schlüssel anlegen
- Öffnen Sie Einstellungen → Entwickler und API.
- Vergeben Sie unter API-Schlüssel einen Name.
- Wählen Sie unter Gültig: Unbegrenzt, 30 Tage, 90 Tage, 1 Jahr oder Bis zu einem Datum.
- Wählen Sie die Rechte einzeln oder mit Nur lesen, Workflows starten oder Alle.
- Klicken Sie auf Schlüssel erzeugen und kopieren Sie ihn sofort. Er wird nur dieses eine Mal angezeigt.
Mit Widerrufen sperren Sie einen Schlüssel sofort. Das lässt sich nicht rückgängig machen.
Anfragen senden
curl https://workflows.agiledeveloper.de/api/v1/workflows \
-H "Authorization: Bearer agile_wf_…"- Rate-Limit: 120 Anfragen pro Minute je API-Schlüssel. Jede Antwort trägt die Header
RateLimit-Limit,RateLimit-RemainingundRateLimit-Reset. - Listen:
limit(1 bis 200, Vorgabe 50) undoffset. - Fehler:
{ "fehler": { "code", "nachricht", "details" } }mit passendem HTTP-Status. - Idempotenz: POST-Anfragen akzeptieren den Header
Idempotency-Key. Eine Wiederholung mit demselben Schlüssel innerhalb von 24 Stunden führt nicht erneut aus.
Team und Abrechnung verwalten nur Team-Admins, auch über die API.
Workflow starten
POST /api/v1/workflows/{id}/ausfuehren startet die veröffentlichte Version und zählt als Ausführung. POST /api/v1/workflows/{id}/testen startet den Entwurf und zählt nicht.
Ereignisse als Webhook empfangen
Wir schicken Ereignisse als signierten POST an Ihre Adresse.
- Tragen Sie unter Webhooks die Ziel-URL ein. Sie muss HTTPS nutzen und öffentlich erreichbar sein.
- Wählen Sie die Ereignisse, etwa Lauf fehlgeschlagen oder 80 % der Ausführungen verbraucht.
- Klicken Sie auf Webhook anlegen und kopieren Sie das Signatur-Geheimnis. Es wird nur jetzt angezeigt.
Höchstens 10 Endpunkte sind möglich. Mit Test senden prüfen Sie den Empfang, Protokoll zeigt die Zustellungen.
Signatur und Wiederholungen
- Der Header lautet
Agile-Signature: t=<unix>,v1=<hex>.v1ist HMAC-SHA256 mit dem Signatur-Geheimnis über<t>.<body>. - Antworten Sie mit einem 2xx-Status. Sonst wiederholen wir nach 1, 5, 30, 120, 360 und 1.440 Minuten.
- Webhooks enthalten nur Kennungen, Namen, Status und Zeitpunkte, nie Zugangsdaten und keine vollständigen Lauf-Daten.
War dieser Artikel hilfreich?