Guide d'utilisation Annuler

Configuration d’un nouveau webhook

 

Guide Adobe Acrobat Sign

Nouveautés

Commencer

Administration

Envoi, signature et gestion des accords

Fonctionnalités et workflows d’accord avancés

Intégration à d’autres produits

Développeur Acrobat Sign

Assistance et dépannage

Options de configuration

La configuration du webhook nécessite la définition de cinq éléments :

  • Nom : il est conseillé d’utiliser un nom intuitif que les autres administrateurs peuvent facilement comprendre.
  • Portée : envergure du webhook. Le compte et le groupe sont disponibles dans l’interface.
    • L’API prend en charge les portées Compte, Groupe, Utilisateur et Ressource.
    • Une seule portée par webhook peut être définie.
  • URL : URL cible à laquelle Acrobat Sign a envoyé la payload JSON.
  • Événements : déclencheur qui provoque la création du fichier JSON par Acrobat Sign et son envoi à l’URL.
    • Chaque événement génère une payload différente en fonction de l’événement de déclenchement.
    • Plusieurs événements peuvent être inclus dans un webhook.
  • Paramètres de notification : les Paramètres de notification identifient les sections de la payload JSON Événement, ce qui vous permet de sélectionner uniquement les sections de l’événement qui sont importantes pour ce webhook (et donc de réduire les données inutiles dans votre URL).

Une fois le webhook défini, cliquez sur Enregistrer. Le nouveau webhook commence à réagir pour déclencher immédiatement des événements. 

Remarque :

configurez l’URL du webhook pour répondre aux demandes de vérification et de notification de webhook conformément au protocole de vérification expliqué ci-dessus. ID client (ID d’application) qui est envoyé aux webhooks créés à partir de l’application web Acrobat Sign : UB7E5BXCXY.

Configuration du webhook

Portées

  • Compte : tous les événements souscrits survenant dans le compte déclenchent l’envoi.
    • Les administrateurs de compte sont autorisés à afficher tous les webhooks définis pour le compte et tous les groupes de ce compte.
  • Groupe : tous les événements souscrits survenant dans le groupe déclenchent l’envoi. REMARQUE : les webhooks de portée de groupe existent uniquement pour ce groupe.
    • Les administrateurs de groupe voient uniquement les webhooks dédiés à leur groupe. Ils ne peuvent pas voir les webhooks au niveau du compte ni ceux qui sont liés à d’autres groupes.
    • Les comptes pour lesquels la fonctionnalité Utilisateurs dans plusieurs groupes est activée voient l’option permettant de définir le groupe auquel la portée doit être appliquée.
  • Compte utilisateur : tous les événements souscrits pour un compte utilisateur déclenchent l’envoi. Les webhooks au niveau de l’utilisateur peuvent uniquement être créés via une API.
  • Webhook de niveau ressource : il est créé pour une ressource spécifique. Les événements propres à cette ressource sont envoyés vers l’URL du webhook. Les webhooks de niveau ressource peuvent uniquement être créés via une API.

URL

Une URL de webhook est un serveur qui écoute les messages de notification HTTPS POST entrants qui sont déclenchés lorsque des événements se produisent.

Vous avez besoin de cette URL pour abonner votre webhook aux événements.

  • Le client doit inclure une URL HTTPS à laquelle Acrobat Sign peut envoyer une requête POST. Cette URL doit être disponible sur l’Internet public.  
    • Par exemple, les URI 127.0.0.1 et localhost ne fonctionnent pas.
    • Le point de terminaison de l’URL doit être à l’écoute sur le port 443 ou 8443 (décidé par le client lors de la définition de l’URL de rappel).
  • Assurez-vous que le webhook prend en charge les requêtes POST pour les notifications d’événements entrants et les requêtes GET pour la demande de vérification.
  • L’URL ne doit pas être bloquée par un pare-feu.

Événements

Vous trouverez ci-dessous les événements qui peuvent déclencher une transmission de type push vers l’URL du webhook, regroupés par objet et répertoriés dans l’ordre trouvé dans l’interface utilisateur.

La valeur située à gauche correspond à celle qui apparaît dans l’interface utilisateur d’Acrobat Sign. La valeur située à droite correspond au nom du webhook dans l’API.

Pour en savoir plus sur les webhooks et leurs payloads, consultez le Guide pour les développeurs Acrobat Sign.

Accords :

