Required roles
- Sensor-*
Learn more about Sensors in our Knowledge Base.
Properties
| Property | Type | Required | Information |
|---|---|---|---|
| BusinessId | int | Yes | |
| Desks | array_int | No | |
| Resources | array_int | No | |
| CannedResponseId | int | No | |
| CannedResponseName | string | No | Read-only |
| Name | string | No | |
| Reference | string | No | |
| Unit | string | No | |
| Active | boolean | No | |
| SensorType | enum | No | Valid values |
| DataStrategy | enum | No | Valid values |
| PayloadDataPath | string | No | |
| ActionTriggerFunction | string | No | |
| ValueFunction | string | No | |
| ActionSendEmailAlert | boolean | No | |
| AlertEmailAddress | string | No | |
| WebhookUrl | string | No | |
| ActionUpdateDeskAvailability | boolean | No | |
| ActionUpdateResourceAvailability | boolean | No | |
| ActionUpdateBookingOccupancy | boolean | No | |
| ActionSendCustomerEmailAlert | boolean | No | |
| ActionBookingStart | boolean | No | |
| ActionBookingTerminate | boolean | No | |
| ActionCheckInOrOut | boolean | No | |
| ActionMakeHttpRequest | boolean | No | |
| ShowInNowDashboard | boolean | No | |
| ShowInPortal | boolean | No | |
| SharedSecret | string | No | |
| ApiKey | string | No | |
| Username | string | No | |
| Password | string | No | |
| ReceivedDataOn | timestamp | No | |
| LastReceivedValue | string | No | |
| LastValueTriggeredAction | boolean | No | |
| BatteryLevel | int | No | |
| NetworkSignalStrength | int | No | |
| Id | int | Yes | Read-only |
| UpdatedOn | timestamp | No | Read-only |
| CreatedOn | timestamp | Yes | Read-only |
| UniqueId | string | No | Read-only |
| SystemId | string | No |
Related records
| Property | Record type |
|---|---|
| BusinessId | Business |
| CannedResponseId | CannedResponse |