Event Catalog

Αυτός ο κατάλογος περιγράφει τα events με τη μεγαλύτερη αξία που δημοσιεύει η SmartphoneKey. Για κάθε event θα βρείτε την πηγή, πότε ενεργοποιείται, και τα βασικά πεδία του payload του.

Για την πλήρη λίστα κάθε detail-type που εκπέμπεται, δείτε Partner Webhooks.

Όλα τα events spk.api μοιράζονται την ίδια δομή φακέλου (envelope). Το domain payload τυλίγεται σε ένα αντικείμενο detail που φέρει metadata της προβολής (projection) μαζί με το αρχικό event κάτω από το data:

{
  "source": "spk.api",
  "detail-type": "<EventName>",
  "detail": {
    "partnerId": "<your-orgId>",
    "aggregateType": "<lock|user|hub|...>",
    "aggregateId": "<aggregate uuid>",
    "version": 7,
    "timestamp": 1745922600123,
    "data": { /* payload ειδικό για το event — δείτε παρακάτω */ }
  }
}

Το detail.timestamp είναι ο χρόνος της προβολής (projection) σε epoch milliseconds (αριθμός). Η χρονοσφραγίδα ISO-8601 μέσα στο detail.data.timestamp είναι ο χρόνος του domain event. Τα πεδία που τεκμηριώνονται παρακάτω περιγράφουν το detail.data — το πραγματικό domain event.

Lock Events

LockCreated

Ενεργοποιείται όταν δημιουργείται μια νέα κλειδαριά στο σύστημα.

Πεδία payload (detail.data):

Δείγμα:

{
  "type": "LockCreated",
  "lockId": 4321,
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "serialNumber": "SPK-1234",
  "ownerId": "user-uuid",
  "keys": [],
  "timestamp": "2026-04-30T10:30:00.123Z"
}

OwnerSet

Ενεργοποιείται όταν ανατίθεται ή αλλάζει ο ιδιοκτήτης μιας κλειδαριάς.

KeyAdded

Ενεργοποιείται όταν προστίθεται ένα φυσικό κλειδί σε μια κλειδαριά.

Δείγμα:

{
  "type": "KeyAdded",
  "lockId": 4321,
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "keyUuid": "0f5b84e0-1d56-4d2f-8d6c-1f2e3a4b5c6d",
  "keyIndexNumber": 3,
  "userId": "9b3e1d5e-7c6a-4d4d-8b1a-2e4f6a8c0d1e",
  "timestamp": "2026-04-30T10:30:00.123Z"
}

KeyRemoved

Ενεργοποιείται όταν αφαιρείται ένα φυσικό κλειδί από μια κλειδαριά.

ResidentAdded

Ενεργοποιείται όταν παραχωρείται σε έναν ένοικο πρόσβαση σε μια κλειδαριά.

Δείγμα:

{
  "type": "ResidentAdded",
  "lockId": 4321,
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "userId": "9b3e1d5e-7c6a-4d4d-8b1a-2e4f6a8c0d1e",
  "name": "Jane Resident",
  "email": "resident@example.com",
  "timestamp": "2026-04-30T10:30:00.123Z"
}

ResidentRemoved

Ενεργοποιείται όταν ανακαλείται η πρόσβαση ενός ενοίκου σε μια κλειδαριά.

User Events

PhysicalKeyAdded

Ενεργοποιείται όταν εκδίδεται ένα φυσικό κλειδί σε έναν χρήστη.

PhysicalKeyRemoved

Ενεργοποιείται όταν αφαιρείται ένα φυσικό κλειδί από έναν χρήστη.

AccessibleLockAdded

Ενεργοποιείται όταν παραχωρείται σε έναν χρήστη πρόσβαση σε μια κλειδαριά.

Δείγμα:

{
  "type": "AccessibleLockAdded",
  "userId": "9b3e1d5e-7c6a-4d4d-8b1a-2e4f6a8c0d1e",
  "lockId": "550e8400-e29b-41d4-a716-446655440000",
  "lockName": "Front Door",
  "accessLevel": "USER",
  "grantedBy": "1c1c1c1c-1c1c-1c1c-1c1c-1c1c1c1c1c1c"
}

LicensePlateAdded

Ενεργοποιείται όταν καταχωρείται μια πινακίδα κυκλοφορίας σε έναν χρήστη (χρησιμοποιείται από ροές πρόσβασης βασισμένες σε ALPR / κάμερα).

Hub Events

HubProvisioned

Ενεργοποιείται όταν ένα hub καταχωρείται στο σύστημα (συνήθως κατά την κατασκευή).

HubClaimed

Ενεργοποιείται όταν ένα hub διεκδικείται (claimed) από έναν οργανισμό και ανατίθεται σε ένα site.

Camera Events

CameraRegistered

Ενεργοποιείται όταν καταχωρείται μια κάμερα για έναν tenant.

IoT Events

Shadow Update

Ενεργοποιείται όταν μια συσκευή IoT hub ενημερώνει το AWS IoT Device Shadow της. Περιέχει ένα πλήρες στιγμιότυπο της κατάστασης shadow, συμπεριλαμβανομένων της επιθυμητής κατάστασης (desired state), της αναφερόμενης κατάστασης (reported state) και του delta.

Αυτό το event έχει διαφορετικό φάκελο (envelope) από τα events spk.api — δεν υπάρχει wrapper detail.data. Τα πεδία shadow βρίσκονται απευθείας στο detail.

Πεδία payload (στο ανώτερο επίπεδο detail):

Παράδειγμα payload:

{
  "source": "spk.iot.shadow",
  "detail-type": "Shadow Update",
  "detail": {
    "partnerId": "<tenant-org-id>",
    "thingName": "<device-uuid>",
    "reportedState": "<stringified JSON of reported state>",
    "desiredState": "<stringified JSON of desired state>",
    "deltaState": "{}",
    "metadata": "<stringified IoT shadow metadata>",
    "version": 42
  }
}

Σημείωση: τα reportedState, desiredState, deltaState και metadata είναι stringified JSON ενσωματωμένα μέσα στο εξωτερικό αντικείμενο JSON. Οι εταίροι πρέπει να καλέσουν JSON.parse() σε καθένα από αυτά τα πεδία πριν προσπελάσουν το περιεχόμενό τους.