Guida utente Annulla

Configurare un nuovo webhook

Guida di Adobe Acrobat Sign

Novità

Introduzione

Amministrazione

Inviare, firmare e gestire gli accordi

Funzionalità e flussi di lavoro avanzati per gli accordi

Integrazione con altri prodotti

Acrobat Sign per sviluppatori

Supporto e risoluzione dei problemi

Opzioni di configurazione

La configurazione del webhook richiede la definizione di cinque elementi:

  • Nome: scegli un nome intuitivo che gli altri amministratori possano riconoscere facilmente.
  • Ambito: ampiezza della rete che deve essere coperta dal webhook Nell’interfaccia sono disponibili gli ambiti Account e Gruppo.
    • L’API supporta gli ambiti Account, Gruppo, Utente e Risorsa.
    • È possibile definire un solo ambito per webhook.
  • URL: l’URL di destinazione a cui Acrobat Sign ha trasmesso il payload JSON.
  • Eventi: il trigger in risposta al quale Acrobat Sign genera il codice JSON e lo trasmette all’URL.
    • Ogni evento crea un payload diverso relativo all’evento trigger.
    • In un webhook si possono includere più Eventi.
  • Parametri di notifica: la proprietà Parametri di notifica identifica le sezioni del payload dell’Evento JSON, consentendoti di selezionare solo le sezioni dell’Evento che sono importanti per questo webhook, riducendo così i dati non necessari inviati all’URL.

Una volta definito il webhook, fai clic su Salva: il nuovo webhook inizierà subito a reagire agli eventi trigger. 

Nota:

Configura l’URL del webhook affinché risponda alle richieste di verifica e notifica del webhook in base al protocollo di verifica descritto in precedenza. L’ID client (ID applicazione) che verrà inviato ai webhook creati dall’applicazione Web Acrobat Sign sarà - UB7E5BXCXY

Configurare il webhook

Ambiti

  • Account: tutti gli eventi di abbonamento che si verificano nell’account attivano il push.
    • Gli amministratori degli account possono visualizzare tutti i webhook definiti per l’account e tutti i gruppi all’interno di quell’account.
  • Gruppo: tutti gli eventi di abbonamento che si verificano in quel gruppo attivano il push. NOTA: I webhook con ambito di gruppo esistono solo per quel gruppo.
    • Gli amministratori dei gruppi possono visualizzare solo i webhook del proprio gruppo. Non possono visualizzare i webhook a livello di account o associati ad altri gruppi.
    • Gli account per i quali è attivata l’opzione Utenti in più gruppi visualizzeranno l’opzione per impostare il gruppo a cui deve essere applicato l’ambito.
  • Account utente: tutti gli eventi di abbonamento per un account utente attivano il push. I webhook a livello di utente possono essere creati solo tramite API.
  • Webhook a livello di risorsa: verrà creato per una risorsa specifica. Gli eventi specifici di questa risorsa verranno inviati all’URL del webhook. I webhook a livello di risorsa possono essere creati solo tramite API.

URL

Un URL webhook è un server che intercetta i messaggi di notifica HTTPS POST in entrata che vengono attivati quando si verificano eventi.

Per iscriversi al webhook degli eventi, è necessario questo URL.

  • Il client deve includere un URL HTTPS dove Acrobat Sign può POST. Questo URL deve essere disponibile su Internet.  
    • Ad esempio, gli URI 127.0.0.1 e localhost non funzioneranno.
    • L'endpoint dell’URL deve essere in ascolto sulla porta 443 o 8443 (deciso dal cliente durante la definizione dell’URL di richiamata).
  • Assicurati che il webhook supporti le richieste POST per le notifiche degli eventi in arrivo e le richieste GET per la richiesta di verifica.
  • L'URL non deve essere bloccato da un firewall.

Eventi

Di seguito sono riportati gli eventi che possono attivare un push all’URL del webhook, raggruppati per oggetto ed elencati nell’ordine trovato nell’interfaccia utente.

Il valore a sinistra è il valore che verrà visualizzato nell’interfaccia utente di Acrobat Sign. Il valore a destra è il nome del webhook all’interno dell’API.

Per informazioni complete sui webhook e i relativi payload, consultare la Guida per sviluppatori di Acrobat Sign.

Gli accordi:

