Passer au contenu principal
Toutes les collectionsAPI & IntégrationsIntégrer l'API à vos outils
Comment utiliser les Webhooks de l’API depuis l’Application ?
Comment utiliser les Webhooks de l’API depuis l’Application ?
Ferdinand avatar
Écrit par Ferdinand
Mis à jour il y a plus de 4 mois

📖 Sommaire

Pour commencer, qu’est-ce qu’un Webhook ?


Avec les Webhooks, soyez notifiés des évènements sur la signature de vos documents directement depuis les solutions ou outils dans lesquelles vous avez intégré l’API.

Concrètement, les Webhooks permettent ainsi d’automatiser vos actions autour de la signature, comme le téléchargement automatique des documents après leur signature, ou bien l’affichage dans un outil tiers qu’un document a été signé sur Yousign.

Comment accéder aux Webhooks depuis l’Application ?


Rendez-vous dans votre menu, puis choisissez “Développeurs”, et cliquez sur “Webhooks”.

S’il s’agit de votre premier Webhook, l’interface vous proposera de créer votre premier Webhook. Si vous avez déjà des Webhooks actifs, ils seront listés dans l’interface. Il suffit de cliquer sur un Webhook pour obtenir le détail.

Comment créer un Webhook ?


Sur l’interface de l’application dédiée aux Webhooks cliquez sur “Créer un Webhook”.

Le premier bouton vous permet d’activer immédiatement, ou de désactiver, le Webhook que vous êtes sur le point de créer.

3 étapes sont ensuite nécessaires pour créer un Webhook:

Commencez par saisir l’URL pour le End-point.

Il s’agit de l’adresse de destination du Webhook à laquelle vous souhaitez envoyer l’évènement concerné par le Webhook.

Cette adresse doit commencer par “https://”

Vous pouvez également ajouter une brève description du Webhook reprenant la raison pour laquelle vous le créer. Elle n’est pas nécessaire au fonctionnement du Webhook mais l’information y sera intégrée.

Sélectionnez ensuite l’environnement du Webhook.

Vous avez le choix entre :

  • Sandbox : L’environnement de test de l’API, vous pourrez faire des essais sur le Webhook avant de l’intégrer en production

  • Production : L’environnement sur lequel votre intégration est live.

Enfin, choisissez les évènements qui déclencheront votre Webhook.

Vous pouvez choisir de sélectionner l’intégralité des évènements listés, ou bien de sélectionner les évènements souhaités un à un manuellement. Choisissez-en autant que nécessaires.

3 types d’évènements sont disponibles :

  1. Les évènements liés à l’invitation de signature

  • signature_request.activated quand le statut de l’invitation de signature passe de “brouillon” à “en cours”

  • signature_request.done quand tous les signataires ont signé le document

  • signature_request.expired quand l’invitation de signature est expirée

  • signature_request.reminder_executed quand un rappel a été envoyé au signataire pour l’inviter à signer

  • signature_request.canceled lorsque l'expéditeur annule l'invitation à signer.

  • signature_request.declined lorsque le signataire refuse de signer

  • signature_request.reactivated lorsque l'expéditeur réactive l'invitation à signer

  • signature_request.deleted lorsque l'invitation à signer est supprimée.

  • signature_request.approved lorsque l'approbateur approuve l'invitation à signer

2. Les évènements liés au signataire

  • signer.notified un signataire spécifique peut désormais signer

  • signer.link_opened un signataire spécifique a ouvert le lien de l’invitation de signature

  • signer.done un signataire spécifique a signé le document

3. Les évènements liés au contact

  • contact.created un contact a été créé (sauf pour les contacts provenant d’un import de CSV)

Finalisez en cliquant sur “Créer un Webhook” ! Vous pourrez ensuite suivre ou modifier votre webhook depuis l’interface de suivi des Webhooks.

Avez-vous trouvé la réponse à votre question ?