Sofortbenachrichtigungen zu Automatisierungen
POST
https://app.sendapp.ai/api/automations/hooks
Abonniert eine deiner Adressen für die Ausführungen einer Automatisierung beliebiger Art: Sobald sie startet, endet oder fehlschlägt, sendet SendApp einen POST mit Automatisierung, Ausführung, Kontakt und Ereignisdaten. Das nutzt der Sofort-Trigger von Zapier. Die Liste aller Automatisierungen liest du mit
GET /api/automations?all=1; GET /api/automations/hooks zeigt die Abonnements, GET /api/automations/hooks/sample ein Beispiel, DELETE /api/automations/hooks/{id} entfernt eines. Jede Zustellung hat den Header
X-SendApp-Signature: t=<unix>,v1=<hmac>: HMAC-SHA256 von t.body mit dem secret, das du nur einmal beim Erstellen des Abonnements erhältst.Antwortet deine Adresse mit 410, wird das Abonnement entfernt. Bei 429, 5xx oder keiner Antwort wird die Zustellung bis zu 4-mal wiederholt.
Wenn deine Adresse dauerhaft fehlschlägt (20 Zustellungen in Folge), wird das Abonnement pausiert: In dieser Zeit werden Ereignisse weder gesendet noch später nachgeholt. SendApp versucht es etwa einmal pro Stunde mit dem aktuellen Ereignis erneut, und die erste erfolgreiche Antwort startet das Abonnement wieder. Es startet auch wieder, wenn du es neu erstellst. Schlägt es etwa eine Woche lang weiter fehl, wird es entfernt. Bei mehr als 500 wartenden Zustellungen pro Abonnement oder 1000 pro Konto werden neue übersprungen. Deine Adresse muss innerhalb von 4 Sekunden antworten, sonst gilt die Zustellung als fehlgeschlagen. Das Feld
paused des Abonnements zeigt, ob es pausiert ist, und wir informieren dich einmal pro Pause per E-Mail.run.reason ist ein fester Code, nie ein Text: opted_out, app_off, timeout, step_failed, skipped oder leer.Die Links
order_status_url und tracking_url können Daten des Empfängers ohne Anmeldung öffnen: Behandle sie als vertraulich.Läuft die Verbindung ab, mit der du das Abonnement erstellt hast, werden die Zustellungen pausiert und die Ereignisse dieses Zeitraums nicht nachgeholt: Wir informieren dich einmal, im Panel und per E-Mail. Verbinde sie erneut, damit sie wieder starten.
Tests der Automatisierung und Ausführungen, die durch ihre Prüfungen übersprungen werden (Wiederholungsschutz, Sendezeiten), senden nichts.
Du erhältst personenbezogene Daten des Kontakts in deinem Tool: Du bleibst dafür verantwortlich und musst den Status
opted_out beachten. Ein ausgeschlossener Kontakt stoppt die Zustellung nicht: contact.id ist der Schlüssel, um den Kontakt über die APIs zu finden. Der Inhalt enthält immer contact.opted_out und contact.marketing_consent, und run.skipped_for_opt_out ist wahr, wenn ein Schritt oder die Ausführung wegen des Ausschlusses übersprungen wurde. Er enthält keine Gesprächstexte.Eine fehlgeschlagene E-Mail kann für dieselbe Ausführung sowohl
run_completed als auch run_failed senden: Der Schritt, der die E-Mail in die Warteschlange stellt, schließt die Ausführung ab, und schlägt die E-Mail danach fehl, gilt die Ausführung als fehlgeschlagen.Das Abonnement endet, wenn du die Verbindung oder den API-Schlüssel widerrufst, mit dem es erstellt wurde. Die Zustellungen stoppen auch bei gesperrtem Konto, abgelaufenem Tarif oder fehlendem API-Zugang.
Parameter
5 · 1 Pflichtfelder
url
erforderlich
Öffentliche https-Adresse.
events
optional
Eines oder mehrere von
run_started, run_completed, run_failed. Standard: run_started.
automation_id
optional
Leer = alle Automatisierungen des Kontos.
label
optional
Ein Name zum Wiedererkennen.
include_event_data
optional
Nimmt die Daten des Ereignisses, das die Regel gestartet hat, in
data.hook_data auf, dazu data.payment_link und data.deal_name. Standardmäßig aus: Dann fehlen diese Felder. Wenn an, werden Zugangsdaten und bekannte Freitextfelder (body, message, comment, note, description, ticket, assignee, reason) entfernt, auch verschachtelte. Es kann personenbezogene und andere Daten der verbundenen Systeme enthalten, in deiner Verantwortung. Mit demselben Parameter zeigt GET /api/automations/hooks/sample ein Beispiel mit diesen Feldern.
Brauchen Sie Hilfe bei der Integration? info@sendapp.live