Condividi tramite

SignatureAPI

Inviare documenti per la firma, tenere traccia dello stato di avanzamento e lavorare più velocemente con SignatureAPI, la piattaforma di firma elettronica creata per l'automazione. https://signatureapi.com/docs/integrations/power-automate/getting-started

Questo connettore è disponibile nei prodotti e nelle aree seguenti:

Servizio Class Regions
Copilot Studio Di alta qualità Tutte le aree di Power Automate , ad eccezione delle seguenti:
     - Governo degli Stati Uniti (GCC)
     - Us Government (GCC High)
     - China Cloud gestito da 21Vianet
     - Dipartimento della Difesa degli Stati Uniti (DoD)
App per la logica Normale Tutte le aree di App per la logica , ad eccezione delle seguenti:
     - Aree di Azure per enti pubblici
     - Aree di Azure Cina
     - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Apps Di alta qualità Tutte le aree di Power Apps , ad eccezione dei seguenti:
     - Governo degli Stati Uniti (GCC)
     - Us Government (GCC High)
     - China Cloud gestito da 21Vianet
     - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Automate Di alta qualità Tutte le aree di Power Automate , ad eccezione delle seguenti:
     - Governo degli Stati Uniti (GCC)
     - Us Government (GCC High)
     - China Cloud gestito da 21Vianet
     - Dipartimento della Difesa degli Stati Uniti (DoD)
Contatto
Nome API signature, Inc.
URL https://signatureapi.com
Email support@signatureapi.com
Metadati del connettore
Editore SignatureAPI
Sito web https://signatureapi.com/power-automate
Informativa sulla privacy https://signatureapi.com/privacy
Categorie Collaborazione; Produttività

SignatureAPI

SignatureAPI è una piattaforma di firma elettronica creata per l'automazione.

Inviare documenti per la firma e tenere traccia dello stato di avanzamento usando la piattaforma di e-signature per Power Automate, che fornisce varie azioni e trigger che consentono di creare flussi di lavoro semplici e complessi.

Le firme elettroniche fatte con SignatureAPI sono legalmente vincolanti e accettate a livello globale, proprio come le firme di inchiostro tradizionali nella maggior parte delle giurisdizioni.

SignatureAPI offre prezzi convenienti per l'automazione a volumi elevati. Vedere i dettagli sui prezzi.

Funzionalità principali

  • Più destinatari: inviare documenti a un massimo di 10 firmatari in una singola transazione.
  • Firma parallela o sequenziale: scegliere di inviare documenti a tutti i destinatari contemporaneamente o in un ordine specifico.
  • Modelli di documento: generare documenti a livello di codice usando modelli e dati dinamici.
  • Lingue e localizzazione: personalizzare l'interfaccia di firma con lingue diverse, formati di data e ora e fusi orari.
  • Firma senza account: consente ai destinatari di firmare i documenti senza creare o accedere a un account.
  • Log di controllo: consente di gestire un log dettagliato dell'accesso ai documenti, della revisione e degli eventi di firma.
  • Correzione antimanomissione: garantire l'integrità del documento con la firma post-firma di prova verificata e irrefutabile.
  • Tenere traccia delle buste: monitorare lo stato di avanzamento della firma tramite un dashboard intuitivo.
  • Real-Time Notifiche: ricevere aggiornamenti istantanei sulle attività di firma tramite posta elettronica e webhook.

Prerequisiti

Per usare questo connettore, iscriversi a un account SignatureAPI e generare una chiave API. Ottenere una chiave API di test gratuita e configurare la connessione.

Come iniziare

Il flusso di lavoro più comune prevede l'invio di uno o più documenti ai destinatari per la firma. I destinatari ricevono un messaggio di posta elettronica con un collegamento per accedere all'interfaccia di firma.

SignatureAPI supporta flussi di lavoro avanzati. Esplorare le guide ai connettori per istruzioni dettagliate, casi d'uso e strategie di automazione.

Passaggio 1: Creare una busta

Per iniziare, creare una busta vuota. Una busta è un contenitore che contiene documenti e gestisce il processo di firma.

Le opzioni includono:

Passaggio 2: Aggiungere destinatari

Specificare chi deve firmare i documenti aggiungendo i destinatari alla busta. Attualmente sono supportati solo i firmatari, ma in futuro saranno disponibili altri tipi di destinatari.

Passaggio 3: Aggiungere documenti

Aggiungere i documenti che richiedono firme alla busta. È possibile caricare file PDF o DOCX o generare documenti da modelli usando dati.

Passaggio 4: Definire posizioni nei documenti

Le posizioni sono aree designate all'interno di un documento in cui un destinatario interagisce, ad esempio firma, specificando le iniziali o aggiungendo testo. Possono anche contenere valori statici o calcolati, ad esempio date di completamento.

Passaggio 5: Avviare il processo di firma

Dopo aver preparato completamente la busta, avviare il processo di firma.

Passaggio 6: Attendere il completamento della busta

Per mantenere l'intero flusso di lavoro nello stesso flusso, è possibile attendere il completamento della busta. In questo modo tutti i destinatari hanno firmato e viene generato il risultato finale (documento firmato).

In alternativa, è possibile attivare un flusso di lavoro separato al termine della busta e generare il risultato finale.

Passaggio 7: Recuperare il documento firmato

Al termine del processo, recuperare il documento firmato (risultato finale).

Uso dei trigger

SignatureAPI offre trigger per automatizzare i flussi di lavoro e semplificare i processi. Informazioni sull'elenco completo dei trigger e su come usarli.

Trigger di uso comune

Quando viene generato un risultato finale

Attivato al termine della busta e il documento firmato (risultato finale) è pronto.

Quando un destinatario completa una busta

Attivato ogni volta che un destinatario completa la parte del processo di firma.

Quando un messaggio di posta elettronica destinatario rimbalza

Attivato quando l'indirizzo di posta elettronica di un destinatario non può ricevere la richiesta.

Problemi noti e limitazioni

Errori e soluzioni comuni

  • Verificare che l'azione Ottieni un risultato finale venga eseguita dopo l'azione Attendi busta . I risultati finali sono disponibili solo dopo che tutti i destinatari hanno completato la loro parte.
  • Se si passa da una chiave API di test a una chiave API dinamica, aggiornare il trigger per assicurarsi che il webhook venga creato nell'ambiente corretto (live o test). Per informazioni dettagliate, vedere la guida alla risoluzione dei problemi .

Creazione di una connessione

Il connettore supporta i tipi di autenticazione seguenti:
Predefinita Parametri per la creazione della connessione. Tutte le aree geografiche Non condivisibile

Predefinito

Applicabile: tutte le aree

Parametri per la creazione della connessione.

Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.

Nome TIPO Description Obbligatorio
Chiave API securestring Chiave API per l'account SignatureAPI. Vero

Limiti per la limitazione delle richieste

Nome Chiamate Periodo di rinnovo
Chiamate API per connessione 100 60 secondi

Azioni

