Webhooks
Chaque changement d’état, livré.
21 types d’événements. Signés en HMAC-SHA256. Livrés depuis une file durable, avec de nouvelles tentatives espacées en cas d’échec. Chaque tentative et son code de réponse sont consignés.
Catalogue des événements.
Tous les événements partent de la même file de livraison, avec les mêmes en-têtes et le même mode de signature.
| Événement | Description |
|---|---|
envelope.created | dossier créé |
envelope.sent | envoyé aux destinataires |
envelope.opened | un destinataire a ouvert le lien |
envelope.viewed_document | un destinataire a consulté un document |
envelope.identity_verified | un signataire a réussi la vérification par code |
envelope.field_filled | un champ a été rempli |
envelope.document_signed | un document a été signé |
envelope.all_signed | tous les signataires ont terminé |
envelope.document_completed | un document est terminé |
envelope.completed | dossier terminé |
envelope.copied | une copie a été envoyée à un destinataire en copie |
envelope.reminded | un rappel a été envoyé |
envelope.declined | un signataire a refusé |
envelope.expired | délai écoulé sans signature |
envelope.voided | l’expéditeur l’a annulé |
envelope.recalled | l’expéditeur l’a rappelé en brouillon |
envelope.id_verified | un signataire a réussi la vérification d’identité |
envelope.id_verification_failed | la vérification d’identité a échoué |
envelope.recipient_updated | les coordonnées d’un destinataire ont changé |
envelope.recipient_approved | un destinataire a approuvé le document |
envelope.recipient_viewed | un lecteur a ouvert le document |
Exemple de contenu.
envelope.completed est l’événement le plus courant. data contient ce que l’événement d’audit a enregistré : ses clés varient donc selon le type d’événement. Abonnez-vous une seule fois; en cas d’échec, nous faisons de nouvelles tentatives espacées avant de marquer la livraison comme échouée.
// Headers
X-VG-Signature: sha256=4c2a9bd3…71ff
X-VG-Delivery-Id: 8f4a2c1e-9b3d-4f02-a71c-2d5e6b8c0a19
// Body
{
"id": "8f4a2c1e-9b3d-4f02-a71c-2d5e6b8c0a19",
"event": "envelope.completed",
"envelope_id": "3f9c1d84-0b27-4a6e-9d51-7c2f8e4b1a03",
"workspace_id": "b41e7d90-5c38-42af-8e16-9a0d3f5c7b28",
"external_ref": "deal_142",
"timestamp": "2026-05-02T16:48:11.204Z",
"data": {
"recipient_id": "c72b5a10-8e64-4d39-b0f7-1e5a9c3d6482",
"actor_email": "signer@example.com",
"ip_address": "203.0.113.10",
"user_agent": "Mozilla/5.0 …",
"scope": "envelope"
}
}Garanties de livraison.
Signé en HMAC-SHA256
Chaque livraison contient un en-tête X-VG-Signature, une empreinte HMAC-SHA256 du corps brut. Vérifiez-la avant de vous fier au contenu.
Nouvelles tentatives espacées
Une livraison est tentée jusqu’à 3 fois (nouvelles tentatives après environ 1 et 5 minutes), puis marquée comme échouée.
Registre des livraisons
Chaque tentative et son code de réponse sont consignés, ce qui permet de diagnostiquer une livraison échouée.
Idempotent par identifiant de livraison
Chaque livraison porte un en-tête X-VG-Delivery-Id, repris comme "id" dans le corps et inchangé d’une tentative à l’autre. Conservez-le et ignorez les doublons.
Envoyez votre premier dossier gratuitement.
Commencez avec le forfait gratuit et passez à Pro quand vous en avez besoin.