Partager via

SignatureAPI

Envoyez des documents pour la signature, suivez leur progression et effectuez des tâches plus rapidement avec SignatureAPI, la plateforme de signature électronique conçue pour l’automatisation. https://signatureapi.com/docs/integrations/power-automate/getting-started

Ce connecteur est disponible dans les produits et régions suivants :

Service classe Régions
Copilot Studio Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Applications logiques Norme Toutes les régions Logic Apps , à l’exception des suivantes :
     - Régions Azure Government
     - Régions Azure Chine
     - Us Department of Defense (DoD)
Power Apps Premium Toutes les régions Power Apps , à l’exception des suivantes :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Contact
Nom API signature, Inc.
URL https://signatureapi.com
Messagerie électronique support@signatureapi.com
Métadonnées du connecteur
Éditeur SignatureAPI
Website https://signatureapi.com/power-automate
Politique de confidentialité https://signatureapi.com/privacy
Catégories Collaboration; Productivité

SignatureAPI

SignatureAPI est une plateforme de signature électronique conçue pour l’automatisation.

Envoyez des documents pour signer et suivre leur progression à l’aide de notre plateforme de signature électronique pour Power Automate, qui fournit différentes actions et déclencheurs pour vous aider à créer des flux de travail simples et complexes.

Les signatures électroniques effectuées avec SignatureAPI sont légalement contraignantes et acceptées globalement, tout comme les signatures manuscrites traditionnelles dans la plupart des juridictions.

SignatureAPI offre des tarifs rentables pour l’automatisation à volume élevé. Consultez nos détails de tarification.

Principales fonctionnalités

  • Plusieurs destinataires : envoyez des documents à jusqu’à 10 signataires dans une seule transaction.
  • Signature parallèle ou séquentielle : choisissez d’envoyer des documents à tous les destinataires en même temps ou dans un ordre spécifique.
  • Modèles de documents : générez des documents par programmation à l’aide de modèles et de données dynamiques.
  • Langues & Localisation : personnalisez l’interface de signature avec différentes langues, formats date-heure et fuseaux horaires.
  • Signature sans compte : autoriser les destinataires à signer des documents sans créer ou se connecter à un compte.
  • Journal d’audit : conservez un journal détaillé d’accès aux documents, de révision et d’événements de signature.
  • Vérification des falsifications : assurez-vous que l’intégrité des documents est vérifiée et irréfutable après signature.
  • Suivre les enveloppes : surveillez la progression de la signature via un tableau de bord convivial.
  • notificationsReal-Time : recevoir des mises à jour instantanées sur les activités de signature par e-mail et webhooks.

Prerequisites

Pour utiliser ce connecteur, inscrivez-vous à un compte SignatureAPI et générez une clé API. Obtenez une clé API de test gratuit et configurez votre connexion.

Getting Started

Le flux de travail le plus courant implique l’envoi d’un ou plusieurs documents aux destinataires pour signature. Les destinataires reçoivent un e-mail avec un lien pour accéder à l’interface de signature.

SignatureAPI prend en charge les flux de travail avancés. Explorez nos guides de connecteur pour obtenir des instructions pas à pas, des cas d’usage et des stratégies d’automatisation.

Étape 1 : Créer une enveloppe

Commencez par créer une enveloppe vide. Une enveloppe est un conteneur qui contient des documents et gère le processus de signature.

Les options sont les suivantes :

Étape 2 : Ajouter des destinataires

Spécifiez qui doit signer les documents en ajoutant des destinataires à votre enveloppe. Actuellement, seuls les signataires sont pris en charge, mais d’autres types de destinataires seront disponibles à l’avenir.

Étape 3 : Ajouter des documents

Ajoutez les documents qui ont besoin de signatures à l’enveloppe. Vous pouvez charger des fichiers PDF ou DOCX ou générer des documents à partir de modèles à l’aide de données.

Étape 4 : Définir des emplacements dans les documents

Les emplacements sont des zones désignées dans un document où un destinataire interagit, comme la signature, la fourniture d’initiales ou l’ajout de texte. Ils peuvent également contenir des valeurs statiques ou calculées telles que des dates d’achèvement.

Étape 5 : Démarrer le processus de signature

Une fois l’enveloppe entièrement préparée, lancez le processus de signature.

Étape 6 : Attendre que l’enveloppe soit terminée

Pour conserver l’intégralité du flux de travail dans le même flux, vous pouvez attendre la fin de l’enveloppe. Cela garantit que tous les destinataires ont signé et que le livrable (document signé) est généré.

Vous pouvez également déclencher un flux de travail distinct lorsque l’enveloppe est terminée et que le livrable est généré.

Étape 7 : Récupérer le document signé

Une fois le processus terminé, récupérez le document signé (livrable).

Utilisation de déclencheurs

SignatureAPI offre des déclencheurs pour automatiser vos flux de travail et simplifier les processus. Découvrez la liste complète des déclencheurs et comment les utiliser.

Déclencheurs couramment utilisés

Lorsqu’un livrable est généré

Déclenché lorsque l’enveloppe est terminée et que le document signé (livrable) est prêt.

Lorsqu’un destinataire termine une enveloppe

Déclenché chaque fois qu’un destinataire termine sa partie du processus de signature.

Lorsqu’un e-mail de destinataire rebondit

Déclenché quand l’adresse e-mail d’un destinataire ne peut pas recevoir la demande.

Problèmes connus et limitations

Erreurs et solutions courantes

  • Vérifiez que l’action Obtenir un livrable s’exécute après l’action Attendre l’enveloppe . Les livrables ne sont disponibles qu’une fois que tous les destinataires ont terminé leur partie.
  • Si vous passez d’une clé API de test à une clé API active, mettez à jour le déclencheur pour vous assurer que le webhook est créé dans l’environnement approprié (live ou test). Pour plus d’informations, consultez notre guide de résolution des problèmes .

Création d’une connexion

Le connecteur prend en charge les types d’authentification suivants :
Par défaut Paramètres de création de connexion. Toutes les régions Non partageable

Faire défaut

Applicable : Toutes les régions

Paramètres de création de connexion.

Cette connexion n’est pas partageable. Si l’application Power est partagée avec un autre utilisateur, un autre utilisateur sera invité à créer explicitement une nouvelle connexion.

Nom Type Descriptif Obligatoire
Clé d’API securestring Clé API pour votre compte SignatureAPI. Vrai

Limitations

Nom Appels Période de renouvellement
Appels d’API par connexion 100 60 secondes

Actions

Ajouter des données au modèle

Ajoute des données à un modèle. https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data
Ajouter un destinataire — Signataire

Ajoute un destinataire à une enveloppe. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient
Ajouter un document — DOCX

Ajoute un document DOCX à une enveloppe. https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx
Ajouter un document — PDF

Ajoute un document PDF à une enveloppe. https://signatureapi.com/docs/integrations/power-automate/actions/add-document
Ajouter un emplacement — Date de fin de l’enveloppe

