📖 Indice
Per iniziare, che cos'è un Webhook ?
Con i Webhook, verrai informato di tutti gli eventi relativi alla firma dei tuoi documenti direttamente dalle soluzioni o dagli strumenti in cui hai integrato l'API.
Concretamente, i Webhook consentono di automatizzare le azioni relative alla firma dei tuoi documenti, come il download automatico dei documenti dopo che sono stati firmati o anche la visualizzazione di notifiche in altri strumenti che un documento è stato firmato su Yousign.
Come accedo ai Webhook a partire dall'applicazione ?
Vai al tuo menu, quindi scegli "Sviluppatori" e fai clic su "Webhook".
Se questo è il tuo primo Webhook, l'interfaccia ti proporrà di creare il tuo primo Webhook. Se hai già Webhook attivi, verranno elencati nell'interfaccia. Basterà cliccare su un Webhook per visualizzarne i dettagli.
Come creare un Webhook ?
Nell'interfaccia dell'applicazione dedicata ai Webhook clicca su “Crea un Webhook”.
Il primo pulsante ti permette di attivare o disattivare immediatamente il Webhook che stai per creare.
Sono quindi necessari 3 passaggi per creare un Webhook Inizia inserendo l'URL dell'endpoint. Questo è l'indirizzo di destinazione del Webhook a cui si desidera inviare l'evento interessato del Webhook.
⚠️ Questo indirizzo deve iniziare con “https://”
Puoi anche aggiungere una breve descrizione del Webhook indicando il motivo per cui lo hai creato. Non è necessario per il funzionamento del Webhook ma le informazioni saranno integrate per conoscenza.
Quindi seleziona l'ambiente del Webhook. Puoi scegliere tra:
Sandbox: l'ambiente di test API, puoi testare il Webhook prima di integrarlo nella produzione
Produzione: l'ambiente in cui è attiva la tua integrazione.
Infine, scegli gli eventi che attiveranno il tuo webhook Puoi scegliere di selezionare tutti gli eventi elencati o selezionare manualmente uno per uno gli eventi desiderati. Potrai scegliere tutti quelli di cui hai necessità.
Sono disponibili 3 tipi di eventi :
Eventi relativi alla richiesta di firma
signature_request.activatedquando lo stato della richiesta di firma cambia da “bozza” a “in corso”signature_request.donequando tutti i firmatari hanno firmato il documentosignature_request.expiredquando la richiesta di firma è scadutasignature_request.reminder_executedquando un promemoria è stato inviato al firmatario per invitarlo a firmare
2. Eventi relativi al firmatario
signer.notifiedun firmatario specifico può firmare il documentosigner.link_openedun firmatario specifico ha aperto il link di invito a firmaresigner.doneuno specifico firmatario ha firmato il documento
3. Eventi relativi ai contatti
contact.createdè stato creato un contatto (tranne i contatti creati a partire da un'importazione di un file .CSV)
Finalizza la creazione del Webhook cliccando su "Crea un Webhook"! Potrai quindi monitorare o modificare il tuo Webhook a partire dall'interfaccia dei Webhooks
💡In caso avessi bisogno di più informazioni, non esitare a consultare la documentazione relativa all’integrazione API visibile: 👉 https://developers.yousign.com/docs/webhooks
