Configurare un webhook
Per creare un nuovo webhook, vai alla pagina Configurazioni > Gestione console > Avanzate > Webhooks e clicca sul pulsante Aggiungi nuovo webhook.
I webhook, come abbiamo accennato nell'introduzione ai webhooks, sono facilmente personalizzabili e quindi, quando ne crei uno nuovo, puoi configurarne diversi aspetti:
- Nome: inserisci un nome facilmente comprensibile sull'uso di quel webhook (utilizzato solo internamente)
- URL: si tratta del Callback URL, l'URL della pagina che riceve la "chiamata" quando viene inviato un messaggio automatico dal webhook
- Tipo: al momento sono disponibili 4 eventi che fanno scattare l'esecuzione di un webhook:
- Subscribe: un destinatario si è iscritto alla Lista
- Unsubscribe: un destinatario si è disiscritto alla Lista
- Changeprofile: i dati di un destinatario nel suo profilo sono stati modificati incluso, per esempio, il Gruppo di appartenenza
- Delete: un destinatario è stato rimosso dalla Lista
- Sorgente: un evento può accadere in 3 ambienti (sorgenti) diversi:
- API: l'evento è avvenuto grazie a una chiamata API (esempio: un destinatario si è registrato da un modulo che ha eseguito una chiamata API alla console per eseguire la modifica al database)
- Console: l'evento è stato eseguito da qualcuno direttamente dalla console (esempio: un destinatario è stato aggiunto a mano)
- Recipient (Destinatario): l'evento ha registrato un'azione fatta dal destinatario (esempio: il destinatario si è disiscritto)
- Metodo: il metodo utilizzato per eseguire tecnicamente la chiamata che può essere in POST o in GET
- Attivo: se il webhook è attivo oppure no
- Criptato: se il webhook è criptato oppure no (in caso lo fosse dovrai specificare la chiave)
- MailUp utilizza RC4 encryption e la chiave fornita per criptare
- i dati vengono convertiti in codice Base64
- La pagina di ricezione della chiamata - conoscendo al chiave - può facilmente estrarre i dati criptati
- Parametri: i parametri inviati nella chiamata, vedi sotto per i dettagli.
Parametri
I parametri che possono essere inclusi nelle chiamate sono:
- [EventDate]: la data in cui si è verificato l'evento in formato ISO 8601 (esempio.: 2012-09-12T11:18:37.664+02)
- [IdConsole]: l'ID dell'account
- [IdList]: l'ID della Lista
- [IdNL]: l'ID del messaggio
- [EventType]: il tipo di evento
- [EventSource]: la sorgente dell'evento
- [Reason]: la ragione per cui il destinatario si è disiscritto, si applica solamente alla disiscrizione e include il codice che definisce i vari tipi di Bounce
- [Email]: l'indirizzo email del destinatario
- [Prefix]: il prefisso internazionale del numero telefonico del destinatario
- [Number]: il numero telefonico del destinatario
- [Groups]: una lista, separata da virgole, dei Gruppi a cui appartiene il destinatario all'interno di una Lista [IdList]
- [Channel]: canale di comunicazione segnalato da dei codici:0 (Email), 1 (Sms), 2 (Fax), 5 (Social), -1 (Unknown quindi un evento non collegato a un canale)
- Tutti i Campi anagrafici nel formato [Nome] ... [indirizzo]
Limiti dei webhooks
In questo momento non vengono eseguite delle chiamate webhook nel caso di:
- importi massivi
- uso di webservice
I webhook sono applicabili a una Lista specifica e non è al momento possibile creare un webhook da applicare a tutte le Liste. In pochi passi, al momento della creazione di una nuova lista, è possibile copiare un webhook da altre liste esistenti.
Argomenti correlati