Recevoir les événements Drime Sign par webhook

Un webhook fait appeler votre serveur par Drime chaque fois qu'il se passe quelque chose sur vos demandes de signature. Chaque appel est un POST JSON, signé avec un secret pour que votre serveur puisse vérifier qu'il vient de Drime.

#Ajouter un webhook

1. Ouvrez Paramètres > Développeurs > Webhooks.

   Depuis Sign, vous pouvez aussi cliquer sur Préférences, ouvrir l'onglet Webhooks, puis Ouvrir les paramètres Développeurs.

2. Cliquez sur Ajouter un webhook.

3. Dans URL de l'endpoint, saisissez l'adresse du serveur qui reçoit les appels.

4. Sous Événements, passez chaque événement à recevoir sur Activé, puis cliquez sur Créer le webhook.

   Webhook créé le confirme.

5. Copiez le secret tout de suite, puis cliquez sur Terminé.

   Secret du webhook, copiez-le maintenant : il n'est affiché qu'une seule fois. Conservez-le en lieu sûr.

#Les événements

#Ce que Drime envoie

Chaque appel porte ces headers :

• X-Drime-Event : l'événement, par exemple envelope.completed ;

• X-Drime-Delivery : le numéro de la livraison ;

• X-Drime-Signature : sha256= suivi du HMAC SHA-256 du corps brut, calculé avec votre secret.

Le corps JSON contient event_type, event_uuid, timestamp et data, le document concerné avec ses signataires. La section Webhooks montre un exemple complet sous Exemple de requête et vérification de signature.

Une livraison peut arriver plusieurs fois : utilisez event_uuid pour ne traiter chaque événement qu'une fois.

#Vérifier la signature

Calculez le HMAC SHA-256 du corps brut de la requête avec votre secret, puis comparez-le au header X-Drime-Signature. Par exemple, en Node.js :

import crypto from 'node:crypto';

function isFromDrime(rawBody, header, secret) {
  const expected = 'sha256=' + crypto.createHmac('sha256', secret).update(rawBody).digest('hex');
  return header.length === expected.length && crypto.timingSafeEqual(Buffer.from(header), Buffer.from(expected));
}

Utilisez le corps tel que reçu, avant toute lecture du JSON.

#Tester et suivre les livraisons

• Envoyer un test envoie un événement de test : Événement de test en file d'attente, consultez le journal des livraisons.

• Livraisons liste chaque appel avec son statut : Succès, En attente ou En erreur. Renvoyer envoie de nouveau une livraison.

• Si votre serveur ne répond pas ou répond par une erreur, Drime réessaie, jusqu'à 10 tentatives sur environ 34 heures.

• L'interrupteur Activé / Désactivé met un webhook en pause sans le supprimer : Webhook en pause le confirme, et Webhook activé quand vous le réactivez.

#Changer le secret ou supprimer le webhook

• Régénérer le secret crée un nouveau secret. L'app prévient : Régénérer le secret ? Votre secret actuel cessera de fonctionner immédiatement. Mettez votre serveur à jour aussitôt.

• Supprimer retire le webhook : Supprimer ce webhook et son historique de livraisons ?

#En cas de problème

#Étapes suivantes

• Créer une application ou connecter des webhooks

• Créer un token d'API

• Ce que contient le certificat d'audit d'un document signé