Ajoute une date de fin d’enveloppe à un document. https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place
Ajouter un emplacement — Date de fin du destinataire

Ajoute un emplacement de date terminé par un destinataire à un document. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place
Ajouter un emplacement — Entrée de texte

Ajoute un emplacement d’entrée de texte à un document. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place
Ajouter un emplacement — Initiales

Ajoute un emplacement initial à un document. https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place
Ajouter un emplacement — Signature

Ajoute un emplacement de signature à un document. https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place
Ajouter un emplacement — Texte

Ajoute un emplacement de texte à un document. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place
Ajouter un modèle — DOCX

Ajoute un modèle DOCX à une enveloppe. https://signatureapi.com/docs/integrations/power-automate/actions/add-template
Attendre l’enveloppe

Attend qu’une enveloppe atteigne un état terminé ou un autre état final. https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope
Créer une cérémonie : authentification personnalisée

Crée une cérémonie où le destinataire est authentifié en externe auprès de SignatureAPI. Utilisez cette option pour obtenir une URL de cérémonie pour le partage avec les destinataires. Avant d’utiliser la lecture de l’authentification personnalisée https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom
Créer une cérémonie — Authentification par lien e-mail

Crée une cérémonie où le destinataire est authentifié via un lien envoyé à son e-mail. https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link
Créer une enveloppe

Crée une enveloppe à laquelle vous pouvez ajouter des destinataires et des documents. Lorsque vous êtes prêt, utilisez l’action « Démarrer une enveloppe » pour lancer le processus de signature. https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope
Démarrer une enveloppe

Lance le processus de signature d’une enveloppe. https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope
Obtenir un destinataire

Récupère les détails du destinataire par son ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient
Obtenir un livrable

Récupère un livrable à l’aide de son ID. Utilisez-le pour télécharger une copie signée de l’enveloppe. https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable
Obtenir une enveloppe

Récupère les détails de l’enveloppe par son ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope
Obtenir une valeur capturée

Récupère une valeur entrée par un destinataire dans un emplacement d’entrée lors de la signature. https://signatureapi.com/docs/integrations/power-automate/actions/get-capture
Supprimer une enveloppe

Supprime une enveloppe et toutes les informations associées. https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope

Ajouter des données au modèle

ID d’opération :
AddTemplateData

Ajoute des données à un modèle. https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data

Paramètres

Nom Clé Obligatoire Type Description
Document ID
 documentId True string

ID du document.
Nom du champ
 field_name True string

Nom du champ dans le modèle.
Valeur
 value True string

Valeur du champ dans le modèle.

Ajouter un destinataire — Signataire

ID d’opération :
AddRecipient

Ajoute un destinataire à une enveloppe. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeId True string

ID de l’enveloppe.
Nom du destinataire
 name True string

Nom du destinataire.
E-mail du destinataire
 email True string

Adresse e-mail du destinataire.
Clé de destinataire
 key True string

Clé qui identifie un destinataire dans une enveloppe.
Création d’une cérémonie de destinataire
 ceremony_creation string

Comment les cérémonies d’un destinataire sont créées.
Type de remise du destinataire
 delivery_type string

Comment le livrable est envoyé au destinataire.
Propriétés supplémentaires
 extra string

Propriétés supplémentaires pour l’extensibilité

Retours

Corps
AddRecipientSignerOutput

Ajouter un document — DOCX

ID d’opération :
AddDocumentDocx

Ajoute un document DOCX à une enveloppe. https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeId True string

ID de l’enveloppe.
Titre du document
 title string

Titre de ce document. Cela peut être présenté aux destinataires.
Contenu du fichier
 file_content True byte

Contenu du fichier de document.
Propriétés supplémentaires
 extra string

Propriétés supplémentaires pour l’extensibilité

Retours

Corps
AddDocumentOutput

Ajouter un document — PDF

ID d’opération :
AddDocument

Ajoute un document PDF à une enveloppe. https://signatureapi.com/docs/integrations/power-automate/actions/add-document

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeId True string

ID de l’enveloppe.
Titre du document
 title string

Titre de ce document. Cela peut être présenté aux destinataires.
Contenu du fichier
 file_content True byte

Contenu du fichier de document.
Propriétés supplémentaires
 extra string

Propriétés supplémentaires pour l’extensibilité

Retours

Corps
AddDocumentOutput

Ajouter un emplacement — Date de fin de l’enveloppe

ID d’opération :
AddPlaceEnvelopeCompletedDate

Ajoute une date de fin d’enveloppe à un document. https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place

Paramètres

Nom Clé Obligatoire Type Description
Document ID
 documentId True string

ID du document.
Placer la clé
 key True string

Clé qui identifie cet emplacement dans le document.
Date Format
 date_format string

Définit le format de la date et de l’heure. Reportez-vous à la documentation relative aux valeurs autorisées.
Numéro de page
 page number

Numéro de page à positionner cet emplacement.
Distance de haut
 top number

Distance (en points) entre le haut de la page et le bas de l’endroit.
Distance de gauche
 left number

Distance (en points) entre la gauche de la page et l’emplacement.
Propriétés supplémentaires
 extra string

Propriétés supplémentaires pour l’extensibilité

Ajouter un emplacement — Date de fin du destinataire

ID d’opération :
AddPlaceRecipientCompletedDate

Ajoute un emplacement de date terminé par un destinataire à un document. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place

Paramètres

Nom Clé Obligatoire Type Description
Document ID
 documentId True string

ID du document.
Placer la clé
 key True string

Clé qui identifie cet emplacement dans le document.
Clé de destinataire
 recipient_key True string

La clé du destinataire à cet endroit fait référence.
Date Format
 date_format string

Définit le format de la date et de l’heure. Reportez-vous à la documentation relative aux valeurs autorisées.
Numéro de page
 page number

Numéro de page à positionner cet emplacement.
Distance de haut
 top number

Distance (en points) entre le haut de la page et le bas de l’endroit.
Distance de gauche
 left number

Distance (en points) entre la gauche de la page et l’emplacement.
Propriétés supplémentaires
 extra string

Propriétés supplémentaires pour l’extensibilité

Ajouter un emplacement — Entrée de texte

ID d’opération :
AddPlaceTextInput

Ajoute un emplacement d’entrée de texte à un document. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place

Paramètres

Nom Clé Obligatoire Type Description
Document ID
 documentId True string

ID du document.
Placer la clé
 key True string

Clé qui identifie cet emplacement dans le document.
Clé de destinataire
 recipient_key True string

La clé du destinataire à cet endroit fait référence.
Capturer sous
 capture_as string

Clé qui stocke l’entrée du destinataire et est incluse dans les captures d’enveloppe.
Hint
 hint string

Message d’info-bulle affiché sur le champ d’entrée du destinataire.
Prompt
 prompt string

Message d’espace réservé affiché à l’intérieur du champ de texte d’entrée pendant la cérémonie de signature.
Requirement
 requirement string

