Verfolgen Sie den Lebenszyklus von Dokument und Empfänger mit Subscriptions
Verwenden Sie GraphQL-Subscriptions, um Echtzeit-Updates zum Lebenszyklus zu erhalten, wie zum Beispiel:
- Dokumenterstellung
- Erstellung der finalen PDF
- Dokumentablehnung
- E-Mail an Empfänger gesendet
- Empfänger besucht
- Empfänger abgeschlossen
- Empfänger abgelehnt
- E-Mail des Empfängers geöffnet
Für den allgemeinen Payload-Vertrag siehe:
Feeds und Kategorien
Lebenszyklusereignisse werden typischerweise übermittelt auf:
subscribeGroupFeed
Einige Lebenszyklusereignisse können auch verteilt werden an:
subscribeUserFeed
Kategorien:
documentLifecyclerecipientLifecycle
Ereignisnamen
Dokumenten-Lebenszyklus
documentCreateddocumentFinalPdfCreateddocumentRejected
Empfänger-Lebenszyklus
recipientSentEmailrecipientVisitingrecipientCompletedrecipientRejectedrecipientEmailOpened
Payload-Strukturen
Dokumenten-Lebenszyklus
{
"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"
}
}
Empfänger-Lebenszyklus
{
"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"
}
}
Subscription-Operation
subscription SubscribeGroupFeed($groupId: String!) {
subscribeGroupFeed(groupId: $groupId) {
groupId
data
}
}
JavaScript-Beispiel
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;
}
}
};
Wann man dies verwendet
Dies ist nützlich, wenn Sie:
- eine Dokumentenliste oder einen Aktivitätsfeed in Echtzeit aktualisieren möchten
- Empfänger-Engagement-Ereignisse ohne Polling anzeigen wollen
- sofort reagieren möchten, wenn eine finale PDF bereitsteht
- Workflow-Benachrichtigungen in einem Dashboard auslösen wollen