Μορφή Γεγονότος Συνδρομής

Για την κανονική αναφορά σχήματος φιλικού προς AI, δείτε το Subscription Event Schema.

Οι συνδρομές GraphQL επιστρέφουν ένα λεπτό περιτύλιγμα παράδοσης και έναν κωδικοποιημένο σε JSON φάκελο γεγονότος.

Περιτύλιγμα Παράδοσης

Οι απαντήσεις ροής χρήστη φαίνονται ως εξής:

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

Οι απαντήσεις ροής ομάδας χρησιμοποιούν groupId αντί για userId στο εξωτερικό περιτύλιγμα.

Το περιτύλιγμα ταυτοποιεί το κανάλι συνδρομής. Η εσωτερική συμβολοσειρά data είναι το κανονικό φορτίο του γεγονότος.

Φάκελος Γεγονότος

Μετά την ανάλυση του 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"
  }
}

Πεδία Φακέλου

Πεδίο	Περιγραφή
version	Έκδοση φακέλου γεγονότος. Προς το παρόν 1.0.
eventId	Σταθερό λογικό ID γεγονότος. Αντίγραφα διάδοσης του ίδιου γεγονότος μοιράζονται την ίδια τιμή.
timestamp	Χρονική σήμανση γεγονότος σε μορφή ISO-8601.
level	Σοβαρότητα γεγονότος. Προς το παρόν συνήθως INFO.
event	Κανονικό όνομα γεγονότος όπως documentArchived ή uploadCompleted.
category	Οικογένεια γεγονότος. Περιγράφει πώς να ερμηνευτεί το data.
groupId	Συμφραζόμενο ομάδας όταν εφαρμόζεται.
userId	Συμφραζόμενο χρήστη όταν εφαρμόζεται.
requestId	Αναγνωριστικό συσχέτισης αιτήματος όταν είναι διαθέσιμο.
batchId	Συμφραζόμενο παρτίδας όταν είναι διαθέσιμο.
error	Φορτίο σφάλματος όταν εφαρμόζεται, αλλιώς null.
data	Φορτίο ειδικό στην κατηγορία.

Κατηγορίες

Τρέχουσες κατηγορίες:

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

Το category σας λέει για ποιο αντικείμενο ή ροή εργασίας αφορά το γεγονός. Το event σας λέει τι συνέβη.

Μορφές Δεδομένων

Το data είναι ειδικό για την κατηγορία και επεκτάσιμο μελλοντικά:

• Οι παραγωγοί μπορεί να προσθέτουν πεδία με την πάροδο του χρόνου.
• Οι παραγωγοί δεν θα πρέπει να αφαιρούν υπάρχοντα πεδία με ασυμβίβαστο τρόπο.
• Οι καταναλωτές θα πρέπει να αγνοούν πεδία που δεν αναγνωρίζουν.

Τρέχουσες βασικές μορφές:

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

Πλουσιότερα δεδομένα κύκλου ζωής συμπληρώνονται προς το παρόν πιο συνεπώς για τα γεγονότα documentLifecycle και recipientLifecycle.