Spécifie si le destinataire doit remplir ce champ pour terminer la cérémonie de signature.
Format
 format string

Spécifie le format valide pour l’entrée utilisateur. Reportez-vous à la documentation relative aux valeurs autorisées.
Mettre en forme le message
 format_message string

Message affiché lorsque l’entrée de l’utilisateur ne correspond pas au format requis.
Numéro de page
 page number

Numéro de page à positionner cet emplacement.
Distance de haut
 top number

Distance (en points) entre le haut de la page et le bas de l’endroit.
Distance de gauche
 left number

Distance (en points) entre la gauche de la page et l’emplacement.
Propriétés supplémentaires
 extra string

Propriétés supplémentaires pour l’extensibilité

Ajouter un emplacement — Initiales

ID d’opération :
AddPlaceInitials

Ajoute un emplacement initial à un document. https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place

Paramètres

Nom Clé Obligatoire Type Description
Document ID
 documentId True string

ID du document.
Placer la clé
 key True string

Clé qui identifie cet emplacement dans le document.
Clé de destinataire
 recipient_key True string

La clé du destinataire à cet endroit fait référence.
Hauteur de la place
 height number

Définissez une hauteur personnalisée, la largeur s’ajuste proportionnellement.
Numéro de page
 page number

Numéro de page à positionner cet emplacement.
Distance de haut
 top number

Distance (en points) entre le haut de la page et le bas de l’endroit.
Distance de gauche
 left number

Distance (en points) entre la gauche de la page et l’emplacement.
Propriétés supplémentaires
 extra string

Propriétés supplémentaires pour l’extensibilité

Ajouter un emplacement — Signature

ID d’opération :
AddPlaceSignature

Ajoute un emplacement de signature à un document. https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place

Paramètres

Nom Clé Obligatoire Type Description
Document ID
 documentId True string

ID du document.
Placer la clé
 key True string

Clé qui identifie cet emplacement dans le document.
Clé de destinataire
 recipient_key True string

La clé du destinataire à cet endroit fait référence.
Hauteur de la place
 height number

Définissez une hauteur personnalisée, la largeur s’ajuste proportionnellement.
Numéro de page
 page number

Numéro de page à positionner cet emplacement.
Distance de haut
 top number

Distance (en points) entre le haut de la page et le bas de l’endroit.
Distance de gauche
 left number

Distance (en points) entre la gauche de la page et l’emplacement.
Propriétés supplémentaires
 extra string

Propriétés supplémentaires pour l’extensibilité

Ajouter un emplacement — Texte

ID d’opération :
AddPlaceText

Ajoute un emplacement de texte à un document. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place

Paramètres

Nom Clé Obligatoire Type Description
Document ID
 documentId True string

ID du document.
Placer la clé
 key True string

Clé qui identifie cet emplacement dans le document.
Valeur
 value True string

Valeur de cet emplacement de texte.
Taille de police
 font_size number

Taille de police en points.
Couleur de police
 font_color string

Couleur de police en notation hexadécimale.
Numéro de page
 page number

Numéro de page à positionner cet emplacement.
Distance de haut
 top number

Distance (en points) entre le haut de la page et le bas de l’endroit.
Distance de gauche
 left number

Distance (en points) entre la gauche de la page et l’emplacement.
Propriétés supplémentaires
 extra string

Propriétés supplémentaires pour l’extensibilité

Ajouter un modèle — DOCX

ID d’opération :
AddTemplate

Ajoute un modèle DOCX à une enveloppe. https://signatureapi.com/docs/integrations/power-automate/actions/add-template

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeId True string

ID de l’enveloppe.
Titre du document
 title string

Titre de ce document. Cela peut être présenté aux destinataires.
Contenu du fichier
 file_content True byte

Contenu du fichier de document.
Données de modèle
 data array of string

Champ : paire valeur contenant des données à remplir dans le modèle.
Propriétés supplémentaires
 extra string

Propriétés supplémentaires pour l’extensibilité

Retours

Corps
AddDocumentOutput

Attendre l’enveloppe

ID d’opération :
WaitEnvelope

Attend qu’une enveloppe atteigne un état terminé ou un autre état final. https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeId True string

ID de l’enveloppe.

Retours

Corps
Envelope

Créer une cérémonie : authentification personnalisée

ID d’opération :
CreateCeremonyCustom

Crée une cérémonie où le destinataire est authentifié en externe auprès de SignatureAPI. Utilisez cette option pour obtenir une URL de cérémonie pour le partage avec les destinataires. Avant d’utiliser la lecture de l’authentification personnalisée https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom

Paramètres

Nom Clé Obligatoire Type Description
ID du destinataire
 recipientId True string

ID du destinataire.
Fournisseur d’authentification
 provider True string

Nom du fournisseur d’authentification. Cette valeur est arbitraire et apparaît dans les journaux d’audit de l’enveloppe.
Données d’authentification
 data True array of string

Clé : paire valeur contenant les métadonnées d’authentification. Ces détails seront inclus dans les journaux d’audit de l’enveloppe.
URL de redirection
 redirect_url string

URL vers laquelle rediriger le destinataire après la fin d’une cérémonie. En savoir plus dans : https://signatureapi.com/docs/resources/ceremonies/redirect-url
Propriétés supplémentaires
 extra string

Propriétés supplémentaires pour l’extensibilité

Retours

Corps
CreateCeremonyCustomOutput

Créer une cérémonie — Authentification par lien e-mail

ID d’opération :
CreateCeremonyEmailLink

Crée une cérémonie où le destinataire est authentifié via un lien envoyé à son e-mail. https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link

Paramètres

Nom Clé Obligatoire Type Description
ID du destinataire
 recipientId True string

ID du destinataire.
URL de redirection
 redirect_url string

URL vers laquelle rediriger le destinataire après la fin d’une cérémonie. En savoir plus dans : https://signatureapi.com/docs/resources/ceremonies/redirect-url
Propriétés supplémentaires
 extra string

Propriétés supplémentaires pour l’extensibilité

Retours

response
object

Créer une enveloppe

ID d’opération :
CreateEnvelope

Crée une enveloppe à laquelle vous pouvez ajouter des destinataires et des documents. Lorsque vous êtes prêt, utilisez l’action « Démarrer une enveloppe » pour lancer le processus de signature. https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope

Paramètres

Nom Clé Obligatoire Type Description
Titre de l’enveloppe
 title True string

Titre de cette enveloppe. Cela peut être présenté aux destinataires.
Étiquette d’enveloppe
 label string

Étiquette personnalisée donnée à l’enveloppe pour faciliter l’identification. Les étiquettes sont utilisées en interne et ne sont pas affichées aux destinataires.
Message d’enveloppe
 message string

Message qui sera envoyé aux destinataires.
Mode enveloppe
 mode string

Les enveloppes en mode test ne sont pas contraignantes et ne sont pas facturées.
Routage de l’enveloppe
 routing string

