Formáid Imeachta Síntiúis
Chun tagairt an tseachadáin cháiliúil atá oiriúnach do AI a fheiceáil, féach ar Subscription Event Schema.
Filleann síntiúis GraphQL ar chiseal tanaí seachadta agus ar chiseal eachtra a bhfuil JSON-eencoded ann.
Ciseal Seachadta
Tá freagraí fotha úsáideora cosúil le:
{
"data": "{\"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\"}}",
"userId": "..."
}
Úsáideann freagraí fotha grúp an groupId in ionad userId sa chiseal seachtrach.
Leithníonn an ciseal an cainéal síntiúis. Is é an tsringa data istigh an pacáiste eachtra ceannasach.
Ciseal na hImeachta
Tar éis an data a pharsáil, faigheann tú:
{
"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"
}
}
Réimsí an Chiseal
| Réimse | Cur Síos |
|---|---|
version | Leagan ciseal na himeachta. Faoi láthair 1.0. |
eventId | Aitheantas loighciúil seasta na himeachta. Roinntear cóipeanna den imeacht céanna ag fánuit. |
timestamp | Amstemp imeachta ISO-8601. |
level | Géarchéim na himeachta. Faoi láthair de ghnáth INFO. |
event | Ainm ceannasach na himeachta amhail documentArchived nó uploadCompleted. |
category | Clann na himeachta. Míníonn sé seo conas an data a léirmhíniú. |
groupId | Comhthéacs an ghrúpa nuair atá sé i bhfeidhm. |
userId | Comhthéacs an úsáideora nuair atá sé i bhfeidhm. |
requestId | Aitheantas comhaireamh an iarratais nuair atá sé ar fáil. |
batchId | Comhthéacs an bháisín nuair atá sé ar fáil. |
error | Pacáiste earráide nuair atá sé i bhfeidhm, murar sin null. |
data | Pacáiste sainiúil don chatagóir. |
Catagóirí
Catagóirí reatha:
documentrecipientdocumentLifecyclerecipientLifecycletemplatetaskuploadcredit
Insíonn category duit cén réada nó sreabhadh oibre atá faoi láthair san imeacht. Inseoidh event duit cad a tharla.
Cruthanna Sonraí
Tá data sonrach do chatagóir agus in-aistrithe fútúntach:
- Is féidir le monaróirí réimsí a chur leis le himeacht ama.
- Níor cheart do mhonaróirí réimsí atá ann cheana a bhaint ar bhealach neamh-chomhoiriúnach.
- Ba cheart do thomhaltóirí réimsí nach aithníonn siad a scipeáil.
Cruthanna bunúsacha reatha:
// document
{ "id": "doc..." }
// recipient
{ "id": "rec...", "documentId": "doc..." }
// documentLifecycle
{ "id": "doc...", "documentName": "Example document" }
// recipientLifecycle
{
"id": "rec...",
"documentId": "doc...",
"documentName": "Example document",
"firstName": "Ada",
"lastName": "Lovelace"
}
// template
{ "id": "tpl..." }
// task
{ "id": "tsk...", "code": "TSKPROCESSOK", "documents": [] }
// upload
{ "id": "tmp...", "key": "upload/usr.../tmp....pdf", "code": "UPLOADOK" }
// credit
{ "credit": 172 }
Tá sonraí shaibhir dearbhshaoil faoi láthair líonta go comhsheasmhach do na himeachtaí documentLifecycle agus recipientLifecycle.