Webhook Legacy su Legalesign

Cosa sono i webhook legacy

I webhook legacy sono il nostro vecchio sistema di webhook. Se stai pensando di usare i webhook per la prima volta, utilizza il sistema più recente - new webhooks

Continueremo a supportare i webhook legacy per il prevedibile futuro per garantire la compatibilità retroattiva. Se ciò dovesse cambiare, riceverai un ampio preavviso. In ogni caso, ti consigliamo di effettuare l’aggiornamento: i webhook in tempo reale vengono attivati per più eventi, contengono informazioni più utili, possono essere filtrati più efficacemente e si verificano più rapidamente.

Tipi di webhook

Ci sono due tipi di webhook legacy.

• All’[evento] (deprecato)
• Tutti gli eventi ogni 6 minuti (deprecato)

Come aggiungere o rimuovere un webhook

Aggiungere o rimuovere tramite l’app web

Vai su impostazioni e vedrai il pannello dei webhook. Il modulo ha controlli semplici per aggiungere o rimuovere i webhook

pericolo

La tua chiave API si basa sul tuo account e non su un gruppo o organizzazione individuale. Questo dà alla tua chiave API maggiore flessibilità, ma i tuoi webhook riceveranno informazioni da tutti gli account in cui sei amministratore, sia di sviluppo che di produzione. Per differenziare i webhook per gruppo, usa il filtro oppure (il metodo vecchio) crea un nuovo utente amministratore membro solo del gruppo/i target, ottieni una chiave API per lui e usa quell’account per il tuo webhook.

Aggiungere o rimuovere tramite l’API

Usa semplici richieste GET e POST tramite l’API REST per elencare, creare o eliminare webhook.

Per ulteriori informazioni vedi la documentazione: API webhooks

Il formato di un webhook 'All’evento ...'

Questi sono webhook attivati per un evento specifico - firma, creazione, rifiuto, o visita fallita.

Questi vengono consegnati come richieste POST al tuo url.

Contengono il nome del documento, il codice evento, l’URI della risorsa, tag e uuid del documento. Ecco la stampa da ngrok.

Il formato di un webhook di aggiornamento generale / ogni 6 minuti

La chiamata ogni 6 minuti appare così:

Come puoi vedere, è anche una richiesta POST. Ma questa volta tutte le informazioni sono memorizzate nell’attributo POST 'data' come oggetto JSON.

Ecco quell’oggetto JSON in dettaglio:

[
  {
    "value": "5",
    "timestamp": "2022-07-11T07:28:25+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "10",
    "timestamp": "2022-07-11T07:28:26+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "20",
    "timestamp": "2022-07-11T07:28:55+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "20",
    "timestamp": "2022-07-11T07:29:06+00:00",
    "resource_uri": "/api/v1/document/6619179c-95da-4d5c-b7be-7bac0bac4088/",
    "name": "status"
  },
  {
    "value": "30",
    "timestamp": "2022-07-11T07:29:06+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "40",
    "timestamp": "2022-07-11T07:29:06+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "30",
    "timestamp": "2022-07-11T07:29:06+00:00",
    "resource_uri": "/api/v1/document/6619179c-95da-4d5c-b7be-7bac0bac4088/",
    "name": "status"
  },
  {
    "value": "100",
    "timestamp": "2022-07-11T07:29:09+00:00",
    "resource_uri": "/api/v1/document/6619179c-95da-4d5c-b7be-7bac0bac4088/",
    "name": "status"
  }
]

Cosa sta succedendo qui? Il webhook di aggiornamento generale ora ti fornisce tutti i dettagli su cosa è successo nella firma di un documento e quando. Include aggiornamenti di eventi sia per un firmatario che per un documento.

avvertimento

Avrai notato che usiamo le parole 'recipient' e 'signer'. Sono intercambiabili. L’uso di recipient riflette i ruoli più complessi ora disponibili in Legalesign e sarà il nuovo nome per 'signer' man mano che svilupperemo.

La storia di questi dati webhook è che l’oggetto firmatario è stato creato (firmatario 5), inviato (firmatario 10), il firmatario ha completato il suo campo (firmatario 30), e ha firmato (firmatario 40), il documento ha notato che i suoi campi erano completi (documento 20), è stato poi marcato come firmato (documento 30), e quindi pronto per il download (documento 100).

'100' è un codice evento speciale che conferma che un documento è pronto per il download.

Stato del documento

Stato	Spiegazione
10	Inviato
20	Campi completati
30	Completo
40	Rimosso (prima della firma)
50	Rifiutato

Stato del firmatario

Stato	Spiegazione
4	Non inviato
5	Programmato per invio
10	Inviato
15	Email aperta
20	Visitato
30	Campi completati
35	Campi completati tranne quelli della firma
39	Testimone per firmare
40	Completato
50	Scaricato
60	Rifiutato

Debug dei webhook nel dashboard API

Tutti i webhook sono registrati e puoi esaminare il loro contenuto e il codice di stato http nel tuo dashboard API. Per saperne di più consulta il tutorial sul Dashboard

Vai direttamente al dashboard API.

Contattaci

Questo dovrebbe coprire tutto ciò che devi sapere sui webhook legacy.

Se hai altre domande, contattaci pure - support.legalesign.com.