Aggiungere dati al modello

Aggiunge dati a un modello. https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data
Aggiungere un destinatario - Firmatario

Aggiunge un destinatario a una busta. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient
Aggiungere un documento - DOCX

Aggiunge un documento DOCX a una busta. https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx
Aggiungere un documento - PDF

Aggiunge un documento PDF a una busta. https://signatureapi.com/docs/integrations/power-automate/actions/add-document
Aggiungere un modello - DOCX

Aggiunge un modello DOCX a una busta. https://signatureapi.com/docs/integrations/power-automate/actions/add-template
Aggiungere un posto - Firma

Aggiunge un punto di firma a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place
Aggiungere un posto - Iniziali

Aggiunge una posizione iniziale a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place
Aggiungere una posizione - Data di completamento busta

Aggiunge una data di completamento busta a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place
Aggiungere una posizione - Data di completamento del destinatario

Aggiunge una data di completamento del destinatario a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place
Aggiungere una posizione - Input di testo

Aggiunge una posizione di input di testo a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place
Aggiungere una posizione - Testo

Aggiunge una posizione di testo a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place
Attendere la busta

Attende che una busta raggiunga uno stato completato o un altro stato finale. https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope
Avviare una busta

Avvia il processo di firma per una busta. https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope
Creare una busta

Crea una nuova busta a cui è possibile aggiungere destinatari e documenti. Quando si è pronti, usare l'azione "Avvia busta" per avviare il processo di firma. https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope
Creare una cerimonia - Autenticazione del collegamento tramite posta elettronica

Crea una cerimonia in cui il destinatario viene autenticato tramite un collegamento inviato al messaggio di posta elettronica. https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link
Creare una cerimonia - Autenticazione personalizzata

Crea una cerimonia in cui il destinatario viene autenticato esternamente in SignatureAPI. Usa questa opzione per ottenere un URL di cerimonia per la condivisione con i destinatari. Prima di usare l'autenticazione personalizzata letta https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom
Eliminare una busta

Elimina una busta e tutte le informazioni associate. https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope
Ottenere un destinatario

Recupera i dettagli del destinatario in base al relativo ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient
Ottenere un risultato finale

Recupera un risultato finale usando il relativo ID. Usarlo per scaricare una copia firmata della busta. https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable
Ottenere un valore acquisito

Recupera un valore immesso da un destinatario in un luogo di input durante la firma. https://signatureapi.com/docs/integrations/power-automate/actions/get-capture
Ottenere una busta

Recupera i dettagli della busta in base al relativo ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope

Aggiungere dati al modello

ID operazione:
AddTemplateData

Aggiunge dati a un modello. https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data

Parametri

Nome Chiave Necessario Tipo Descrizione
ID documento
 documentId True string

ID del documento.
Nome campo
 field_name True string

Nome del campo nel modello.
Value
 value True string

Valore per il campo nel modello.

Aggiungere un destinatario - Firmatario

ID operazione:
AddRecipient

Aggiunge un destinatario a una busta. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient

Parametri

Nome Chiave Necessario Tipo Descrizione
ID busta
 envelopeId True string

ID della busta.
Nome destinatario
 name True string

Nome del destinatario.
Messaggio di posta elettronica destinatario
 email True string

Indirizzo di posta elettronica del destinatario.
Chiave destinatario
 key True string

Chiave che identifica un destinatario all'interno di una busta.
Creazione della cerimonia del destinatario
 ceremony_creation string

Come vengono create le cerimonie per un destinatario.
Tipo di recapito destinatario
 delivery_type string

Modalità di invio del risultato finale al destinatario.
Proprietà aggiuntive
 extra string

Proprietà aggiuntive per l'estendibilità

Restituisce

Corpo
AddRecipientSignerOutput

Aggiungere un documento - DOCX

ID operazione:
AddDocumentDocx

Aggiunge un documento DOCX a una busta. https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx

Parametri

Nome Chiave Necessario Tipo Descrizione
ID busta
 envelopeId True string

ID della busta.
Titolo documento
 title string

Titolo del documento. Può essere visualizzato ai destinatari.
Contenuto del file
 file_content True byte

Contenuto del file di documento.
Proprietà aggiuntive
 extra string

Proprietà aggiuntive per l'estendibilità

Restituisce

Corpo
AddDocumentOutput

Aggiungere un documento - PDF

ID operazione:
AddDocument

Aggiunge un documento PDF a una busta. https://signatureapi.com/docs/integrations/power-automate/actions/add-document

Parametri

Nome Chiave Necessario Tipo Descrizione
ID busta
 envelopeId True string

ID della busta.
Titolo documento
 title string

Titolo del documento. Può essere visualizzato ai destinatari.
Contenuto del file
 file_content True byte

Contenuto del file di documento.
Proprietà aggiuntive
 extra string

Proprietà aggiuntive per l'estendibilità

Restituisce

Corpo
AddDocumentOutput

Aggiungere un modello - DOCX

ID operazione:
AddTemplate

Aggiunge un modello DOCX a una busta. https://signatureapi.com/docs/integrations/power-automate/actions/add-template

Parametri

Nome Chiave Necessario Tipo Descrizione
ID busta
 envelopeId True string

ID della busta.
Titolo documento
 title string

Titolo del documento. Può essere visualizzato ai destinatari.
Contenuto del file
 file_content True byte

Contenuto del file di documento.
Dati modello
 data array of string

Campo: coppia valore contenente i dati da compilare nel modello.
Proprietà aggiuntive
 extra string

Proprietà aggiuntive per l'estendibilità

Restituisce

Corpo
AddDocumentOutput

Aggiungere un posto - Firma

ID operazione:
AddPlaceSignature

Aggiunge un punto di firma a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place

Parametri

Nome Chiave Necessario Tipo Descrizione
ID documento
 documentId True string

ID del documento.
Inserisci chiave
 key True string

Chiave che identifica questa posizione all'interno del documento.
Chiave destinatario
 recipient_key True string

La chiave del destinatario si riferisce a questa posizione.
Altezza posizione
 height number

Impostare un'altezza personalizzata, la larghezza viene modificata proporzionalmente.
Numero pagina
 page number

Numero di pagina in cui posizionare questa posizione.
Distanza dall'alto
 top number

Distanza, espressa in punti, dalla parte superiore della pagina alla fine del luogo.
Distanza da sinistra
 left number

Distanza, espressa in punti, dalla parte sinistra della pagina alla posizione.
Proprietà aggiuntive
 extra string

Proprietà aggiuntive per l'estendibilità

Aggiungere un posto - Iniziali

ID operazione:
AddPlaceInitials

Aggiunge una posizione iniziale a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place

Parametri

Nome Chiave Necessario Tipo Descrizione
ID documento
 documentId True string

ID del documento.
Inserisci chiave
 key True string

Chiave che identifica questa posizione all'interno del documento.
Chiave destinatario
 recipient_key True string

