Documentazione

Webhook: Collegare SuperSaaS ad altri servizi web

I webhook sono notifiche HTTP di un evento accaduto in SuperSaaS (trigger) inviate ad altre applicazioni web, che innescano in queste ultime delle azioni conseguenti (action). Il contenuto di tali notifiche è definito dall’utente. I webhook facilitano lo scambio di informazioni tra applicazioni web.

Alcuni esempi di webhook (T=trigger, A=action):

Loghi webhook
  • Quando un nuovo utente si registra sul tuo account SuperSaaS (T) → viene iscritto a una lista di MailChimp (A)
  • Quando un utente in lista d’attesa viene confermato (T) → gli viene inviato un SMS via Pushover (A)
  • Quando un utente inserisce una prenotazione con pagamento (T) → viene generata una fattura in QuickBooks (A)
  • Quando un utente prenota una lezione (T) → l’appuntamento viene inserito nel Google Calendar del docente
  • Quando la prenotazione di un utente in lista d’attesa viene confermata (T) → l’utente riceve una notifica via SMS (A)

Configurare automaticamente i webhook con Zapier.com o Make.com

Puoi utilizzare Zapier.com o Make.com per collegare centinaia di applicazioni e servizi web con SuperSaaS, senza alcun bisogno di competenze tecniche particolari. Sia Zapier che Make offrono versioni di prova e un piano gratuito per piccoli utenti.

Creare webhook dai modelli predefiniti è un’operazione abbastanza semplice, ma se vuoi maggiore controllo sugli eventi che innescano le azioni conseguenti trovi informazioni dettagliate qui sotto.

Nuovo cliente in lista MailChimpNuovo utente → lista MailChimp
Nuovo appuntamento in Google CalendarNuovo appuntamento → Google Calendar
Nuovo appuntamento produce fattura QuickBooksNuovo appuntamento → fattura QuickBooks
Nuovo appuntamento verso filtro emailNuovo appuntamento → filtro email

Trigger supportati

Vi sono svariati eventi che puoi monitorare. Alcuni eventi possono essere monitorati sia come “nuovo” evento che come evento “modificato”. L’evento “modificato” include ogni modifica, quindi si attiva anche in occasione di “nuovo” e “cancella”. Quindi se configuri sia un trigger “Nuovo utente” che un trigger “Utente modificato” entrambi verranno innescati quando si registra un nuovo utente. Nota che se hai configurato il tuo calendario per non richiedere la registrazione degli utenti, non vedrai mai un trigger “Nuovo utente” ma soltanto un trigger “Nuovo appuntamento”.

TriggerCausato da…
New userSi attiva quando un nuovo utente si registra sul tuo account
Changed userSi attiva quando un utente, o l’amministratore per lui, modifica i dati inseriti in sede di registrazione
New appointmentSi attiva quando un utente, o l’amministratore, inserisce un appuntamento in uno specifico calendario
Changed appointmentSi attiva per ogni possibile modifica all’appuntamento, inclusi gli eventi “Nuovo”, “Cancella”, “Confermato da lista d’attesa”, “Pagamento ricevuto”, etc. (vedi sotto la lista completa)
New stand-alone formSi attiva quando viene inviato un modulo personalizzato (utilizzato come componente a sé)
Updated stand-alone formSi attiva per ogni possibile modifica a un modulo personalizzato (utilizzato come componente a sé)
Send mailSi attiva per tutte le email inviate dal tuo account, incluse quelle per il recupero di password smarrite etc. Utile per inviare email dal tuo server. Le email non verranno più inviate da noi se questo webhook è attivo
Reminder
Follow-up
Si attiva in occasione di promemoria e follow-up. Promemoria e email di follow-up non verranno più inviate da noi se questo webhook è attivo
PurchaseSi attiva quando un utente effettua un acquisto nel tuo negozio

Filtrare gli eventi

Quando colleghi due applicazioni web, Zapier e Make ti permettono di filtrare gli eventi. Di seguito alcuni esempi:

  • Invia una notifica SMS solo quando un utente viene confermato dalla lista d’attesa, non inviarla per ogni altra modifica dell’appuntamento
  • Ad ogni nuova iscrizione al corso invia notifica solo al docente che tiene quel corso, ignora le altre iscrizioni sullo stesso calendario
  • Invia notifica al direttore generale solo se la prenotazione ha un valore superiore a 500 euro

Quando crei un nuovo webhook, Zapier/Make ti richiedono di definire un oggetto presente in SuperSaaS. Di tale oggetto vengono elencati i campi disponibili. I campi che verranno inviati dal webhook dipendono da quelli attivi nel tuo account ed eventualmente dalla presenza o meno di un modulo personalizzato. I campi “trigger” e “role” vengono sempre inclusi e possono essere utili per filtrare gli eventi. Per esempio, potresti filtrare soltanto i trigger che contengono il valore “delete” nel campo “event”.

TriggerPossibili valori del campo “event”
New usernew
Changed usernew, change, delete
New appointmentcreate
Changed appointmentcreate, edit, place, pending, destroy, restore, approve, revert
New formnew
Changed formnew, change, delete, restore
Reminder / Follow-upreminder, follow_up
Purchasepurchase

Campo “Role”Chi ha attivato l’evento…
0AnonimoNon loggato
1Loggato con password condivisa
2Validato con verifica di intervallo IP
3Utente standard
4Superuser
5Amministratore o Rivenditore
7Sistema o Gateway di pagamento

Configurazione manuale dei webhook (avanzato)

Creare un webhook senza l’aiuto di Zapier o Make richiede alcune competenze di sviluppo web. Puoi configurare i webhook in modo che vengano inviati direttamente al tuo server, o in modo che venga modificato il payload che contengono. Ulteriori dettagli sono disponibili nella documentazione sui webhook per sviluppatori.