Vai al contenuto principale

Tracciare il Ciclo di Vita di Documenti e Destinatari con le Sottoscrizioni

Usa le sottoscrizioni GraphQL per ricevere aggiornamenti in tempo reale sul ciclo di vita come:

  • creazione del documento
  • creazione del PDF finale
  • rigetto del documento
  • invio dell’email al destinatario
  • visita del destinatario
  • completamento del destinatario
  • rigetto del destinatario
  • apertura dell’email da parte del destinatario

Per il contratto generale del payload, vedi:

Feed e Categorie

Gli eventi del ciclo di vita sono tipicamente consegnati su:

  • subscribeGroupFeed

Alcuni eventi del ciclo di vita possono anche essere distribuiti su:

  • subscribeUserFeed

Categorie:

  • documentLifecycle
  • recipientLifecycle

Nomi degli Eventi

Ciclo di vita del documento

  • documentCreated
  • documentFinalPdfCreated
  • documentRejected

Ciclo di vita del destinatario

  • recipientSentEmail
  • recipientVisiting
  • recipientCompleted
  • recipientRejected
  • recipientEmailOpened

Forme del Payload

Ciclo di vita del documento

{
"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"
}
}

Ciclo di vita del destinatario

{
"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"
}
}

Operazione di Sottoscrizione

subscription SubscribeGroupFeed($groupId: String!) {
subscribeGroupFeed(groupId: $groupId) {
groupId
data
}
}

Esempio in 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;
}
}
};

Quando Usarlo

Questo è utile quando vuoi:

  • aggiornare in tempo reale una lista di documenti o un feed di attività
  • mostrare eventi di coinvolgimento del destinatario senza effettuare polling
  • reagire immediatamente quando un PDF finale è pronto
  • guidare le notifiche di flusso di lavoro in una dashboard

Correlati