La chiave del destinatario si riferisce a questa posizione.
Altezza posizione
 height number

Impostare un'altezza personalizzata, la larghezza viene modificata proporzionalmente.
Numero pagina
 page number

Numero di pagina in cui posizionare questa posizione.
Distanza dall'alto
 top number

Distanza, espressa in punti, dalla parte superiore della pagina alla fine del luogo.
Distanza da sinistra
 left number

Distanza, espressa in punti, dalla parte sinistra della pagina alla posizione.
Proprietà aggiuntive
 extra string

Proprietà aggiuntive per l'estendibilità

Aggiungere una posizione - Data di completamento busta

ID operazione:
AddPlaceEnvelopeCompletedDate

Aggiunge una data di completamento busta a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place

Parametri

Nome Chiave Necessario Tipo Descrizione
ID documento
 documentId True string

ID del documento.
Inserisci chiave
 key True string

Chiave che identifica questa posizione all'interno del documento.
Formato data
 date_format string

Definisce il formato della data e dell'ora. Per i valori consentiti, vedere la documentazione.
Numero pagina
 page number

Numero di pagina in cui posizionare questa posizione.
Distanza dall'alto
 top number

Distanza, espressa in punti, dalla parte superiore della pagina alla fine del luogo.
Distanza da sinistra
 left number

Distanza, espressa in punti, dalla parte sinistra della pagina alla posizione.
Proprietà aggiuntive
 extra string

Proprietà aggiuntive per l'estendibilità

Aggiungere una posizione - Data di completamento del destinatario

ID operazione:
AddPlaceRecipientCompletedDate

Aggiunge una data di completamento del destinatario a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place

Parametri

Nome Chiave Necessario Tipo Descrizione
ID documento
 documentId True string

ID del documento.
Inserisci chiave
 key True string

Chiave che identifica questa posizione all'interno del documento.
Chiave destinatario
 recipient_key True string

La chiave del destinatario si riferisce a questa posizione.
Formato data
 date_format string

Definisce il formato della data e dell'ora. Per i valori consentiti, vedere la documentazione.
Numero pagina
 page number

Numero di pagina in cui posizionare questa posizione.
Distanza dall'alto
 top number

Distanza, espressa in punti, dalla parte superiore della pagina alla fine del luogo.
Distanza da sinistra
 left number

Distanza, espressa in punti, dalla parte sinistra della pagina alla posizione.
Proprietà aggiuntive
 extra string

Proprietà aggiuntive per l'estendibilità

Aggiungere una posizione - Input di testo

ID operazione:
AddPlaceTextInput

Aggiunge una posizione di input di testo a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place

Parametri

Nome Chiave Necessario Tipo Descrizione
ID documento
 documentId True string

ID del documento.
Inserisci chiave
 key True string

Chiave che identifica questa posizione all'interno del documento.
Chiave destinatario
 recipient_key True string

La chiave del destinatario si riferisce a questa posizione.
Acquisisci come
 capture_as string

Chiave che archivia l'input del destinatario ed è inclusa nelle acquisizioni della busta.
Hint
 hint string

Messaggio di descrizione comando visualizzato sul campo di input per il destinatario.
Rapido
 prompt string

Messaggio segnaposto visualizzato all'interno del campo di testo di input durante la cerimonia di firma.
Requisito
 requirement string

Specifica se il destinatario deve compilare questo campo per completare la cerimonia di firma.
Formato
 format string

Specifica il formato valido per l'input dell'utente. Per i valori consentiti, vedere la documentazione.
Formato messaggio
 format_message string

Messaggio visualizzato quando l'input dell'utente non corrisponde al formato richiesto.
Numero pagina
 page number

Numero di pagina in cui posizionare questa posizione.
Distanza dall'alto
 top number

Distanza, espressa in punti, dalla parte superiore della pagina alla fine del luogo.
Distanza da sinistra
 left number

Distanza, espressa in punti, dalla parte sinistra della pagina alla posizione.
Proprietà aggiuntive
 extra string

Proprietà aggiuntive per l'estendibilità

Aggiungere una posizione - Testo

ID operazione:
AddPlaceText

Aggiunge una posizione di testo a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place

Parametri

Nome Chiave Necessario Tipo Descrizione
ID documento
 documentId True string

ID del documento.
Inserisci chiave
 key True string

Chiave che identifica questa posizione all'interno del documento.
Value
 value True string

Valore per questa posizione di testo.
Dimensioni carattere
 font_size number

Dimensione del carattere espressa in punti.
Colore carattere
 font_color string

Colore del carattere nella notazione esadecimale.
Numero pagina
 page number

Numero di pagina in cui posizionare questa posizione.
Distanza dall'alto
 top number

Distanza, espressa in punti, dalla parte superiore della pagina alla fine del luogo.
Distanza da sinistra
 left number

Distanza, espressa in punti, dalla parte sinistra della pagina alla posizione.
Proprietà aggiuntive
 extra string

Proprietà aggiuntive per l'estendibilità

Attendere la busta

ID operazione:
WaitEnvelope

Attende che una busta raggiunga uno stato completato o un altro stato finale. https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope

Parametri

Nome Chiave Necessario Tipo Descrizione
ID busta
 envelopeId True string

ID della busta.

Restituisce

Corpo
Envelope

Avviare una busta

ID operazione:
StartEnvelope

Avvia il processo di firma per una busta. https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope

Parametri

Nome Chiave Necessario Tipo Descrizione
ID busta
 envelopeId True string

ID della busta.

Restituisce

Corpo
StartEnvelopeOutput

Creare una busta

ID operazione:
CreateEnvelope

Crea una nuova busta a cui è possibile aggiungere destinatari e documenti. Quando si è pronti, usare l'azione "Avvia busta" per avviare il processo di firma. https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope

Parametri

Nome Chiave Necessario Tipo Descrizione
Titolo busta
 title True string

Titolo della busta. Può essere visualizzato ai destinatari.
Etichetta busta
 label string

Etichetta personalizzata assegnata alla busta per facilitare l'identificazione. Le etichette sono destinate all'uso interno e non vengono visualizzate ai destinatari.
Messaggio busta
 message string

Messaggio che verrà inviato ai destinatari.
Modalità busta
 mode string

Le buste in modalità test non sono vincolanti e non fatturate.
Routing busta
 routing string

Ordine in cui i destinatari firmano la busta. Può essere parallela, in cui tutti i destinatari possono firmare simultaneamente, o sequenziale, in cui i destinatari firmano uno dopo l'altro.
Language
 language string

Lingua predefinita da utilizzare nella cerimonia di firma e nei risultati finali. Se non specificato, viene usata la lingua predefinita dell'account. https://signatureapi.com/docs/localization/language
Fuso orario
 timezone string

Fuso orario da usare per i timestamp nei risultati finali. Se non specificato, viene usato l'offset di fuso orario predefinito dell'account. https://signatureapi.com/docs/localization/timezone
Formato timestamp
 timestamp_format string

