Avvisi istantanei sulle automazioni
POST
https://app.sendapp.ai/api/automations/hooks
Iscrive un tuo indirizzo alle esecuzioni di un'automazione, di qualsiasi tipo: appena parte, finisce o fallisce, SendApp invia un POST con automazione, esecuzione, contatto e dati dell'evento. È quello che usa il trigger istantaneo di Zapier. L'elenco di tutte le automazioni si legge con
GET /api/automations?all=1; GET /api/automations/hooks mostra le iscrizioni, GET /api/automations/hooks/sample un esempio, DELETE /api/automations/hooks/{id} ne toglie una. Ogni invio ha l'intestazione
X-SendApp-Signature: t=<unix>,v1=<hmac>: HMAC-SHA256 di t.corpo con il secret, che ricevi una volta sola quando crei l'iscrizione.Se il tuo indirizzo risponde 410 l'iscrizione viene tolta. Con 429, 5xx o nessuna risposta l'invio viene ritentato fino a 4 volte.
Se il tuo indirizzo fallisce di continuo (20 invii di fila), l'iscrizione va in pausa: in quel periodo gli eventi non vengono inviati né recuperati dopo. SendApp riprova circa una volta all'ora con l'evento di quel momento, e alla prima risposta positiva l'iscrizione riparte. Riparte anche se la crei di nuovo. Se continua a fallire per circa una settimana di tentativi viene tolta. Con più di 500 invii in attesa per iscrizione, o 1000 per account, quelli nuovi vengono saltati. Il tuo indirizzo deve rispondere entro 4 secondi, se no l'invio conta come fallito. Il campo
paused dell'iscrizione dice se è in pausa, e ti avvisiamo via email una volta per ogni pausa.run.reason è un codice fisso, mai un testo: opted_out, app_off, timeout, step_failed, skipped oppure vuoto.I link
order_status_url e tracking_url possono aprire dati del destinatario senza login: trattali come riservati.Se la connessione con cui hai creato l'iscrizione scade, gli invii vanno in pausa e gli eventi del periodo non vengono recuperati: ti avvisiamo una volta sola, nel pannello e via email. Ricollegala per farli ripartire.
Le prove dell'automazione e le esecuzioni saltate dai suoi controlli (anti-ripetizione, orari di invio) non inviano nulla.
Ricevi dati personali del contatto nel tuo strumento: ne resti responsabile e devi rispettare lo stato
opted_out. Il contatto escluso non blocca l'invio: contact.id è la chiave da usare per ritrovare il contatto dalle API. Il corpo riporta sempre contact.opted_out e contact.marketing_consent, e run.skipped_for_opt_out è vero se un passo o l'esecuzione sono stati saltati per esclusione. Non contiene testi delle conversazioni.Un'email fallita può inviare sia
run_completed sia run_failed per la stessa esecuzione: il passo che mette in coda l'email chiude l'esecuzione, e se l'email fallisce dopo l'esecuzione diventa fallita.L'iscrizione si interrompe se revochi la connessione o la chiave API con cui è stata creata. Gli invii si fermano anche con l'account sospeso, il piano scaduto o senza accesso API.
Parametri
5 · 1 obbligatori
url
obbligatorio
Indirizzo https pubblico.
events
opzionale
Uno o più tra
run_started, run_completed, run_failed. Predefinito: run_started.
automation_id
opzionale
Vuoto = tutte le automazioni dell'account.
label
opzionale
Un nome per riconoscerla.
include_event_data
opzionale
Includi i dati dell'evento che ha avviato la regola, in
data.hook_data, più data.payment_link e data.deal_name. Spento per impostazione predefinita: da spento questi campi non ci sono. Da acceso vengono tolti credenziali e campi di testo libero noti (body, message, comment, note, description, ticket, assignee, reason), anche annidati. Può contenere dati personali e altri dati dei sistemi collegati, sotto la tua responsabilità. Con lo stesso parametro, GET /api/automations/hooks/sample mostra un esempio che comprende questi campi.
Serve aiuto con l'integrazione? info@sendapp.live