Élément de l’interface utilisateur Nom du webhook
Tous les événements liés à l’accord AGREEMENT_ALL
Accord créé AGREEMENT_CREATED
Accord envoyé AGREEMENT_ACTION_REQUESTED
Participant à l’accord terminé AGREEMENT_ACTION_COMPLETED
Flux de l’accord terminé AGREEMENT_WORKFLOW_COMPLETED
Accord expiré AGREEMENT_EXPIRED
Accord supprimé AGREEMENT_DOCUMENTS_DELETED
Accord annulé AGREEMENT_RECALLED
Accord refusé AGREEMENT_REJECTED
Accord partagé AGREEMENT_SHARED
Partage d’accord annulé AGREEMENT_UNSHARE
Partage d’accord annulé automatiquement AGREEMENT_UNSHARE_AUTO
Accord délégué AGREEMENT_ACTION_DELEGATED
Participant à l’accord modifié AGREEMENT_ACTION_REPLACED_SIGNER
Accord modifié AGREEMENT_MODIFIED
Modification de l’accord réceptionnée AGREEMENT_USER_ACK_AGREEMENT_MODIFIED
Courrier électronique de l’accord consulté AGREEMENT_EMAIL_VIEWED
Courrier électronique de l’accord non remis AGREEMENT_EMAIL_BOUNCED
Document de l’accord consulté AGREEMENT_DOCUMENTS_VIEWED
Document de l’accord consulté lorsqu’un mot de passe a été appliqué pour afficher le document AGREEMENT_DOCUMENTS_VIEWED_PASSWORD_PROTECTED
Échec de la création de l’accord AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM
Accord synchronisé après l’événement hors ligne AGREEMENT_OFFLINE_SYNC
Accord sécurisé AGREEMENT_VAULTED
Identité sociale du participant à l’accord authentifiée AGREEMENT_WEB_IDENTITY_AUTHENTICATED
Authentification du participant à l’accord fondée sur les connaissances AGREEMENT_KBA_AUTHENTICATED
OTP par e-mail au participant à l’accord authentifié
AGREEMENT_EMAIL_OTP_AUTHENTICATED
Expiration de l’accord mise à jour AGREEMENT_EXPIRATION_UPDATED
Rappel d’accord envoyé AGREEMENT_REMINDER_SENT
Nom du signataire de l’accord modifié par le signataire AGREEMENT_SIGNER_NAME_CHANGED_BY_SIGNER
Rappel d’accord lancé AGREEMENT_REMINDER_INITIATED
   
Webhooks d’accord uniquement disponibles via l’API
Élément de l’interface utilisateur Nom du webhook
s.o.
AGREEMENT_READY_TO_NOTARIZE
s.o.
AGREEMENT_READY_TO_VAULT

 

Envoi en masse :

Élément de l’interface utilisateur Nom du webhook
Envoi en masse - Tous les événements MEGASIGN_ALL
Envoi en masse - Créé
MEGASIGN_CREATED
Envoi en masse - Partagé
MEGASIGN_SHARED
Envoi en masse - Rappelé
MEGASIGN_RECALLED
Rappel envoyé pour Envoi en masse MEGASIGN_REMINDER_SENT
Rappel lancé pour Envoi en masse MEGASIGN_REMINDER_INITIATED

 

Formulaires web :

Élément de l’interface utilisateur Nom du webhook
Formulaire web - Tous les événements WIDGET_ALL
Formulaire web créé
WIDGET_CREATED
Formulaire web activé
WIDGET_ENABLED
Formulaire web désactivé
WIDGET_DISABLED
Formulaire web modifié
WIDGET_MODIFIED
Formulaire web partagé
WIDGET_SHARED
Échec de création du formulaire web
WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM

 

Modèles de bibliothèque (API uniquement) :

Élément de l’interface utilisateur Nom du webhook
s.o. LIBRARY_DOCUMENT_ALL
s.o. LIBRARY_DOCUMENT_CREATED
s.o. LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM
s.o. LIBRARY_DOCUMENT_MODIFIED

 

Paramètres de notification

Les paramètres de notification vous permettent de personnaliser la payload JSON en fonction d’éléments spécifiques de l’événement.

Par exemple, dans un événement Participant à l’accord modifié, il se peut que vous ne souhaitiez que les Informations sur l’accord et les Informations sur les participants, sans les Informations sur les documents, afin de réduire la taille totale du fichier JSON envoyé à l’URL du webhook.

 

  • Accord
    • Informations sur l’accord : informations détaillées sur l’accord, basées sur l’état de celui-ci au moment du déclenchement de l’événement.
    • Infos sur les documents de l’accord : inclut toutes les informations sur les documents générés suite à l’événement.
    • Infos sur les participants à l’accord : inclut toutes les informations sur les participants à la suite de l’événement.
    • Document signé de l’accord : fournit le PDF signé. 
      • Applicable à Flux de l’accord terminé et Tous les événements liés à l’accord.
  • Envoyer en masse
    • Infos Envoyer en masse : informations détaillées sur l’objet Envoyer en masse qui a déclenché l’événement.
  • Formulaire web
    • Informations sur le widget : informations détaillées sur le formulaire web qui a déclenché l’événement.
    • Informations sur les documents du widget : informations sur les documents associées au formulaire web.
    • Informations sur les participants au widget : informations sur les participants définis dans le formulaire web.

Recevez de l’aide plus rapidement et plus facilement

Nouvel utilisateur ?