Aller au contenu principal
Webhooks

Recevoir un événement

Revel’Home pousse les événements du cycle de vie d'un projet vers une URL unique que vous exposez. Tous les types d'événements arrivent sur cette même URL ; c'est le champ type de l'enveloppe qui les distingue.

WEBHOOK
event

ℹ️ L'installation d'un webhook passe par nous. Il n'existe pas d'API de souscription : l'URL de destination, la liste des événements souscrits et les en-têtes éventuels sont configurés par l'équipe Revel’Home. Adressez votre demande à l'équipe en précisant l'organisation concernée, l'URL de destination (HTTPS), les types d'événements souhaités et les en-têtes d'authentification à joindre.

Requête

POST de l'enveloppe en application/json, avec les en-têtes :

En-têteValeur
Content-Typeapplication/json
User-AgentRevel'Home
libresles en-têtes configurés pour votre souscription

Les en-têtes libres sont le moyen d'authentifier l'appel : nous joignons à chaque envoi les en-têtes que vous nous indiquez (par exemple Authorization: Bearer <votre_jeton>). Le nom se sépare de la valeur au premier deux-points : la valeur peut elle-même en contenir.

Livraison

L'envoi est asynchrone et sans relance : un événement dont l'appel échoue (endpoint injoignable, réponse non 2xx, expiration) n'est pas réémis. Répondez 2xx rapidement et traitez le contenu en différé de votre côté. Les événements ne sont pas ordonnés, et un même événement peut vous parvenir plus d'une fois. id identifie l'envoi, pas l'événement : une redélivrance en porte un nouveau, et il ne déduplique donc rien. Reconnaissez un doublon sur le couple type + data.id.

À venir

Ces points ne font pas partie du contrat actuel. Ils sont listés pour que vous puissiez les anticiper ; rien ne doit en dépendre aujourd'hui.

  • Signature cryptographique des charges utiles — à venir. L'authentification repose aujourd'hui sur les seuls en-têtes fixes de votre souscription.
  • payment.requested, payment.validated, reception.signed — émis, mais sans contenu : leur data est vide, et la charge utile reste à définir.
  • project.updated, calendar_event.temporary, levee_reserves.signed — déclarés côté Revel’Home, jamais émis à ce jour.
  • customer.updated — nom réservé à un flux entrant ; il n'est jamais poussé vers un partenaire.

Payload

application/json
createdintegerobligatoire

Horodatage UNIX (secondes) de production de l'événement.

Exemple: 1753082400
dataobjectobligatoire

Contenu de l'événement, dont la forme dépend de type.

idstringobligatoire

Identifiant de l'envoi. Il change à chaque redélivrance du même événement : pour dédupliquer, voir type + data.id.

Exemple: 0190f3b4-8e2a-7c31-9f44-2b6d1c8a5e07
organization_idintegerobligatoire

Identifiant de l'organisation Revel’Home émettrice.

Exemple: 17
typeenum<string>obligatoire

Type de l'événement. La forme de data en découle :

typedata
project.created, project.cancelled, project.completed, project.invitation_sentprojet
quote.added, quote.read, quote.accepted, quote.declined, quote.cancelled, quote.deleteddevis
calendar_event.scheduled, calendar_event.updated, calendar_event.cancelled, calendar_event.deletedRDV
Options disponibles: project.created, project.cancelled, project.completed, project.invitation_sent, quote.added, quote.read, quote.accepted, quote.declined, quote.cancelled, quote.deleted, calendar_event.scheduled, calendar_event.updated, calendar_event.cancelled, calendar_event.deleted
Exemple: quote.accepted

Événement reçu. Aucun statut de réponse n'est inspecté ni journalisé : quel que soit le code que vous rendez, l'envoi n'est ni rejoué ni signalé. Un endpoint qui échoue perd l'événement en silence.

Besoin d'aide supplémentaire ? Demander à l'équipe