Sleamhnú go príomh-ábhar

Rian Doiciméad agus Saoilseal Faighteora le Fo-scríbhinní

Bain úsáid as fo-scríbhinní GraphQL chun nuashonruithe saoilshaoil i bhfíor-am a fháil, ar nós:

  • cruthú doiciméid
  • cruthú PDF deiridh
  • diúltú doiciméid
  • ríomhphost faighteora seolta
  • cuairt a thabhairt ag faighteoir
  • comhlíonadh faighteora
  • diúltú faighteora
  • ríomhphost faighteora oscailte

Maidir leis an gconradh pacáiste ginearálta, féach:

Soláthair agus Catagóirí

Is minic a sheoltar imeachtaí saoilshaoil ar:

  • subscribeGroupFeed

Féadfar cuid de na himeachtaí saoilshaoil a scaipeadh freisin go:

  • subscribeUserFeed

Catagóirí:

  • documentLifecycle
  • recipientLifecycle

Ainmneacha Imeachtaí

Saoilshaoil Doiciméid

  • documentCreated
  • documentFinalPdfCreated
  • documentRejected

Saoilshaoil Faighteora

  • recipientSentEmail
  • recipientVisiting
  • recipientCompleted
  • recipientRejected
  • recipientEmailOpened

Cruthanna Pacáiste

Saoilshaoil Doiciméid

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

Saoilshaoil Faighteora

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

Oibríocht Fo-scríbhinne

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

Sampla 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;
}
}
};

Cathain le Húsáid

Tá sé úsáideach é seo a dhéanamh nuair is mian leat:

  • liosta doiciméad nó soláthar gníomhaíochta a nuashonrú i bhfíor-am
  • taispeáint imeachtaí rannpháirteachta faighteora gan anailís leanúnach
  • freagairt láithreach nuair atá PDF deiridh réidh
  • tiomáint fógraí sreabhadh oibre i painéal