Ordre dans lequel les destinataires signent l’enveloppe. Il peut être parallèle, où tous les destinataires peuvent signer simultanément ou séquentiellement, où les destinataires se signent l’un après l’autre.
Language
 language string

Langue par défaut à utiliser lors de la cérémonie de signature et des livrables. S’il n’est pas spécifié, la langue par défaut du compte est utilisée. https://signatureapi.com/docs/localization/language
Fuseau horaire
 timezone string

Fuseau horaire à utiliser pour les horodatages dans les livrables. S’il n’est pas spécifié, le décalage de fuseau horaire par défaut du compte est utilisé. https://signatureapi.com/docs/localization/timezone
Format d’horodatage
 timestamp_format string

Format de date et d’heure à utiliser dans les horodatages pour les livrables. S’il n’est pas spécifié, le format d’horodatage par défaut du compte est utilisé. https://signatureapi.com/docs/localization/timestamp_format
Attestation d’enveloppe
 attestation string

Attestation réglementaire ou de conformité
Nom
 name string

Nom de l’expéditeur.
Messagerie électronique
 email string

Adresse e-mail de l’expéditeur.
Rubriques sur l’enveloppe
 topics array of string

Permet de classer les enveloppes et de filtrer les notifications de webhook.
Propriétés supplémentaires
 extra string

Propriétés supplémentaires pour l’extensibilité

Retours

Corps
CreateEnvelopeOutput

Démarrer une enveloppe

ID d’opération :
StartEnvelope

Lance le processus de signature d’une enveloppe. https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeId True string

ID de l’enveloppe.

Retours

Corps
StartEnvelopeOutput

Obtenir un destinataire

ID d’opération :
GetRecipient

Récupère les détails du destinataire par son ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient

Paramètres

Nom Clé Obligatoire Type Description
ID du destinataire
 recipientId True string

ID du destinataire.

Retours

Corps
Recipient

Obtenir un livrable

ID d’opération :
GetDeliverable

Récupère un livrable à l’aide de son ID. Utilisez-le pour télécharger une copie signée de l’enveloppe. https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable

Paramètres

Nom Clé Obligatoire Type Description
ID du livrable
 deliverableId True string

ID du livrable.

Retours

Corps
Deliverable

Obtenir une enveloppe

ID d’opération :
GetEnvelope

Récupère les détails de l’enveloppe par son ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeId True string

ID de l’enveloppe.

Retours

Corps
Envelope

Obtenir une valeur capturée

ID d’opération :
GetCapture

Récupère une valeur entrée par un destinataire dans un emplacement d’entrée lors de la signature. https://signatureapi.com/docs/integrations/power-automate/actions/get-capture

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeId True string

ID de l’enveloppe.
Clé de capture
 captureKey True string

Clé de la valeur capturée.

Retours

Corps
Capture

Supprimer une enveloppe

ID d’opération :
DeleteEnvelope

Supprime une enveloppe et toutes les informations associées. https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeId True string

ID de l’enveloppe.

Déclencheurs

En cas d’échec d’un destinataire

Cet événement se produit lorsqu’il y a un échec lié à un destinataire, ce qui entraîne l’échec d’un destinataire.
En cas d’échec d’un livrable

Cet événement se produit lorsque la génération d’un livrable échoue, ce qui entraîne l’échec d’un livrable.
En cas d’échec d’une enveloppe

Cet événement se produit lorsqu’une enveloppe échoue, ce qui entraîne l’échec d’une enveloppe.
Lorsqu’un destinataire est envoyé

Cet événement se produit lorsqu’une demande est envoyée à un destinataire.
Lorsqu’un destinataire est libéré

Cet événement se produit lorsqu’un destinataire est prêt à être envoyé une demande pour compléter une enveloppe.
Lorsqu’un destinataire est rejeté

Cet événement se produit lorsqu’un destinataire rejette l’enveloppe.
Lorsqu’un destinataire est remplacé

Cet événement se produit lorsqu’un destinataire est remplacé par un nouveau.
Lorsqu’un destinataire est renvoyé

Cet événement se produit lorsqu’une requête est réentente sur un destinataire.
Lorsqu’un destinataire est terminé

Cet événement se produit lorsqu’un destinataire a terminé sa partie du processus de signature.
Lorsqu’un destinataire rebondit

Cet événement se produit lorsqu’un e-mail n’est pasdeliverable, soit temporairement (rebond réversible) soit définitivement (rebond dur).
Lorsqu’un livrable est généré

Cet événement se produit lorsqu’un livrable, tel qu’un journal d’audit, est correctement généré.
Lorsqu’une enveloppe a démarré

Cet événement se produit lorsqu’un état de l’enveloppe passe du traitement à in_progress, indiquant qu’il est prêt à être envoyé aux destinataires.
Lorsqu’une enveloppe est annulée

Cet événement se produit lorsque le processus de signature a été intentionnellement arrêté avant la fin, ce qui entraîne l’état de l’enveloppe annulée.
Lorsqu’une enveloppe est créée

Cet événement se produit chaque fois qu’une enveloppe est créée.
Lorsqu’une enveloppe est terminée

Cet événement se produit lorsqu’un état d’enveloppe passe de in_progress à terminé, indiquant qu’il a été effectué par tous les destinataires.

En cas d’échec d’un destinataire

ID d’opération :
CreateEndpointForRecipientFailed

Cet événement se produit lorsqu’il y a un échec lié à un destinataire, ce qui entraîne l’échec d’un destinataire.

Paramètres

Nom Clé Obligatoire Type Description
Sujets
 topics array of string

Permet de classer les enveloppes et de filtrer les notifications de webhook.

Retours

Corps
NotificationForRecipientFailed

En cas d’échec d’un livrable

ID d’opération :
CreateEndpointForDeliverableFailed

Cet événement se produit lorsque la génération d’un livrable échoue, ce qui entraîne l’échec d’un livrable.

Paramètres

Nom Clé Obligatoire Type Description
Sujets
 topics array of string

Permet de classer les enveloppes et de filtrer les notifications de webhook.

Retours

Corps
NotificationForDeliverableFailed

En cas d’échec d’une enveloppe

ID d’opération :
CreateEndpointForEnvelopeFailed

Cet événement se produit lorsqu’une enveloppe échoue, ce qui entraîne l’échec d’une enveloppe.

Paramètres

Nom Clé Obligatoire Type Description
Sujets
 topics array of string

Permet de classer les enveloppes et de filtrer les notifications de webhook.

Retours

Corps
NotificationForEnvelopeFailed

Lorsqu’un destinataire est envoyé

ID d’opération :
CreateEndpointForRecipientSent

Cet événement se produit lorsqu’une demande est envoyée à un destinataire.

Paramètres

Nom Clé Obligatoire Type Description
Sujets
 topics array of string

Permet de classer les enveloppes et de filtrer les notifications de webhook.

Retours

Corps
NotificationForRecipientSent

Lorsqu’un destinataire est libéré

ID d’opération :
CreateEndpointForRecipientReleased