Formato di data e ora da usare nei timestamp per i risultati finali. Se non specificato, viene usato il formato timestamp predefinito dell'account. https://signatureapi.com/docs/localization/timestamp_format
Attestazione busta
 attestation string

Attestazione di conformità o normativa
Nome
 name string

Nome del mittente.
Email
 email string

Indirizzo di posta elettronica del mittente.
Argomenti relativi alle buste
 topics array of string

Usare per classificare le buste e filtrare le notifiche webhook.
Proprietà aggiuntive
 extra string

Proprietà aggiuntive per l'estendibilità

Restituisce

Corpo
CreateEnvelopeOutput

Creare una cerimonia - Autenticazione del collegamento tramite posta elettronica

ID operazione:
CreateCeremonyEmailLink

Crea una cerimonia in cui il destinatario viene autenticato tramite un collegamento inviato al messaggio di posta elettronica. https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link

Parametri

Nome Chiave Necessario Tipo Descrizione
ID destinatario
 recipientId True string

ID del destinatario.
URL di reindirizzamento
 redirect_url string

URL a cui reindirizzare il destinatario al termine di una cerimonia. Per altre informazioni, vedere: https://signatureapi.com/docs/resources/ceremonies/redirect-url
Proprietà aggiuntive
 extra string

Proprietà aggiuntive per l'estendibilità

Restituisce

response
object

Creare una cerimonia - Autenticazione personalizzata

ID operazione:
CreateCeremonyCustom

Crea una cerimonia in cui il destinatario viene autenticato esternamente in SignatureAPI. Usa questa opzione per ottenere un URL di cerimonia per la condivisione con i destinatari. Prima di usare l'autenticazione personalizzata letta https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom

Parametri

Nome Chiave Necessario Tipo Descrizione
ID destinatario
 recipientId True string

ID del destinatario.
Provider di autenticazione
 provider True string

Nome del provider di autenticazione. Questo valore è arbitrario e verrà visualizzato nei log di controllo della busta.
Dati di autenticazione
 data True array of string

Chiave: coppia valore contenente i metadati di autenticazione. Questi dettagli verranno inclusi nei log di controllo della busta.
URL di reindirizzamento
 redirect_url string

URL a cui reindirizzare il destinatario al termine di una cerimonia. Per altre informazioni, vedere: https://signatureapi.com/docs/resources/ceremonies/redirect-url
Proprietà aggiuntive
 extra string

Proprietà aggiuntive per l'estendibilità

Restituisce

Corpo
CreateCeremonyCustomOutput

Eliminare una busta

ID operazione:
DeleteEnvelope

Elimina una busta e tutte le informazioni associate. https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope

Parametri

Nome Chiave Necessario Tipo Descrizione
ID busta
 envelopeId True string

ID della busta.

Ottenere un destinatario

ID operazione:
GetRecipient

Recupera i dettagli del destinatario in base al relativo ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient

Parametri

Nome Chiave Necessario Tipo Descrizione
ID destinatario
 recipientId True string

ID del destinatario.

Restituisce

Corpo
Recipient

Ottenere un risultato finale

ID operazione:
GetDeliverable

Recupera un risultato finale usando il relativo ID. Usarlo per scaricare una copia firmata della busta. https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable

Parametri

Nome Chiave Necessario Tipo Descrizione
ID risultato finale
 deliverableId True string

ID del risultato finale.

Restituisce

Corpo
Deliverable

Ottenere un valore acquisito

ID operazione:
GetCapture

Recupera un valore immesso da un destinatario in un luogo di input durante la firma. https://signatureapi.com/docs/integrations/power-automate/actions/get-capture

Parametri

Nome Chiave Necessario Tipo Descrizione
ID busta
 envelopeId True string

ID della busta.
Acquisisci chiave
 captureKey True string

Chiave del valore acquisito.

Restituisce

Corpo
Capture

Ottenere una busta

ID operazione:
GetEnvelope

Recupera i dettagli della busta in base al relativo ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope

Parametri

Nome Chiave Necessario Tipo Descrizione
ID busta
 envelopeId True string

ID della busta.

Restituisce

Corpo
Envelope

Trigger

Al termine del completamento di un destinatario

Questo evento si verifica quando un destinatario ha completato la propria parte del processo di firma.
Al termine di una busta

Questo evento si verifica quando lo stato di una busta passa da in_progress a completato, a indicare che è stato completato da tutti i destinatari.
All'avvio di una busta

Questo evento si verifica quando lo stato di una busta passa dall'elaborazione alla in_progress, a indicare che è pronto per essere inviato ai destinatari.
Quando un destinatario ha esito negativo

Questo evento si verifica quando si verifica un errore correlato a un destinatario, causando un errore di stato del destinatario non riuscito.
Quando un destinatario rimbalza

Questo evento si verifica quando un messaggio di posta elettronica non è recapitabile, temporaneamente (soft-bounce) o in modo permanente (rimbalzo fisso).
Quando un destinatario viene reinviato

Questo evento si verifica quando una richiesta viene inviata nuovamente a un destinatario.
Quando un destinatario viene rifiutato

Questo evento si verifica quando un destinatario rifiuta la busta.
Quando un destinatario viene rilasciato

Questo evento si verifica quando un destinatario è pronto per l'invio di una richiesta per completare una busta.
Quando un destinatario viene sostituito

Questo evento si verifica quando un destinatario viene sostituito con uno nuovo.
Quando un risultato finale ha esito negativo

Questo evento si verifica quando la generazione di un risultato finale ha esito negativo, generando uno stato finale non riuscito.
Quando una busta ha esito negativo

Questo evento si verifica quando una busta ha esito negativo, generando uno stato busta non riuscito.
Quando una busta viene annullata

Questo evento si verifica quando il processo di firma è stato interrotto intenzionalmente prima del completamento, determinando lo stato della busta annullato.
Quando viene creata una busta

Questo evento si verifica ogni volta che viene creata una busta.
Quando viene generato un risultato finale

Questo evento si verifica quando un risultato finale, ad esempio un log di controllo, viene generato correttamente.
Quando viene inviato un destinatario

Questo evento si verifica quando una richiesta viene inviata a un destinatario.

Al termine del completamento di un destinatario

ID operazione:
CreateEndpointForRecipientCompleted

Questo evento si verifica quando un destinatario ha completato la propria parte del processo di firma.

Parametri

Nome Chiave Necessario Tipo Descrizione
Argomenti
 topics array of string

Usare per classificare le buste e filtrare le notifiche webhook.

Restituisce

Corpo
NotificationForRecipientCompleted

Al termine di una busta

ID operazione:
CreateEndpointForEnvelopeCompleted

Questo evento si verifica quando lo stato di una busta passa da in_progress a completato, a indicare che è stato completato da tutti i destinatari.

Parametri

Nome Chiave Necessario Tipo Descrizione
Argomenti
 topics array of string

Usare per classificare le buste e filtrare le notifiche webhook.

Restituisce

