Applet.Command.AppletCommandReceivedFromDevice
An applet command a device's applet sent to the platform.
Payload
| Field | Type | Required | Description |
|---|---|---|---|
type | "Applet.Command.AppletCommandReceivedFromDevice" (literal) | ✅ | |
owner | object | ✅ | Ownership envelope identifying the company or organization that owns this event. |
owner.ownershipType | "organization" (literal) | ✅ | Discriminator for the ownership envelope; always organization for these events. |
owner.organizationUid | string | ✅ | UID of the organization that owns the event. |
owner.parentCompanyUid | string | ✅ | UID of the owning organization's parent company. |
deviceIdentityHash | string | ✅ | Server-generated unique identifier of the device, used as the public-facing identifier in the REST API. |
appletUid | string | ✅ | UID of the applet the command belongs to. |
timingChecksum | string | — | Checksum of the timing the device's applet was running in when it sent the command. |
recordedAt | string (date-time) | — | When the device's applet sent the command while offline; present only for commands uploaded after reconnecting. |
commandPayload | object | ✅ | The command itself: its type plus any custom properties. |
commandPayload.type | string | ✅ |
Example
This example uses format version 1.
{
"id": "string",
"kind": "appletCommand",
"type": "Applet.Command.AppletCommandReceivedFromDevice",
"payload": {
"type": "Applet.Command.AppletCommandReceivedFromDevice",
"owner": {
"ownershipType": "organization",
"organizationUid": "4ddb4729xxxxxxxxxxxxxxxxcb04a699",
"parentCompanyUid": "64199c21xxxxxxxxxxxxxxxx2fea327a"
},
"deviceIdentityHash": "076530c6xxxxxxxxxxxxxxxx20b38c1a",
"appletUid": "adf55139xxxxxxxxxxxxxxxx8bb48485",
"commandPayload": {
"type": "string"
}
}
}
Shape
{
"id": "string",
"kind": "appletCommand",
"type": "Applet.Command.AppletCommandReceivedFromDevice",
"payload": {
"type": "Applet.Command.AppletCommandReceivedFromDevice",
"owner": {
"ownershipType": "organization",
"organizationUid": "string",
"parentCompanyUid": "string"
},
"deviceIdentityHash": "string",
"appletUid": "string",
"timingChecksum?": "string",
"recordedAt?": "string (date-time)",
"commandPayload": {
"type": "string"
}
}
}