Risposte webhook - Campagne email e contatti

Che cos'è un webhook?

Un webhook è una chiamata a un URL attivata dal verificarsi di un evento, ad esempio un hard bounce, l'apertura di un'email, l'eliminazione di un contatto, ecc.

Quando si verifica un evento o un cambiamento di stato, viene inviata una richiesta HTTP POST in tempo reale all'URL specificato. Questa chiamata POST contiene informazioni sull'evento.

Risposte webhook

Le risposte vengono inviate in formato JSON e passate con POST all'URL indicato.

Quella che segue è una lista dei vari eventi webhook insieme alle risposte attese.

Nota 

ts, ts_sent, ts_event Fuso orario UTC
date_sent, date_event Fuso orario locale
date Fuso orario CET/CEST

Contrassegnato come spam

ETICHETTA TIPO DESCRIZIONE
event string "spam"
email string Email del destinatario
id integer ID interno del webhook
date_sent string Data di invio della campagna (anno-mese-giorno, ore:minuti:secondi)
date_event string Data in cui si è verificato l'evento (anno-mese-giorno, ore:minuti:secondi)
ts_sent integer Timbro temporale in secondi del momento di invio della campagna
ts_event integer Timbro temporale in secondi del momento in cui si è verificato l'evento
camp_id integer ID interno della campagna
campaign name string Nome interno della campagna
reason string Motivo della segnalazione come spam
ts integer Timbro temporale in secondi del momento in cui è stato generato il webhook
tag string Tag interno della campagna

Risposta d'esempio

{"id":139911,"camp_id":253,"email":"abc@example.com","campaign name":"Campaign ABC","date_sent":"2019-07-30 08:00:51","date_event":"2019-07-30 08:00:51","event":"spam","tag":"abc","reason":"lorem ipsum","ts_sent":1564466451,"ts_event":1564466451,"ts":1564466452}

Aperto

ETICHETTA TIPO DESCRIZIONE
event string "opened"
email string Email del destinatario
id integer ID interno del webhook
date_sent string Data di invio della campagna (anno-mese-giorno, ore:minuti:secondi)
date_event string Data in cui si è verificato l'evento (anno-mese-giorno, ore:minuti:secondi)
ts_sent integer Timbro temporale in secondi del momento di invio della campagna
ts_event integer Timbro temporale in secondi del momento in cui si è verificato l'evento
camp_id integer ID interno della campagna
campaign name string Nome interno della campagna
tag string Tag interno della campagna
ts integer Timbro temporale in secondi del momento in cui è stato generato il webhook

Risposta d'esempio

{"id":139911,"camp_id":253,"email":"abc@example.com","campaign name":"Campaign ABC","date_sent":"2019-07-30 11:30:50","date_event":"2019-07-30 11:39:15","event":"opened","tag":"abc","ts_sent":1564479050,"ts_event":1564479555,"ts":1564466956} 

Cliccato

ETICHETTA TIPO DESCRIZIONE
event string "clicked"
email string Email del destinatario
id integer ID interno del webhook
date_sent string Data di invio della campagna (anno-mese-giorno, ore:minuti:secondi) (Fuso orario locale)
date_event string Data in cui si è verificato l'evento (anno-mese-giorno, ore:minuti:secondi)
ts_sent integer Timbro temporale in secondi del momento di invio della campagna
ts_event integer Timbro temporale in secondi del momento in cui si è verificato l'evento
camp_id integer ID interno della campagna
campaign name string Nome interno della campagna
tag string Tag interno della campagna
ts integer Timbro temporale in secondi del momento in cui è stato generato il webhook
URL string URL cliccato

Risposta d'esempio

{"id":139911,"camp_id":253,"email":"abc@example.com","campaign name":"Campaign ABC","date_sent":"2019-07-30 11:30:50","date_event":"2019-07-30 11:39:15","event":"clicked","tag":"abc","ts_sent":1564479050,"ts_event":1564479555,"URL":"https://example.com","ts":1564466956} 

Hard bounce

ETICHETTA TIPO DESCRIZIONE
event string "hard_bounce"
email string Email del destinatario
id integer ID interno del webhook
date_sent string Data di invio della campagna (anno-mese-giorno, ore:minuti:secondi)
date_event string Data in cui si è verificato l'evento (anno-mese-giorno, ore:minuti:secondi)
ts_sent integer Timbro temporale in secondi del momento di invio della campagna
ts_event integer Timbro temporale in secondi del momento in cui si è verificato l'evento
camp_id integer ID interno della campagna
campaign name string Nome interno della campagna
sending_ip string IP usato per inviare il messaggio
reason string Motivo dell'hard bounce
ts integer Timbro temporale in secondi del momento in cui è stato generato il webhook
tag string Tag interno della campagna

Risposta d'esempio

{"id":139911,"camp_id":253,"email":"abc@example.com","campaign name":"Campaign ABC","date_sent":"2019-07-30 08:00:51","date_event":"2019-07-30 08:00:51","event":"hard_bounce","tag":"abc","reason":"lorem ipsum","ts_sent":1564466451,"ts_event":1564466451,"sending_ip":"111.11.11.1","ts":1564466452} 

Soft bounce