Cet événement se produit lorsqu’un destinataire est prêt à être envoyé une demande pour compléter une enveloppe.

Paramètres

Nom Clé Obligatoire Type Description
Sujets
 topics array of string

Permet de classer les enveloppes et de filtrer les notifications de webhook.

Retours

Corps
NotificationForRecipientReleased

Lorsqu’un destinataire est rejeté

ID d’opération :
CreateEndpointForRecipientRejected

Cet événement se produit lorsqu’un destinataire rejette l’enveloppe.

Paramètres

Nom Clé Obligatoire Type Description
Sujets
 topics array of string

Permet de classer les enveloppes et de filtrer les notifications de webhook.

Retours

Corps
NotificationForRecipientRejected

Lorsqu’un destinataire est remplacé

ID d’opération :
CreateEndpointForRecipientReplaced

Cet événement se produit lorsqu’un destinataire est remplacé par un nouveau.

Paramètres

Nom Clé Obligatoire Type Description
Sujets
 topics array of string

Permet de classer les enveloppes et de filtrer les notifications de webhook.

Retours

Corps
NotificationForRecipientReplaced

Lorsqu’un destinataire est renvoyé

ID d’opération :
CreateEndpointForRecipientResent

Cet événement se produit lorsqu’une requête est réentente sur un destinataire.

Paramètres

Nom Clé Obligatoire Type Description
Sujets
 topics array of string

Permet de classer les enveloppes et de filtrer les notifications de webhook.

Retours

Corps
NotificationForRecipientResent

Lorsqu’un destinataire est terminé

ID d’opération :
CreateEndpointForRecipientCompleted

Cet événement se produit lorsqu’un destinataire a terminé sa partie du processus de signature.

Paramètres

Nom Clé Obligatoire Type Description
Sujets
 topics array of string

Permet de classer les enveloppes et de filtrer les notifications de webhook.

Retours

Corps
NotificationForRecipientCompleted

Lorsqu’un destinataire rebondit

ID d’opération :
CreateEndpointForRecipientBounced

Cet événement se produit lorsqu’un e-mail n’est pasdeliverable, soit temporairement (rebond réversible) soit définitivement (rebond dur).

Paramètres

Nom Clé Obligatoire Type Description
Sujets
 topics array of string

Permet de classer les enveloppes et de filtrer les notifications de webhook.

Retours

Corps
NotificationForRecipientBounced

Lorsqu’un livrable est généré

ID d’opération :
CreateEndpointForDeliverableGenerated

Cet événement se produit lorsqu’un livrable, tel qu’un journal d’audit, est correctement généré.

Paramètres

Nom Clé Obligatoire Type Description
Sujets
 topics array of string

Permet de classer les enveloppes et de filtrer les notifications de webhook.

Retours

Corps
NotificationForDeliverableGenerated

Lorsqu’une enveloppe a démarré

ID d’opération :
CreateEndpointForEnvelopeStarted

Cet événement se produit lorsqu’un état de l’enveloppe passe du traitement à in_progress, indiquant qu’il est prêt à être envoyé aux destinataires.

Paramètres

Nom Clé Obligatoire Type Description
Sujets
 topics array of string

Permet de classer les enveloppes et de filtrer les notifications de webhook.

Retours

Corps
NotificationForEnvelopeStarted

Lorsqu’une enveloppe est annulée

ID d’opération :
CreateEndpointForEnvelopeCanceled

Cet événement se produit lorsque le processus de signature a été intentionnellement arrêté avant la fin, ce qui entraîne l’état de l’enveloppe annulée.

Paramètres

Nom Clé Obligatoire Type Description
Sujets
 topics array of string

Permet de classer les enveloppes et de filtrer les notifications de webhook.

Retours

Corps
NotificationForEnvelopeCanceled

Lorsqu’une enveloppe est créée

ID d’opération :
CreateEndpointForEnvelopeCreated

Cet événement se produit chaque fois qu’une enveloppe est créée.

Paramètres

Nom Clé Obligatoire Type Description
Sujets
 topics array of string

Permet de classer les enveloppes et de filtrer les notifications de webhook.

Retours

Corps
NotificationForEnvelopeCreated

Lorsqu’une enveloppe est terminée

ID d’opération :
CreateEndpointForEnvelopeCompleted

Cet événement se produit lorsqu’un état d’enveloppe passe de in_progress à terminé, indiquant qu’il a été effectué par tous les destinataires.

Paramètres

Nom Clé Obligatoire Type Description
Sujets
 topics array of string

Permet de classer les enveloppes et de filtrer les notifications de webhook.

Retours

Corps
NotificationForEnvelopeCompleted

Définitions

Enveloppe

Nom Chemin d’accès Type Description
ID d’enveloppe
 id EnvelopeId

ID de l’enveloppe.
Titre de l’enveloppe
 title EnvelopeTitle

Titre de cette enveloppe. Cela peut être présenté aux destinataires.
Étiquette d’enveloppe
 label EnvelopeLabel

Étiquette personnalisée donnée à l’enveloppe pour faciliter l’identification. Les étiquettes sont utilisées en interne et ne sont pas affichées aux destinataires.
Message d’enveloppe
 message EnvelopeMessage

Message qui sera envoyé aux destinataires.
expéditeur
 sender EnvelopeSender
État de l’enveloppe
 status EnvelopeStatus

État de l’enveloppe.
livrable
 deliverable EnvelopeDeliverable
Enveloppe terminée à
 completed_at EnvelopeCompletedAt

Heure à laquelle tous les destinataires ont terminé l’enveloppe.
Mode enveloppe
 mode EnvelopeMode

Les enveloppes en mode test ne sont pas contraignantes et ne sont pas facturées.
Routage de l’enveloppe
 routing EnvelopeRouting

Ordre dans lequel les destinataires signent l’enveloppe. Il peut être parallèle, où tous les destinataires peuvent signer simultanément ou séquentiellement, où les destinataires se signent l’un après l’autre.
Fuseau horaire
 timezone EnvelopeTimezone

Fuseau horaire à utiliser pour les horodatages dans les livrables. S’il n’est pas spécifié, le décalage de fuseau horaire par défaut du compte est utilisé. https://signatureapi.com/docs/localization/timezone
Format d’horodatage
 timestamp_format EnvelopeTimestampFormat

Format de date et d’heure à utiliser dans les horodatages pour les livrables. S’il n’est pas spécifié, le format d’horodatage par défaut du compte est utilisé. https://signatureapi.com/docs/localization/timestamp_format
Attestation d’enveloppe
 attestation EnvelopeAttestation

Attestation réglementaire ou de conformité
Rubriques sur l’enveloppe
 topics EnvelopeTopics

Permet de classer les enveloppes et de filtrer les notifications de webhook.

Recipient

Nom Chemin d’accès Type Description
ID du destinataire
 id RecipientId

ID du destinataire.
ID d’enveloppe
 envelope_id EnvelopeId

ID de l’enveloppe.
Type de destinataire
 type RecipientType