Corpo
NotificationForEnvelopeCompleted

All'avvio di una busta

ID operazione:
CreateEndpointForEnvelopeStarted

Questo evento si verifica quando lo stato di una busta passa dall'elaborazione alla in_progress, a indicare che è pronto per essere inviato ai destinatari.

Parametri

Nome Chiave Necessario Tipo Descrizione
Argomenti
 topics array of string

Usare per classificare le buste e filtrare le notifiche webhook.

Restituisce

Corpo
NotificationForEnvelopeStarted

Quando un destinatario ha esito negativo

ID operazione:
CreateEndpointForRecipientFailed

Questo evento si verifica quando si verifica un errore correlato a un destinatario, causando un errore di stato del destinatario non riuscito.

Parametri

Nome Chiave Necessario Tipo Descrizione
Argomenti
 topics array of string

Usare per classificare le buste e filtrare le notifiche webhook.

Restituisce

Corpo
NotificationForRecipientFailed

Quando un destinatario rimbalza

ID operazione:
CreateEndpointForRecipientBounced

Questo evento si verifica quando un messaggio di posta elettronica non è recapitabile, temporaneamente (soft-bounce) o in modo permanente (rimbalzo fisso).

Parametri

Nome Chiave Necessario Tipo Descrizione
Argomenti
 topics array of string

Usare per classificare le buste e filtrare le notifiche webhook.

Restituisce

Corpo
NotificationForRecipientBounced

Quando un destinatario viene reinviato

ID operazione:
CreateEndpointForRecipientResent

Questo evento si verifica quando una richiesta viene inviata nuovamente a un destinatario.

Parametri

Nome Chiave Necessario Tipo Descrizione
Argomenti
 topics array of string

Usare per classificare le buste e filtrare le notifiche webhook.

Restituisce

Corpo
NotificationForRecipientResent

Quando un destinatario viene rifiutato

ID operazione:
CreateEndpointForRecipientRejected

Questo evento si verifica quando un destinatario rifiuta la busta.

Parametri

Nome Chiave Necessario Tipo Descrizione
Argomenti
 topics array of string

Usare per classificare le buste e filtrare le notifiche webhook.

Restituisce

Corpo
NotificationForRecipientRejected

Quando un destinatario viene rilasciato

ID operazione:
CreateEndpointForRecipientReleased

Questo evento si verifica quando un destinatario è pronto per l'invio di una richiesta per completare una busta.

Parametri

Nome Chiave Necessario Tipo Descrizione
Argomenti
 topics array of string

Usare per classificare le buste e filtrare le notifiche webhook.

Restituisce

Corpo
NotificationForRecipientReleased

Quando un destinatario viene sostituito

ID operazione:
CreateEndpointForRecipientReplaced

Questo evento si verifica quando un destinatario viene sostituito con uno nuovo.

Parametri

Nome Chiave Necessario Tipo Descrizione
Argomenti
 topics array of string

Usare per classificare le buste e filtrare le notifiche webhook.

Restituisce

Corpo
NotificationForRecipientReplaced

Quando un risultato finale ha esito negativo

ID operazione:
CreateEndpointForDeliverableFailed

Questo evento si verifica quando la generazione di un risultato finale ha esito negativo, generando uno stato finale non riuscito.

Parametri

Nome Chiave Necessario Tipo Descrizione
Argomenti
 topics array of string

Usare per classificare le buste e filtrare le notifiche webhook.

Restituisce

Corpo
NotificationForDeliverableFailed

Quando una busta ha esito negativo

ID operazione:
CreateEndpointForEnvelopeFailed

Questo evento si verifica quando una busta ha esito negativo, generando uno stato busta non riuscito.

Parametri

Nome Chiave Necessario Tipo Descrizione
Argomenti
 topics array of string

Usare per classificare le buste e filtrare le notifiche webhook.

Restituisce

Corpo
NotificationForEnvelopeFailed

Quando una busta viene annullata

ID operazione:
CreateEndpointForEnvelopeCanceled

Questo evento si verifica quando il processo di firma è stato interrotto intenzionalmente prima del completamento, determinando lo stato della busta annullato.

Parametri

Nome Chiave Necessario Tipo Descrizione
Argomenti
 topics array of string

Usare per classificare le buste e filtrare le notifiche webhook.

Restituisce

Corpo
NotificationForEnvelopeCanceled

Quando viene creata una busta

ID operazione:
CreateEndpointForEnvelopeCreated

Questo evento si verifica ogni volta che viene creata una busta.

Parametri

Nome Chiave Necessario Tipo Descrizione
Argomenti
 topics array of string

Usare per classificare le buste e filtrare le notifiche webhook.

Restituisce

Corpo
NotificationForEnvelopeCreated

Quando viene generato un risultato finale

ID operazione:
CreateEndpointForDeliverableGenerated

Questo evento si verifica quando un risultato finale, ad esempio un log di controllo, viene generato correttamente.

Parametri

Nome Chiave Necessario Tipo Descrizione
Argomenti
 topics array of string

Usare per classificare le buste e filtrare le notifiche webhook.

Restituisce

Corpo
NotificationForDeliverableGenerated

Quando viene inviato un destinatario

ID operazione:
CreateEndpointForRecipientSent

Questo evento si verifica quando una richiesta viene inviata a un destinatario.

Parametri

Nome Chiave Necessario Tipo Descrizione
Argomenti
 topics array of string

Usare per classificare le buste e filtrare le notifiche webhook.

Restituisce

Corpo
NotificationForRecipientSent

Definizioni

Busta

Nome Percorso Tipo Descrizione
ID busta
 id EnvelopeId

ID della busta.
Titolo busta
 title EnvelopeTitle

Titolo della busta. Può essere visualizzato ai destinatari.
Etichetta busta
 label EnvelopeLabel

Etichetta personalizzata assegnata alla busta per facilitare l'identificazione. Le etichette sono destinate all'uso interno e non vengono visualizzate ai destinatari.
Messaggio busta
 message EnvelopeMessage

Messaggio che verrà inviato ai destinatari.
mittente
 sender EnvelopeSender
Stato busta
 status EnvelopeStatus

Stato della busta.
risultato finale
 deliverable EnvelopeDeliverable
Busta completata all'indirizzo
 completed_at EnvelopeCompletedAt

Ora in cui tutti i destinatari hanno completato la busta.
Modalità busta
 mode EnvelopeMode

Le buste in modalità test non sono vincolanti e non fatturate.
Routing busta
 routing EnvelopeRouting

Ordine in cui i destinatari firmano la busta. Può essere parallela, in cui tutti i destinatari possono firmare simultaneamente, o sequenziale, in cui i destinatari firmano uno dopo l'altro.
Fuso orario
 timezone EnvelopeTimezone

Fuso orario da usare per i timestamp nei risultati finali. Se non specificato, viene usato l'offset di fuso orario predefinito dell'account. https://signatureapi.com/docs/localization/timezone
Formato timestamp
 timestamp_format EnvelopeTimestampFormat