ETICHETTA TIPO DESCRIZIONE
event string "soft_bounce"
email string Email del destinatario
id integer ID interno del webhook
date_sent string Data di invio della campagna (anno-mese-giorno, ore:minuti:secondi)
date_event string Data in cui si è verificato l'evento (anno-mese-giorno, ore:minuti:secondi)
ts_sent integer Timbro temporale in secondi del momento di invio della campagna
ts_event integer Timbro temporale in secondi del momento in cui si è verificato l'evento
camp_id integer ID interno della campagna
campaign name string Nome interno della campagna
reason string Motivo del soft bounce
sending_ip string IP usato per inviare il messaggio
ts integer Timbro temporale in secondi del momento in cui è stato generato il webhook
tag string Tag interno della campagna

Risposta d'esempio

{"id":139911,"camp_id":253,"email":"abc@example.com","campaign name":"Campaign ABC","date_sent":"2019-07-30 08:00:51","date_event":"2019-07-30 08:00:51","event":"soft_bounce","tag":"abc","reason":"lorem ipsum","ts_sent":1564466451,"ts_event":1564466451,"sending_ip":"111.11.11.1","ts":1564466452}

Consegnato

ETICHETTA TIPO DESCRIZIONE
event string "delivered"
email string Email del destinatario
id integer ID interno del webhook
date_sent string Data di invio della campagna (anno-mese-giorno, ore:minuti:secondi)
date_event string Data in cui si è verificato l'evento (anno-mese-giorno, ore:minuti:secondid)
ts_sent integer Timbro temporale in secondi del momento di invio della campagna
ts_event integer Timbro temporale in secondi del momento in cui si è verificato l'evento
sending_ip string IP usato per inviare il messaggio
camp_id integer ID interno della campagna
campaign name string Nome interno della campagna
ts integer Timbro temporale in secondi del momento in cui è stato generato il webhook
tag string Tag interno della campagna

Risposta d'esempio

{"id":139911,"camp_id":253,"email":"abc@example.com","campaign name":"Campaign ABC","date_sent":"2019-07-30 08:00:51","date_event":"2019-07-30 08:00:51","event":"delivered","tag":"abc","ts_sent":1564466451,"ts_event":1564466451,"sending_ip":"111.11.11.1","ts":1564466452}

Disiscritto

ETICHETTA TIPO DESCRIZIONE
event string "unsubscribe"
email string Email del destinatario
id integer ID interno del webhook
date_sent string Data di invio della campagna (anno-mese-giorno, ore:minuti:secondi)
date_event string Data in cui si è verificato l'evento (anno-mese-giorno, ore:minuti:secondi)
ts_sent integer Timbro temporale in secondi del momento di invio della campagna
ts_event integer Timbro temporale in secondi del momento in cui si è verificato l'evento
camp_id integer ID interno della campagna
campaign name string Nome interno della campagna
list_id array of integers ID delle liste interne da cui è stato disiscritto il destinatario
ts integer Timbro temporale in secondi del momento in cui è stato generato il webhook
tag string Tag interno della campagna

Risposta d'esempio

{"id":139911,"camp_id":253,"email":"abc@example.com","campaign name":"Campaign ABC","date_sent":"2019-07-30 11:30:50","date_event":"2019-07-30 11:39:15","event":"unsubscribe","tag":"abc","list_id":[63,61],"ts_sent":1564479050,"ts_event":1564479555,"ts":1564466956} 

Contatto aggiunto a una lista

ETICHETTA TIPO DESCRIZIONE
event string "list_addition"
email string Indirizzo email del destinatario aggiunto
id integer ID interno del webhook
key string Chiave interna
list_id array of integers ID delle liste interno a cui è stato aggiunto il destinatario
date string Data in cui si è verificato l'evento (anno-mese-giorno, ore:minuti:secondi) 
ts integer Timbro temporale in secondi del momento in cui è stato generato il webhook

Risposta d'esempio

{"id":139911,"email":"lu.sykora@demo.domain","event":"list_addition","key":"fsn920nfsv6h0gfkkqrb5","list_id":[63,61],"date":"2019-07-30 08:48:11","ts":1564469292}

Contatto aggiornato

ETICHETTA TIPO DESCRIZIONE
event string "contact_updated"
email string Indirizzo email del destinatario aggiunto
id integer ID interno del webhook
key string Chiave interna
date string Data in cui si è verificato l'evento (anno-mese-giorno, ore:minuti:secondi) 
ts integer Timbro temporale in secondi del momento in cui è stato generato il webhook
content array of strings Recapiti completi con aggiornamenti

Risposta d'esempio

{"id":139911,"event":"contact_updated","key":"fsn920nfsv6h0gfkkqrb5","date":"2019-07-30 08:52:02","ts":1564469523,"content":[{"email":"lu.sykora@demo.domain","attributes":{"FIRSTNAME":"Luke","LASTNAME":"Sykora","SMS":"30764261246","SHOPIFY_LAST_30_DAYS_CA":0,"SHOPIFY_ORDER_TOTAL":0,"SHOPIFY_CA_USER":0}}]}

Contatto eliminato

ETICHETTA TIPO DESCRIZIONE
event string "contact_deleted"
email string Indirizzo email del destinatario rimosso
id integer ID interno del webhook
key string Chiave interna
date string Data in cui si è verificato l'evento (anno-mese-giorno, ore:minuti:secondi)
ts integer Timbro temporale in secondi del momento in cui è stato generato il webhook

Risposta d'esempio

{"id":139911,"email":["lu.sykora@demo.domain"],"event":"contact_deleted","key":"fsn920nfsv6h0gfkkqrb5","date":"2019-07-30 08:53:17","ts":1564469598}