Type du destinataire.
Clé de destinataire
 key RecipientKey

Clé qui identifie un destinataire dans une enveloppe.
Nom du destinataire
 name RecipientName

Nom du destinataire.
E-mail du destinataire
 email RecipientEmail

Adresse e-mail du destinataire.
État du destinataire
 status RecipientStatus

État du destinataire.
Création d’une cérémonie de destinataire
 ceremony_creation RecipientCeremonyCreation

Comment les cérémonies d’un destinataire sont créées.
Type de remise du destinataire
 delivery_type RecipientDeliveryType

Comment le livrable est envoyé au destinataire.
Destinataire terminé à l’adresse
 completed_at RecipientCompletedAt

Heure à laquelle le destinataire a terminé l’enveloppe.

Livrable

Nom Chemin d’accès Type Description
ID du livrable
 id DeliverableId

ID du livrable.
Type de livrable
 type DeliverableType

Type du livrable.
État du livrable
 status DeliverableStatus

État du livrable.
Contenu du fichier
 file_content DeliverableFileContent

Contenu du fichier du livrable. Utilisez-la pour enregistrer une copie signée de l’enveloppe.

Capture

Nom Chemin d’accès Type Description
Valeur de capture
 value CaptureValue

Valeur de la capture d’entrée du destinataire

CreateEnvelopeOutput

Nom Chemin d’accès Type Description
ID d’enveloppe
 id EnvelopeId

ID de l’enveloppe.
Titre de l’enveloppe
 title EnvelopeTitle

Titre de cette enveloppe. Cela peut être présenté aux destinataires.
Étiquette d’enveloppe
 label EnvelopeLabel

Étiquette personnalisée donnée à l’enveloppe pour faciliter l’identification. Les étiquettes sont utilisées en interne et ne sont pas affichées aux destinataires.
Message d’enveloppe
 message EnvelopeMessage

Message qui sera envoyé aux destinataires.
expéditeur
 sender EnvelopeSender
Mode enveloppe
 mode EnvelopeMode

Les enveloppes en mode test ne sont pas contraignantes et ne sont pas facturées.
Routage de l’enveloppe
 routing EnvelopeRouting

Ordre dans lequel les destinataires signent l’enveloppe. Il peut être parallèle, où tous les destinataires peuvent signer simultanément ou séquentiellement, où les destinataires se signent l’un après l’autre.
Fuseau horaire
 timezone EnvelopeTimezone

Fuseau horaire à utiliser pour les horodatages dans les livrables. S’il n’est pas spécifié, le décalage de fuseau horaire par défaut du compte est utilisé. https://signatureapi.com/docs/localization/timezone
Format d’horodatage
 timestamp_format EnvelopeTimestampFormat

Format de date et d’heure à utiliser dans les horodatages pour les livrables. S’il n’est pas spécifié, le format d’horodatage par défaut du compte est utilisé. https://signatureapi.com/docs/localization/timestamp_format
Attestation d’enveloppe
 attestation EnvelopeAttestation

Attestation réglementaire ou de conformité
Rubriques sur l’enveloppe
 topics EnvelopeTopics

Permet de classer les enveloppes et de filtrer les notifications de webhook.

StartEnvelopeOutput

Nom Chemin d’accès Type Description
État de l’enveloppe
 status EnvelopeStatus

État de l’enveloppe.

AddDocumentOutput

Nom Chemin d’accès Type Description
Document ID
 id DocumentId

ID du document

AddRecipientSignerOutput

Nom Chemin d’accès Type Description
ID du destinataire
 id RecipientId

ID du destinataire.
Nom du destinataire
 name RecipientName

Nom du destinataire.
E-mail du destinataire
 email RecipientEmail

Adresse e-mail du destinataire.
Clé de destinataire
 key RecipientKey

Clé qui identifie un destinataire dans une enveloppe.
Création d’une cérémonie de destinataire
 ceremony_creation RecipientCeremonyCreation

Comment les cérémonies d’un destinataire sont créées.
Type de remise du destinataire
 delivery_type RecipientDeliveryType

Comment le livrable est envoyé au destinataire.

CreateCeremonyCustomOutput

Nom Chemin d’accès Type Description
URL de cérémonie
 url CeremonyUrl

L’URL que le destinataire doit visiter pour lancer la cérémonie

EnvelopeId

ID de l’enveloppe.

ID de l’enveloppe.

ID d’enveloppe
string

EnvelopeTitle

Titre de cette enveloppe. Cela peut être présenté aux destinataires.

Titre de cette enveloppe. Cela peut être présenté aux destinataires.

Titre de l’enveloppe
string

EnvelopeLabel

Étiquette personnalisée donnée à l’enveloppe pour faciliter l’identification. Les étiquettes sont utilisées en interne et ne sont pas affichées aux destinataires.

Étiquette personnalisée donnée à l’enveloppe pour faciliter l’identification. Les étiquettes sont utilisées en interne et ne sont pas affichées aux destinataires.

Étiquette d’enveloppe
string

EnvelopeMessage

Message qui sera envoyé aux destinataires.

Message qui sera envoyé aux destinataires.

Message d’enveloppe
string

EnveloppeRouting

Ordre dans lequel les destinataires signent l’enveloppe. Il peut être parallèle, où tous les destinataires peuvent signer simultanément ou séquentiellement, où les destinataires se signent l’un après l’autre.

Ordre dans lequel les destinataires signent l’enveloppe. Il peut être parallèle, où tous les destinataires peuvent signer simultanément ou séquentiellement, où les destinataires se signent l’un après l’autre.

Routage de l’enveloppe
string

EnvelopeTimezone

Fuseau horaire à utiliser pour les horodatages dans les livrables. S’il n’est pas spécifié, le décalage de fuseau horaire par défaut du compte est utilisé. https://signatureapi.com/docs/localization/timezone

Fuseau horaire à utiliser pour les horodatages dans les livrables. S’il n’est pas spécifié, le décalage de fuseau horaire par défaut du compte est utilisé. https://signatureapi.com/docs/localization/timezone

Fuseau horaire
string

EnvelopeTimestampFormat

Format de date et d’heure à utiliser dans les horodatages pour les livrables. S’il n’est pas spécifié, le format d’horodatage par défaut du compte est utilisé. https://signatureapi.com/docs/localization/timestamp_format

Format de date et d’heure à utiliser dans les horodatages pour les livrables. S’il n’est pas spécifié, le format d’horodatage par défaut du compte est utilisé. https://signatureapi.com/docs/localization/timestamp_format

Format d’horodatage
string

EnvelopeSender

Nom Chemin d’accès Type Description
Nom de l’expéditeur
 name string

Nom de l’expéditeur.
Adresse e-mail de l’expéditeur
 email string

Adresse e-mail de l’expéditeur.

EnvelopeStatus

État de l’enveloppe.

État de l’enveloppe.

État de l’enveloppe
string

EnvelopeMode

Les enveloppes en mode test ne sont pas contraignantes et ne sont pas facturées.

