Configurare un nuovo webhook

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. 

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:

Invia in modalità collettiva:

Moduli Web:

Modelli libreria (solo API):

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.