Fformat Digwyddiad Cynnwys

Am y cyfeirnod schema canonig sy'n gyfeillgar i AI, gweler Subscription Event Schema.

Mae tanysgrifiadau GraphQL yn dychwelyd lapio dosbarthu tenau a swrth digwyddiad wedi'i godio yn JSON.

Lapio Dosbarthu

Mae ymatebion ffrydiau defnyddwyr yn edrych fel hyn:

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

Mae ymatebion ffrydiau grwp yn defnyddio groupId yn lle userId yn y lapio allanol.

Mae'r lapio yn nodi'r sianel tanysgrifio. Y llinyn data mewnol yw llwyth y digwyddiad canonig.

Swrth Digwyddiad

Ar ôl dadansoddi data, cewch:

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

Meysydd Swrth

Maes	Disgrifiad
version	Fersiwn swrth y digwyddiad. Ar hyn o bryd 1.0.
eventId	ID digwyddiad rhesymegol sefydlog. Mae copïau ffaneiddio o'r un digwyddiad yn rhannu'r un gwerth.
timestamp	Amser-len ddigwyddiad ISO-8601.
level	Difrifoldeb y digwyddiad. Ar hyn o bryd fel arfer INFO.
event	Enw digwyddiad canonig megis documentArchived neu uploadCompleted.
category	Teulu digwyddiad. Mae hwn yn disgrifio sut i ddehongli data.
groupId	Cyd-destun grŵp pan fo'n berthnasol.
userId	Cyd-destun defnyddiwr pan fo'n berthnasol.
requestId	ID cydberthyniad cais pan fo ar gael.
batchId	Cyd-destun swmp pan fo ar gael.
error	Llwyth gwall pan fo'n berthnasol, fel arall null.
data	Llwyth penodol i'r categori.

Categori

Categori cyfredol:

• document
• recipient
• documentLifecycle
• recipientLifecycle
• template
• task
• upload
• credit

Mae category yn dweud wrthych pa gwrthrych neu waith llif mae'r digwyddiad yn ymwneud ag ef. Mae event yn dweud wrthych beth ddigwyddodd.

Siâp Data

Mae data yn benodol i'r categori ac yn estynadwy ymlaen:

• Gall cynhyrchwyr ychwanegu meysydd dros amser.
• Dylai cynhyrchwyr beidio â dileu meysydd presennol mewn ffordd anghydnaws.
• Dylai defnyddwyr anwybyddu meysydd nad ydynt yn eu hadnabod.

Siâp sylfaenol cyfredol:

// 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 }

Mae data llif bywyd mwy cyfoethog yn cael ei lenwi'n fwy cyson ar hyn o bryd ar gyfer digwyddiadau documentLifecycle a recipientLifecycle.