Suivre le Cycle de Vie des Documents et Destinataires avec les Abonnements
Utilisez les abonnements GraphQL pour recevoir des mises à jour en temps réel du cycle de vie telles que :
- création de document
- création du PDF final
- rejet de document
- envoi d’email au destinataire
- visite du destinataire
- acheminement du destinataire
- rejet du destinataire
- ouverture de l’email par le destinataire
Pour le contrat général de payload, voir :
Flux et Catégories
Les évènements du cycle de vie sont typiquement livrés sur :
subscribeGroupFeed
Certains évènements du cycle de vie peuvent aussi être diffusés vers :
subscribeUserFeed
Catégories :
documentLifecyclerecipientLifecycle
Noms des Événements
Cycle de vie du document
documentCreateddocumentFinalPdfCreateddocumentRejected
Cycle de vie du destinataire
recipientSentEmailrecipientVisitingrecipientCompletedrecipientRejectedrecipientEmailOpened
Formes du Payload
Cycle de vie du document
{
"version": "1.0",
"eventId": "evt...",
"timestamp": "2026-04-24T10:38:36.822Z",
"level": "INFO",
"event": "documentCreated",
"category": "documentLifecycle",
"groupId": "grp...",
"userId": "usr...",
"requestId": null,
"batchId": null,
"error": null,
"data": {
"id": "doc...",
"documentName": "Example document"
}
}
Cycle de vie du destinataire
{
"version": "1.0",
"eventId": "evt...",
"timestamp": "2026-04-24T10:38:36.822Z",
"level": "INFO",
"event": "recipientVisiting",
"category": "recipientLifecycle",
"groupId": "grp...",
"userId": "usr...",
"requestId": null,
"batchId": null,
"error": null,
"data": {
"id": "rec...",
"documentId": "doc...",
"documentName": "Example document",
"firstName": "Ada",
"lastName": "Lovelace"
}
}
Opération d’Abonnement
subscription SubscribeGroupFeed($groupId: String!) {
subscribeGroupFeed(groupId: $groupId) {
groupId
data
}
}
Exemple en JavaScript
const parseEnvelope = (payload) => {
const raw = payload?.data;
if (!raw) return null;
return typeof raw === 'string' ? JSON.parse(raw) : raw;
};
const handleGroupFeed = ({ data }) => {
const wrapper = data?.subscribeGroupFeed;
const event = parseEnvelope(wrapper);
if (event?.category === 'documentLifecycle') {
switch (event.event) {
case 'documentCreated':
case 'documentFinalPdfCreated':
case 'documentRejected':
console.log('document lifecycle event', event.event, event.data.id);
break;
default:
break;
}
}
if (event?.category === 'recipientLifecycle') {
switch (event.event) {
case 'recipientSentEmail':
case 'recipientVisiting':
case 'recipientCompleted':
case 'recipientRejected':
case 'recipientEmailOpened':
console.log('recipient lifecycle event', event.event, event.data.id);
break;
default:
break;
}
}
};
Quand l’utiliser
Ceci est utile lorsque vous souhaitez :
- mettre à jour en temps réel une liste de documents ou un fil d’activité
- afficher les événements d’engagement des destinataires sans sondage
- réagir immédiatement quand un PDF final est prêt
- piloter les notifications de workflow dans un tableau de bord