Les enveloppes en mode test ne sont pas contraignantes et ne sont pas facturées.

Mode enveloppe
string

Enveloppestopiques

Permet de classer les enveloppes et de filtrer les notifications de webhook.

Nom Chemin d’accès Type Description
Objets
 string

EnvelopeAttestation

Attestation réglementaire ou de conformité

Attestation réglementaire ou de conformité

Attestation d’enveloppe
string

EnvelopeDeliverable

Nom Chemin d’accès Type Description
ID du livrable
 id string

ID du livrable. Utilisez cette option pour télécharger une copie signée de l’enveloppe.

EnvelopeCompletedAt

Heure à laquelle tous les destinataires ont terminé l’enveloppe.

Heure à laquelle tous les destinataires ont terminé l’enveloppe.

Enveloppe terminée à
date-time

DocumentId

ID du document

ID du document

Document ID
string

RecipientId

ID du destinataire.

ID du destinataire.

ID du destinataire
string

RecipientType

Type du destinataire.

Type du destinataire.

Type de destinataire
string

RecipientName

Nom du destinataire.

Nom du destinataire.

Nom du destinataire
string

RecipientEmail

Adresse e-mail du destinataire.

Adresse e-mail du destinataire.

E-mail du destinataire
string

RecipientKey

Clé qui identifie un destinataire dans une enveloppe.

Clé qui identifie un destinataire dans une enveloppe.

Clé de destinataire
string

RecipientStatus

État du destinataire.

État du destinataire.

État du destinataire
string

RecipientCeremonyCreation

Comment les cérémonies d’un destinataire sont créées.

Comment les cérémonies d’un destinataire sont créées.

Création d’une cérémonie de destinataire
string

RecipientDeliveryType

Comment le livrable est envoyé au destinataire.

Comment le livrable est envoyé au destinataire.

Type de remise du destinataire
string

RecipientCompletedAt

Heure à laquelle le destinataire a terminé l’enveloppe.

Heure à laquelle le destinataire a terminé l’enveloppe.

Destinataire terminé à l’adresse
date-time

LivrableId

ID du livrable.

ID du livrable.

ID du livrable
string

DeliverableType

Type du livrable.

Type du livrable.

Type de livrable
string

LivrableStatus

État du livrable.

État du livrable.

État du livrable
string

LivrableFileContent

Contenu du fichier du livrable. Utilisez-la pour enregistrer une copie signée de l’enveloppe.

Contenu du fichier du livrable. Utilisez-la pour enregistrer une copie signée de l’enveloppe.

Contenu du fichier
byte

CérémonieUrl

L’URL que le destinataire doit visiter pour lancer la cérémonie

L’URL que le destinataire doit visiter pour lancer la cérémonie

URL de cérémonie
string

CaptureValue

Valeur de la capture d’entrée du destinataire

Valeur de la capture d’entrée du destinataire

Valeur de capture
string

NotificationForEnvelopeCreated

Nom Chemin d’accès Type Description
ID de l’événement
 id EventId

ID de l'événement.
Horodateur d’événements
 timestamp EventTimestamp

Date et heure de l’événement, au format ISO 8601.
Type d'événement
 type EventType

le type de l'événement ;
ID d’enveloppe
 data.envelope_id EventEnvelopeId

L’ID de l’enveloppe à laquelle cet événement fait référence.

NotificationForEnvelopeStarted

Nom Chemin d’accès Type Description
ID de l’événement
 id EventId

ID de l'événement.
Horodateur d’événements
 timestamp EventTimestamp

Date et heure de l’événement, au format ISO 8601.
Type d'événement
 type EventType

le type de l'événement ;
ID d’enveloppe
 data.envelope_id EventEnvelopeId

L’ID de l’enveloppe à laquelle cet événement fait référence.

NotificationForEnvelopeCompleted

Nom Chemin d’accès Type Description
ID de l’événement
 id EventId

ID de l'événement.
Horodateur d’événements
 timestamp EventTimestamp

Date et heure de l’événement, au format ISO 8601.
Type d'événement
 type EventType

le type de l'événement ;
ID d’enveloppe
 data.envelope_id EventEnvelopeId

L’ID de l’enveloppe à laquelle cet événement fait référence.

NotificationForEnvelopeFailed

Nom Chemin d’accès Type Description
ID de l’événement
 id EventId

ID de l'événement.
Horodateur d’événements
 timestamp EventTimestamp

Date et heure de l’événement, au format ISO 8601.
Type d'événement
 type EventType

le type de l'événement ;
ID d’enveloppe
 data.envelope_id EventEnvelopeId

L’ID de l’enveloppe à laquelle cet événement fait référence.
Détail
 data.detail string

Informations sur l’échec.

NotificationForEnvelopeCanceled

Nom Chemin d’accès Type Description
ID de l’événement
 id EventId

ID de l'événement.
Horodateur d’événements
 timestamp EventTimestamp

Date et heure de l’événement, au format ISO 8601.
Type d'événement
 type EventType

le type de l'événement ;
ID d’enveloppe
 data.envelope_id EventEnvelopeId

L’ID de l’enveloppe à laquelle cet événement fait référence.

NotificationForRecipientReleased

Nom Chemin d’accès Type Description
ID de l’événement
 id EventId

ID de l'événement.
Horodateur d’événements
 timestamp EventTimestamp

Date et heure de l’événement, au format ISO 8601.
Type d'événement
 type EventType

le type de l'événement ;
ID d’enveloppe
 data.envelope_id EventEnvelopeId

L’ID de l’enveloppe à laquelle cet événement fait référence.
ID du destinataire
 data.object_id EventRecipientId

L’ID du destinataire auquel cet événement fait référence.
Type de destinataire
 data.recipient_type EventRecipientType

Le type de destinataire auquel cet événement fait référence.
Clé de destinataire
 data.recipient_key EventRecipientKey

La clé du destinataire auquel cet événement fait référence.

NotificationForRecipientSent

Nom Chemin d’accès Type Description
ID de l’événement
 id EventId

ID de l'événement.
Horodateur d’événements
 timestamp EventTimestamp

Date et heure de l’événement, au format ISO 8601.
Type d'événement
 type EventType

le type de l'événement ;
ID d’enveloppe
 data.envelope_id EventEnvelopeId

L’ID de l’enveloppe à laquelle cet événement fait référence.
ID du destinataire
 data.object_id EventRecipientId

L’ID du destinataire auquel cet événement fait référence.
Type de destinataire
 data.recipient_type EventRecipientType

Le type de destinataire auquel cet événement fait référence.
Clé de destinataire
 data.recipient_key EventRecipientKey

La clé du destinataire auquel cet événement fait référence.

NotificationForRecipientCompleted

Nom Chemin d’accès Type Description
ID de l’événement
 id EventId

ID de l'événement.
Horodateur d’événements
 timestamp EventTimestamp

Date et heure de l’événement, au format ISO 8601.
Type d'événement
 type EventType