Formato di data e ora da usare nei timestamp per i risultati finali. Se non specificato, viene usato il formato timestamp predefinito dell'account. https://signatureapi.com/docs/localization/timestamp_format
Attestazione busta
 attestation EnvelopeAttestation

Attestazione di conformità o normativa
Argomenti relativi alle buste
 topics EnvelopeTopics

Usare per classificare le buste e filtrare le notifiche webhook.

Destinatario

Nome Percorso Tipo Descrizione
ID destinatario
 id RecipientId

ID del destinatario.
ID busta
 envelope_id EnvelopeId

ID della busta.
Tipo di destinatario
 type RecipientType

Tipo del destinatario.
Chiave destinatario
 key RecipientKey

Chiave che identifica un destinatario all'interno di una busta.
Nome destinatario
 name RecipientName

Nome del destinatario.
Messaggio di posta elettronica destinatario
 email RecipientEmail

Indirizzo di posta elettronica del destinatario.
Stato destinatario
 status RecipientStatus

Stato del destinatario.
Creazione della cerimonia del destinatario
 ceremony_creation RecipientCeremonyCreation

Come vengono create le cerimonie per un destinatario.
Tipo di recapito destinatario
 delivery_type RecipientDeliveryType

Modalità di invio del risultato finale al destinatario.
Destinatario completato all'indirizzo
 completed_at RecipientCompletedAt

Ora in cui il destinatario ha completato la busta.

Risultato finale

Nome Percorso Tipo Descrizione
ID risultato finale
 id DeliverableId

ID del risultato finale.
Tipo risultato finale
 type DeliverableType

Tipo del risultato finale.
Stato risultato finale
 status DeliverableStatus

Stato del risultato finale.
Contenuto del file
 file_content DeliverableFileContent

Contenuto del file del risultato finale. Usarlo per salvare una copia firmata della busta.

Capture

Nome Percorso Tipo Descrizione
Acquisisci valore
 value CaptureValue

Valore dell'acquisizione di input del destinatario

CreateEnvelopeOutput

Nome Percorso Tipo Descrizione
ID busta
 id EnvelopeId

ID della busta.
Titolo busta
 title EnvelopeTitle

Titolo della busta. Può essere visualizzato ai destinatari.
Etichetta busta
 label EnvelopeLabel

Etichetta personalizzata assegnata alla busta per facilitare l'identificazione. Le etichette sono destinate all'uso interno e non vengono visualizzate ai destinatari.
Messaggio busta
 message EnvelopeMessage

Messaggio che verrà inviato ai destinatari.
mittente
 sender EnvelopeSender
Modalità busta
 mode EnvelopeMode

Le buste in modalità test non sono vincolanti e non fatturate.
Routing busta
 routing EnvelopeRouting

Ordine in cui i destinatari firmano la busta. Può essere parallela, in cui tutti i destinatari possono firmare simultaneamente, o sequenziale, in cui i destinatari firmano uno dopo l'altro.
Fuso orario
 timezone EnvelopeTimezone

Fuso orario da usare per i timestamp nei risultati finali. Se non specificato, viene usato l'offset di fuso orario predefinito dell'account. https://signatureapi.com/docs/localization/timezone
Formato timestamp
 timestamp_format EnvelopeTimestampFormat

Formato di data e ora da usare nei timestamp per i risultati finali. Se non specificato, viene usato il formato timestamp predefinito dell'account. https://signatureapi.com/docs/localization/timestamp_format
Attestazione busta
 attestation EnvelopeAttestation

Attestazione di conformità o normativa
Argomenti relativi alle buste
 topics EnvelopeTopics

Usare per classificare le buste e filtrare le notifiche webhook.

StartEnvelopeOutput

Nome Percorso Tipo Descrizione
Stato busta
 status EnvelopeStatus

Stato della busta.

AddDocumentOutput

Nome Percorso Tipo Descrizione
ID documento
 id DocumentId

ID del documento

AddRecipientSignerOutput

Nome Percorso Tipo Descrizione
ID destinatario
 id RecipientId

ID del destinatario.
Nome destinatario
 name RecipientName

Nome del destinatario.
Messaggio di posta elettronica destinatario
 email RecipientEmail

Indirizzo di posta elettronica del destinatario.
Chiave destinatario
 key RecipientKey

Chiave che identifica un destinatario all'interno di una busta.
Creazione della cerimonia del destinatario
 ceremony_creation RecipientCeremonyCreation

Come vengono create le cerimonie per un destinatario.
Tipo di recapito destinatario
 delivery_type RecipientDeliveryType

Modalità di invio del risultato finale al destinatario.

CreateCeremonyCustomOutput

Nome Percorso Tipo Descrizione
URL cerimonia
 url CeremonyUrl

L'URL che il destinatario deve visitare per avviare la cerimonia

EnvelopeId

ID della busta.

ID della busta.

ID busta
string

EnvelopeTitle

Titolo della busta. Può essere visualizzato ai destinatari.

Titolo della busta. Può essere visualizzato ai destinatari.

Titolo busta
string

EnvelopeLabel

Etichetta personalizzata assegnata alla busta per facilitare l'identificazione. Le etichette sono destinate all'uso interno e non vengono visualizzate ai destinatari.

Etichetta personalizzata assegnata alla busta per facilitare l'identificazione. Le etichette sono destinate all'uso interno e non vengono visualizzate ai destinatari.

Etichetta busta
string

EnvelopeMessage

Messaggio che verrà inviato ai destinatari.

Messaggio che verrà inviato ai destinatari.

Messaggio busta
string

EnvelopeRouting

Ordine in cui i destinatari firmano la busta. Può essere parallela, in cui tutti i destinatari possono firmare simultaneamente, o sequenziale, in cui i destinatari firmano uno dopo l'altro.

Ordine in cui i destinatari firmano la busta. Può essere parallela, in cui tutti i destinatari possono firmare simultaneamente, o sequenziale, in cui i destinatari firmano uno dopo l'altro.

Routing busta
string

EnvelopeTimezone

Fuso orario da usare per i timestamp nei risultati finali. Se non specificato, viene usato l'offset di fuso orario predefinito dell'account. https://signatureapi.com/docs/localization/timezone

Fuso orario da usare per i timestamp nei risultati finali. Se non specificato, viene usato l'offset di fuso orario predefinito dell'account. https://signatureapi.com/docs/localization/timezone

Fuso orario
string

EnvelopeTimestampFormat

Formato di data e ora da usare nei timestamp per i risultati finali. Se non specificato, viene usato il formato timestamp predefinito dell'account. https://signatureapi.com/docs/localization/timestamp_format

Formato di data e ora da usare nei timestamp per i risultati finali. Se non specificato, viene usato il formato timestamp predefinito dell'account. https://signatureapi.com/docs/localization/timestamp_format

Formato timestamp
string

EnvelopeSender

Nome Percorso Tipo Descrizione
Nome mittente
 name string

