Webhooks Gestion Locative — Automatisez vos flux en temps réel

Catalogue des événements

Événement	Objet	Déclencheur
lease.created	Bail	Nouveau bail créé via POST /leases
lease.signature.initiated	Bail	Workflow de signature démarré
lease.signature.completed	Bail	Tous les signataires ont signé
lease.expired	Bail	30 jours avant la date de fin
rent.due	Loyer	J de l’échéance mensuelle
rent.overdue	Loyer	J+1 sans paiement
rent.paid	Loyer	Paiement enregistré
lessee.onboarded	Locataire	Dossier locataire validé

Exemple — Payload lease.signature.completed

{
  "event": "lease.signature.completed",
  "timestamp": "2025-09-01T15:42:11Z",
  "data": {
    "lease_id": "550e8400-e29b-41d4-a716-446655440000",
    "pdf_url": "https://api.faireplace.com/api/leases/550e.../pdf",
    "signers": [
      {"type": "PROPRIETAIRE", "signed_at": "2025-09-01T14:10:00Z"},
      {"type": "LOCATAIRE",    "signed_at": "2025-09-01T15:42:11Z"}
    ]
  }
}

Vérifier la signature HMAC du webhook

Vérification HMAC-SHA256 (Node.js)

const crypto = require('crypto');

function verifyWebhook(payload, signature, secret) {
  const expected = crypto
    .createHmac('sha256', secret)
    .update(JSON.stringify(payload))
    .digest('hex');
  return `sha256=${expected}` === signature;
}