Elemento interfaccia utente Nome webhook
Tutti gli eventi dell’accordo AGREEMENT_ALL
Accordo creato AGREEMENT_CREATED
Accordo inviato AGREEMENT_ACTION_REQUESTED
Partecipante accordo completato AGREEMENT_ACTION_COMPLETED
Flusso di lavoro accordo completato AGREEMENT_WORKFLOW_COMPLETED
Accordo scaduto AGREEMENT_EXPIRED
Accordo eliminato AGREEMENT_DOCUMENTS_DELETED
Accordo annullato AGREEMENT_RECALLED
Accordo rifiutato AGREEMENT_REJECTED
Accordo condiviso AGREEMENT_SHARED
Accordo non più condiviso AGREEMENT_UNSHARE
Accordo non condiviso in automatico AGREEMENT_UNSHARE_AUTO
Accordo delegato AGREEMENT_ACTION_DELEGATED
Partecipante accordo sostituito AGREEMENT_ACTION_REPLACED_SIGNER
Accordo modificato AGREEMENT_MODIFIED
Modifica accordo confermata AGREEMENT_USER_ACK_AGREEMENT_MODIFIED
E-mail accordo visualizzata AGREEMENT_EMAIL_VIEWED
E-mail accordo non recapitata AGREEMENT_EMAIL_BOUNCED
Documento accordo visualizzato AGREEMENT_DOCUMENTS_VIEWED
Documento dell’accordo visualizzato quando è stata applicata una password per la visualizzazione AGREEMENT_DOCUMENTS_VIEWED_PASSWORD_PROTECTED
Creazione dell’accordo non riuscita AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM
Accordo sincronizzato dopo evento offline AGREEMENT_OFFLINE_SYNC
Accordo archiviato AGREEMENT_VAULTED
Identità social partecipante autenticata AGREEMENT_WEB_IDENTITY_AUTHENTICATED
Identità partecipante verificata da autenticazione KBA AGREEMENT_KBA_AUTHENTICATED
Partecipante accordo autenticato tramite e-mail con OTP
AGREEMENT_EMAIL_OTP_AUTHENTICATED
Scadenza accordo aggiornata AGREEMENT_EXPIRATION_UPDATED
Promemoria accordo inviato AGREEMENT_REMINDER_SENT
Nome del firmatario dell’accordo modificato dal firmatario AGREEMENT_SIGNER_NAME_CHANGED_BY_SIGNER
Promemoria del documento creato AGREEMENT_REMINDER_INITIATED
   
Webhook degli accordi disponibili solo tramite API
Elemento interfaccia utente Nome webhook
N/A
AGREEMENT_READY_TO_NOTARIZE
N/A
AGREEMENT_READY_TO_VAULT

 

Invia in modalità collettiva:

Elemento interfaccia utente Nome webhook
Invio in modalità collettiva - Tutti gli eventi MEGASIGN_ALL
Invio in modalità collettiva creato
MEGASIGN_CREATED
Invio in modalità collettiva condiviso
MEGASIGN_SHARED
Invio in modalità collettiva richiamato
MEGASIGN_RECALLED
Promemoria inviato per invio in modalità collettiva MEGASIGN_REMINDER_SENT
Promemoria creato per invio in modalità collettiva MEGASIGN_REMINDER_INITIATED

 

Moduli Web:

Elemento interfaccia utente Nome webhook
Modulo web - Tutti gli eventi WIDGET_ALL
Modulo Web creato
WIDGET_CREATED
Modulo Web abilitato
WIDGET_ENABLED
Modulo Web disabilitato
WIDGET_DISABLED
Modulo Web modificato
WIDGET_MODIFIED
Modulo Web condiviso
WIDGET_SHARED
Creazione modulo Web non riuscita
WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM

 

Modelli libreria (solo API):

Elemento interfaccia utente Nome webhook
N/A LIBRARY_DOCUMENT_ALL
N/A LIBRARY_DOCUMENT_CREATED
N/A LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM
N/A LIBRARY_DOCUMENT_MODIFIED

 

Parametri di notifica

I parametri di notifica consentono di personalizzare il payload JSON solo per elementi specifici dell’evento.

Ad esempio, in un evento di tipo Partecipante all’accordo sostituito, è possibile richiedere solo le proprietà Informazioni accordo e Informazioni partecipante, escludendo Informazioni documento e riducendo il volume totale del JSON nell’URL del webhook.

 

  • Accordo
    • Informazioni accordo: informazioni dettagliate in base allo stato dell’accordo al momento dell’evento di attivazione.
    • Informazioni documento accordo: include tutte le informazioni sul documento generate a seguito dell’evento.
    • Informazioni sul partecipante all’accordo: include le informazioni sui partecipanti risultanti dall’evento.
    • Documento accordo firmato: fornisce il PDF firmato. 
      • Applicabile a eventi Flusso di lavoro accordo completato e Tutti gli accordi.
  • Invia in modalità collettiva
    • Invia in modalità collettiva: informazioni dettagliate sull’oggetto Invia in modalità collettiva che ha attivato l’evento.
  • Modulo web
    • Informazioni sul Widget: informazioni dettagliate sul modulo web che ha attivato l’evento.
    • Widget informazioni documento: informazioni sul documento associate al modello di modulo web.
    • Widget informazioni partecipante: informazioni sui partecipanti definiti nel modello di modulo web.

Ottieni supporto in modo più facile e veloce

Nuovo utente?