Nome del mittente.
Posta elettronica mittente
 email string

Indirizzo di posta elettronica del mittente.

EnvelopeStatus

Stato della busta.

Stato della busta.

Stato busta
string

EnvelopeMode

Le buste in modalità test non sono vincolanti e non fatturate.

Le buste in modalità test non sono vincolanti e non fatturate.

Modalità busta
string

EnvelopeTopics

Usare per classificare le buste e filtrare le notifiche webhook.

Nome Percorso Tipo Descrizione
Elementi
 string

EnvelopeAttestation

Attestazione di conformità o normativa

Attestazione di conformità o normativa

Attestazione busta
string

EnvelopeDeliverable

Nome Percorso Tipo Descrizione
ID risultato finale
 id string

ID del risultato finale. Utilizzare questa opzione per scaricare una copia firmata della busta.

EnvelopeCompletedAt

Ora in cui tutti i destinatari hanno completato la busta.

Ora in cui tutti i destinatari hanno completato la busta.

Busta completata all'indirizzo
date-time

DocumentId

ID del documento

ID del documento

ID documento
string

RecipientId

ID del destinatario.

ID del destinatario.

ID destinatario
string

RecipientType

Tipo del destinatario.

Tipo del destinatario.

Tipo di destinatario
string

RecipientName

Nome del destinatario.

Nome del destinatario.

Nome destinatario
string

RecipientEmail

Indirizzo di posta elettronica del destinatario.

Indirizzo di posta elettronica del destinatario.

Messaggio di posta elettronica destinatario
string

RecipientKey

Chiave che identifica un destinatario all'interno di una busta.

Chiave che identifica un destinatario all'interno di una busta.

Chiave destinatario
string

RecipientStatus

Stato del destinatario.

Stato del destinatario.

Stato destinatario
string

RecipientCeremonyCreation

Come vengono create le cerimonie per un destinatario.

Come vengono create le cerimonie per un destinatario.

Creazione della cerimonia del destinatario
string

RecipientDeliveryType

Modalità di invio del risultato finale al destinatario.

Modalità di invio del risultato finale al destinatario.

Tipo di recapito destinatario
string

RecipientCompletedAt

Ora in cui il destinatario ha completato la busta.

Ora in cui il destinatario ha completato la busta.

Destinatario completato all'indirizzo
date-time

DeliverableId

ID del risultato finale.

ID del risultato finale.

ID risultato finale
string

DeliverableType

Tipo del risultato finale.

Tipo del risultato finale.

Tipo risultato finale
string

DeliverableStatus

Stato del risultato finale.

Stato del risultato finale.

Stato risultato finale
string

DeliverableFileContent

Contenuto del file del risultato finale. Usarlo per salvare una copia firmata della busta.

Contenuto del file del risultato finale. Usarlo per salvare una copia firmata della busta.

Contenuto del file
byte

CerimoniaUrl

L'URL che il destinatario deve visitare per avviare la cerimonia

L'URL che il destinatario deve visitare per avviare la cerimonia

URL cerimonia
string

CaptureValue

Valore dell'acquisizione di input del destinatario

Valore dell'acquisizione di input del destinatario

Acquisisci valore
string

NotificationForEnvelopeCreated

Nome Percorso Tipo Descrizione
ID evento
 id EventId

ID dell'evento.
Timestamp dell'evento
 timestamp EventTimestamp

Data e ora dell'evento, in formato ISO 8601.
Tipo di evento
 type EventType

Tipo di evento.
ID busta
 data.envelope_id EventEnvelopeId

ID della busta a cui si riferisce questo evento.

NotificationForEnvelopeStarted

Nome Percorso Tipo Descrizione
ID evento
 id EventId

ID dell'evento.
Timestamp dell'evento
 timestamp EventTimestamp

Data e ora dell'evento, in formato ISO 8601.
Tipo di evento
 type EventType

Tipo di evento.
ID busta
 data.envelope_id EventEnvelopeId

ID della busta a cui si riferisce questo evento.

NotificationForEnvelopeCompleted

Nome Percorso Tipo Descrizione
ID evento
 id EventId

ID dell'evento.
Timestamp dell'evento
 timestamp EventTimestamp

Data e ora dell'evento, in formato ISO 8601.
Tipo di evento
 type EventType

Tipo di evento.
ID busta
 data.envelope_id EventEnvelopeId

ID della busta a cui si riferisce questo evento.

NotificationForEnvelopeFailed

Nome Percorso Tipo Descrizione
ID evento
 id EventId

ID dell'evento.
Timestamp dell'evento
 timestamp EventTimestamp

Data e ora dell'evento, in formato ISO 8601.
Tipo di evento
 type EventType

Tipo di evento.
ID busta
 data.envelope_id EventEnvelopeId

ID della busta a cui si riferisce questo evento.
Dettagli
 data.detail string

Informazioni sull'errore.

NotificationForEnvelopeCanceled

Nome Percorso Tipo Descrizione
ID evento
 id EventId

ID dell'evento.
Timestamp dell'evento
 timestamp EventTimestamp

Data e ora dell'evento, in formato ISO 8601.
Tipo di evento
 type EventType

Tipo di evento.
ID busta
 data.envelope_id EventEnvelopeId

ID della busta a cui si riferisce questo evento.

NotificationForRecipientReleased

Nome Percorso Tipo Descrizione
ID evento
 id EventId

ID dell'evento.
Timestamp dell'evento
 timestamp EventTimestamp

Data e ora dell'evento, in formato ISO 8601.
Tipo di evento
 type EventType

Tipo di evento.
ID busta
 data.envelope_id EventEnvelopeId

ID della busta a cui si riferisce questo evento.
ID destinatario
 data.object_id EventRecipientId

L'ID del destinatario a cui fa riferimento questo evento.
Tipo di destinatario
 data.recipient_type EventRecipientType

Tipo di destinatario a cui si riferisce questo evento.
Chiave destinatario
 data.recipient_key EventRecipientKey

La chiave del destinatario a cui si riferisce questo evento.

NotificationForRecipientSent

Nome Percorso Tipo Descrizione
ID evento
 id EventId

ID dell'evento.
Timestamp dell'evento
 timestamp EventTimestamp

Data e ora dell'evento, in formato ISO 8601.
Tipo di evento
 type EventType

Tipo di evento.
ID busta
 data.envelope_id EventEnvelopeId

ID della busta a cui si riferisce questo evento.
ID destinatario
 data.object_id EventRecipientId

L'ID del destinatario a cui fa riferimento questo evento.
Tipo di destinatario
 data.recipient_type EventRecipientType

Tipo di destinatario a cui si riferisce questo evento.
Chiave destinatario
 data.recipient_key EventRecipientKey

La chiave del destinatario a cui si riferisce questo evento.

NotificationForRecipientCompleted

Nome Percorso Tipo Descrizione
ID evento
 id EventId

ID dell'evento.
Timestamp dell'evento
 timestamp EventTimestamp