le type de l'événement ;
ID d’enveloppe
 data.envelope_id EventEnvelopeId

L’ID de l’enveloppe à laquelle cet événement fait référence.
ID du destinataire
 data.object_id EventRecipientId

L’ID du destinataire auquel cet événement fait référence.
Type de destinataire
 data.recipient_type EventRecipientType

Le type de destinataire auquel cet événement fait référence.
Clé de destinataire
 data.recipient_key EventRecipientKey

La clé du destinataire auquel cet événement fait référence.

NotificationForRecipientReject

Nom Chemin d’accès Type Description
ID de l’événement
 id EventId

ID de l'événement.
Horodateur d’événements
 timestamp EventTimestamp

Date et heure de l’événement, au format ISO 8601.
Type d'événement
 type EventType

le type de l'événement ;
ID d’enveloppe
 data.envelope_id EventEnvelopeId

L’ID de l’enveloppe à laquelle cet événement fait référence.
ID du destinataire
 data.object_id EventRecipientId

L’ID du destinataire auquel cet événement fait référence.
Type de destinataire
 data.recipient_type EventRecipientType

Le type de destinataire auquel cet événement fait référence.
Clé de destinataire
 data.recipient_key EventRecipientKey

La clé du destinataire auquel cet événement fait référence.
Reason
 data.reason string

Explication du destinataire du rejet.

NotificationForRecipientBounced

Nom Chemin d’accès Type Description
ID de l’événement
 id EventId

ID de l'événement.
Horodateur d’événements
 timestamp EventTimestamp

Date et heure de l’événement, au format ISO 8601.
Type d'événement
 type EventType

le type de l'événement ;
ID d’enveloppe
 data.envelope_id EventEnvelopeId

L’ID de l’enveloppe à laquelle cet événement fait référence.
ID du destinataire
 data.object_id EventRecipientId

L’ID du destinataire auquel cet événement fait référence.
Type de destinataire
 data.recipient_type EventRecipientType

Le type de destinataire auquel cet événement fait référence.
Clé de destinataire
 data.recipient_key EventRecipientKey

La clé du destinataire auquel cet événement fait référence.
Détail
 data.detail string

Informations sur le rebond.

NotificationForRecipientFailed

Nom Chemin d’accès Type Description
ID de l’événement
 id EventId

ID de l'événement.
Horodateur d’événements
 timestamp EventTimestamp

Date et heure de l’événement, au format ISO 8601.
Type d'événement
 type EventType

le type de l'événement ;
ID d’enveloppe
 data.envelope_id EventEnvelopeId

L’ID de l’enveloppe à laquelle cet événement fait référence.
ID du destinataire
 data.object_id EventRecipientId

L’ID du destinataire auquel cet événement fait référence.
Type de destinataire
 data.recipient_type EventRecipientType

Le type de destinataire auquel cet événement fait référence.
Clé de destinataire
 data.recipient_key EventRecipientKey

La clé du destinataire auquel cet événement fait référence.
Détail
 data.detail string

Informations sur l’échec.

NotificationForRecipientReplaced

Nom Chemin d’accès Type Description
ID de l’événement
 id EventId

ID de l'événement.
Horodateur d’événements
 timestamp EventTimestamp

Date et heure de l’événement, au format ISO 8601.
Type d'événement
 type EventType

le type de l'événement ;
ID d’enveloppe
 data.envelope_id EventEnvelopeId

L’ID de l’enveloppe à laquelle cet événement fait référence.
ID du destinataire
 data.object_id EventRecipientId

L’ID du destinataire auquel cet événement fait référence.
Type de destinataire
 data.recipient_type EventRecipientType

Le type de destinataire auquel cet événement fait référence.
Clé de destinataire
 data.recipient_key EventRecipientKey

La clé du destinataire auquel cet événement fait référence.
Nouvel ID de destinataire
 data.new_recipient_id string

ID du nouveau destinataire.

NotificationForRecipientResent

Nom Chemin d’accès Type Description
ID de l’événement
 id EventId

ID de l'événement.
Horodateur d’événements
 timestamp EventTimestamp

Date et heure de l’événement, au format ISO 8601.
Type d'événement
 type EventType

le type de l'événement ;
ID d’enveloppe
 data.envelope_id EventEnvelopeId

L’ID de l’enveloppe à laquelle cet événement fait référence.
ID du destinataire
 data.object_id EventRecipientId

L’ID du destinataire auquel cet événement fait référence.
Type de destinataire
 data.recipient_type EventRecipientType

Le type de destinataire auquel cet événement fait référence.
Clé de destinataire
 data.recipient_key EventRecipientKey

La clé du destinataire auquel cet événement fait référence.

NotificationForDeliverableGenerated

Nom Chemin d’accès Type Description
ID de l’événement
 id EventId

ID de l'événement.
Horodateur d’événements
 timestamp EventTimestamp

Date et heure de l’événement, au format ISO 8601.
Type d'événement
 type EventType

le type de l'événement ;
ID d’enveloppe
 data.envelope_id EventEnvelopeId

L’ID de l’enveloppe à laquelle cet événement fait référence.
ID du livrable
 data.object_id EventDeliverableId

L’ID du livrable auquel cet événement fait référence.

NotificationForDeliverableFailed

Nom Chemin d’accès Type Description
ID de l’événement
 id EventId

ID de l'événement.
Horodateur d’événements
 timestamp EventTimestamp

Date et heure de l’événement, au format ISO 8601.
Type d'événement
 type EventType

le type de l'événement ;
ID d’enveloppe
 data.envelope_id EventEnvelopeId

L’ID de l’enveloppe à laquelle cet événement fait référence.
ID du livrable
 data.object_id EventDeliverableId

L’ID du livrable auquel cet événement fait référence.
Détail
 data.detail string

Informations sur l’échec.

EventId

ID de l'événement.

ID de l'événement.

ID de l’événement
string

EventTimestamp

Date et heure de l’événement, au format ISO 8601.

Date et heure de l’événement, au format ISO 8601.

Horodateur d’événements
date-time

EventType

le type de l'événement ;

le type de l'événement ;

Type d'événement
string

EventEnvelopeId

L’ID de l’enveloppe à laquelle cet événement fait référence.

L’ID de l’enveloppe à laquelle cet événement fait référence.

ID d’enveloppe
string

EventRecipientId

L’ID du destinataire auquel cet événement fait référence.

L’ID du destinataire auquel cet événement fait référence.

ID du destinataire
string

EventRecipientType

Le type de destinataire auquel cet événement fait référence.

Le type de destinataire auquel cet événement fait référence.

Type de destinataire
string

EventRecipientKey

La clé du destinataire auquel cet événement fait référence.

La clé du destinataire auquel cet événement fait référence.

Clé de destinataire
string

EventDeliverableId

L’ID du livrable auquel cet événement fait référence.

L’ID du livrable auquel cet événement fait référence.

ID du livrable
string

objet

Il s’agit du type 'object'.