Data e ora dell'evento, in formato ISO 8601.
Tipo di evento
 type EventType

Tipo di evento.
ID busta
 data.envelope_id EventEnvelopeId

ID della busta a cui si riferisce questo evento.
ID destinatario
 data.object_id EventRecipientId

L'ID del destinatario a cui fa riferimento questo evento.
Tipo di destinatario
 data.recipient_type EventRecipientType

Tipo di destinatario a cui si riferisce questo evento.
Chiave destinatario
 data.recipient_key EventRecipientKey

La chiave del destinatario a cui si riferisce questo evento.

NotificationForRecipientRejected

Nome Percorso Tipo Descrizione
ID evento
 id EventId

ID dell'evento.
Timestamp dell'evento
 timestamp EventTimestamp

Data e ora dell'evento, in formato ISO 8601.
Tipo di evento
 type EventType

Tipo di evento.
ID busta
 data.envelope_id EventEnvelopeId

ID della busta a cui si riferisce questo evento.
ID destinatario
 data.object_id EventRecipientId

L'ID del destinatario a cui fa riferimento questo evento.
Tipo di destinatario
 data.recipient_type EventRecipientType

Tipo di destinatario a cui si riferisce questo evento.
Chiave destinatario
 data.recipient_key EventRecipientKey

La chiave del destinatario a cui si riferisce questo evento.
Motivo
 data.reason string

Spiegazione del destinatario per il rifiuto.

NotificationForRecipientBounced

Nome Percorso Tipo Descrizione
ID evento
 id EventId

ID dell'evento.
Timestamp dell'evento
 timestamp EventTimestamp

Data e ora dell'evento, in formato ISO 8601.
Tipo di evento
 type EventType

Tipo di evento.
ID busta
 data.envelope_id EventEnvelopeId

ID della busta a cui si riferisce questo evento.
ID destinatario
 data.object_id EventRecipientId

L'ID del destinatario a cui fa riferimento questo evento.
Tipo di destinatario
 data.recipient_type EventRecipientType

Tipo di destinatario a cui si riferisce questo evento.
Chiave destinatario
 data.recipient_key EventRecipientKey

La chiave del destinatario a cui si riferisce questo evento.
Dettagli
 data.detail string

Informazioni sul rimbalzo.

NotificationForRecipientFailed

Nome Percorso Tipo Descrizione
ID evento
 id EventId

ID dell'evento.
Timestamp dell'evento
 timestamp EventTimestamp

Data e ora dell'evento, in formato ISO 8601.
Tipo di evento
 type EventType

Tipo di evento.
ID busta
 data.envelope_id EventEnvelopeId

ID della busta a cui si riferisce questo evento.
ID destinatario
 data.object_id EventRecipientId

L'ID del destinatario a cui fa riferimento questo evento.
Tipo di destinatario
 data.recipient_type EventRecipientType

Tipo di destinatario a cui si riferisce questo evento.
Chiave destinatario
 data.recipient_key EventRecipientKey

La chiave del destinatario a cui si riferisce questo evento.
Dettagli
 data.detail string

Informazioni sull'errore.

NotificationForRecipientReplaced

Nome Percorso Tipo Descrizione
ID evento
 id EventId

ID dell'evento.
Timestamp dell'evento
 timestamp EventTimestamp

Data e ora dell'evento, in formato ISO 8601.
Tipo di evento
 type EventType

Tipo di evento.
ID busta
 data.envelope_id EventEnvelopeId

ID della busta a cui si riferisce questo evento.
ID destinatario
 data.object_id EventRecipientId

L'ID del destinatario a cui fa riferimento questo evento.
Tipo di destinatario
 data.recipient_type EventRecipientType

Tipo di destinatario a cui si riferisce questo evento.
Chiave destinatario
 data.recipient_key EventRecipientKey

La chiave del destinatario a cui si riferisce questo evento.
NUOVO ID destinatario
 data.new_recipient_id string

ID del nuovo destinatario.

NotificationForRecipientResent

Nome Percorso Tipo Descrizione
ID evento
 id EventId

ID dell'evento.
Timestamp dell'evento
 timestamp EventTimestamp

Data e ora dell'evento, in formato ISO 8601.
Tipo di evento
 type EventType

Tipo di evento.
ID busta
 data.envelope_id EventEnvelopeId

ID della busta a cui si riferisce questo evento.
ID destinatario
 data.object_id EventRecipientId

L'ID del destinatario a cui fa riferimento questo evento.
Tipo di destinatario
 data.recipient_type EventRecipientType

Tipo di destinatario a cui si riferisce questo evento.
Chiave destinatario
 data.recipient_key EventRecipientKey

La chiave del destinatario a cui si riferisce questo evento.

NotificationForDeliverableGenerated

Nome Percorso Tipo Descrizione
ID evento
 id EventId

ID dell'evento.
Timestamp dell'evento
 timestamp EventTimestamp

Data e ora dell'evento, in formato ISO 8601.
Tipo di evento
 type EventType

Tipo di evento.
ID busta
 data.envelope_id EventEnvelopeId

ID della busta a cui si riferisce questo evento.
ID risultato finale
 data.object_id EventDeliverableId

L'ID del risultato finale a cui fa riferimento questo evento.

NotificationForDeliverableFailed

Nome Percorso Tipo Descrizione
ID evento
 id EventId

ID dell'evento.
Timestamp dell'evento
 timestamp EventTimestamp

Data e ora dell'evento, in formato ISO 8601.
Tipo di evento
 type EventType

Tipo di evento.
ID busta
 data.envelope_id EventEnvelopeId

ID della busta a cui si riferisce questo evento.
ID risultato finale
 data.object_id EventDeliverableId

L'ID del risultato finale a cui fa riferimento questo evento.
Dettagli
 data.detail string

Informazioni sull'errore.

EventId

ID dell'evento.

ID dell'evento.

ID evento
string

Data e Ora dell'Evento

Data e ora dell'evento, in formato ISO 8601.

Data e ora dell'evento, in formato ISO 8601.

Timestamp dell'evento
date-time

TipoDiEvento

Tipo di evento.

Tipo di evento.

Tipo di evento
string

EventEnvelopeId

ID della busta a cui si riferisce questo evento.

ID della busta a cui si riferisce questo evento.

ID busta
string

EventRecipientId

L'ID del destinatario a cui fa riferimento questo evento.

L'ID del destinatario a cui fa riferimento questo evento.

ID destinatario
string

EventRecipientType

Tipo di destinatario a cui si riferisce questo evento.

Tipo di destinatario a cui si riferisce questo evento.

Tipo di destinatario
string

EventRecipientKey

La chiave del destinatario a cui si riferisce questo evento.

La chiave del destinatario a cui si riferisce questo evento.

Chiave destinatario
string

EventDeliverableId

L'ID del risultato finale a cui fa riferimento questo evento.

L'ID del risultato finale a cui fa riferimento questo evento.

ID risultato finale
string

oggetto

Si tratta del tipo 'object'.