• AppEvent:
• ClientDetails:
• DisplayModeEnum:
• DARK: = "DARK"
• LIGHT: = "LIGHT"
• SupportedTemplatesEnum:
• V1: = "BASIC_V1"
• V2: = "BASIC_V2"
• displayMode: DisplayModeEnum
The display mode of the operating system of the client.
• language: string
Language header representing the client's preferred language. The format of the Accept-Language header follows what is defined in RFC 7231, section 5.3.5
• os: string
The operating system of the client application initiating the request.
• supportedTemplates: Array‹SupportedTemplatesEnum›
Templates that could be renderable in the client
• version: string
The version of the client application initiating the request.
• AppLifecycle:
• CONFIGURATION: = "CONFIGURATION"
• CONFIRMATION: = "CONFIRMATION"
• EVENT: = "EVENT"
• EXECUTE: = "EXECUTE"
• INSTALL: = "INSTALL"
• OAUTH_CALLBACK: = "OAUTH_CALLBACK"
• PING: = "PING"
• UNINSTALL: = "UNINSTALL"
• UPDATE: = "UPDATE"
• ConfigurationType:
• INITIALIZE: = "INITIALIZE"
• PAGE: = "PAGE"
• DeviceLifecycle:
• CREATE: = "CREATE"
• DELETE: = "DELETE"
• MOVE_FROM: = "MOVE_FROM"
• MOVE_TO: = "MOVE_TO"
• UPDATE: = "UPDATE"
• EventType:
• DEVICE_COMMANDS_EVENT: = "DEVICE_COMMANDS_EVENT"
• DEVICE_EVENT: = "DEVICE_EVENT"
• DEVICE_HEALTH_EVENT: = "DEVICE_HEALTH_EVENT"
• DEVICE_LIFECYCLE_EVENT: = "DEVICE_LIFECYCLE_EVENT"
• HUB_HEALTH_EVENT: = "HUB_HEALTH_EVENT"
• INSTALLED_APP_LIFECYCLE_EVENT: = "INSTALLED_APP_LIFECYCLE_EVENT"
• MODE_EVENT: = "MODE_EVENT"
• SECURITY_ARM_STATE_EVENT: = "SECURITY_ARM_STATE_EVENT"
• TIMER_EVENT: = "TIMER_EVENT"
• SceneLifecycle:
• CREATE: = "CREATE"
• DELETE: = "DELETE"
• UPDATE: = "UPDATE"
• ValueTypeEnum:
• BOOLEAN_VALUE: = "BOOLEAN_VALUE"
• DOUBLE_VALUE: = "DOUBLE_VALUE"
• INT_VALUE: = "INT_VALUE"
• NULL_VALUE: = "NULL_VALUE"
• STRING_VALUE: = "STRING_VALUE"
• DeviceCommandsEventCommand:
• arguments: Array‹any›
• capability: string
• command: string
• componentId: string
• ConfigurationData:
• config: ConfigMap
• installedAppId: string
The id of the installed app.
• pageId: string
A developer defined page ID. Must be URL safe characters.
• phase: string
• previousPageId: string
The previous page the user completed. Must be URL safe characters.
• ConfirmationData:
• appId: string
A globally unique identifier for an app.
• confirmationUrl: string
An HTTPS url that may be visited to confirm / activate an App registration.
• DashboardData:
• authToken: string
An OAuth token to use when calling into SmartThings API's.
• installedApp: InstalledApp
• DeviceCommandsEvent:
• commands: Array‹DeviceCommandsEventCommand›
• deviceId: string
The guid of the device that the commands are for.
• eventId: string
The id of the event.
• externalId: string
The external ID that was set during install of a device.
• profileId: string
The device profile ID of the device instance.
• DeviceEvent:
• attribute: string
The name of the DEVICE_EVENT. This typically corresponds to an attribute name of the device-handler’s capabilities.
• capability: string
The name of the capability associated with the DEVICE_EVENT.
• componentId: string
The name of the component on the device that the event is associated with.
• data: any
json map as defined by capability data schema
• deviceId: string
The ID of the device associated with the DEVICE_EVENT.
• eventId: string
The ID of the event.
• locationId: string
The ID of the location in which the event was triggered.
• stateChange: boolean
Whether or not the state of the device has changed as a result of the DEVICE_EVENT.
• subscriptionName: string
The name of subscription that caused delivery.
• value: any
The value of the event. The type of the value is dependent on the capability's attribute type.
• valueType: string
The root level data type of the value field. The data types are representative of standard JSON data types.
• DeviceHealthEvent:
• deviceId: string
The id of the device.
• eventId: string
The id of the event.
• hubId: string
The id of the hub.
• locationId: string
The id of the location in which the event was triggered.
• reason: ReasonEnum
The reason the device is offline.
• status: StatusEnum
The status of the device.
• DeviceLifecycleEvent:
• deviceId: string
The id of the device.
• deviceName: string
The name of the device
• eventId: string
The id of the event.
• lifecycle: DeviceLifecycle
• locationId: string
The id of the location in which the event was triggered.
• principal: string
The principal that made the change
• Event:
• deviceCommandsEvent: DeviceCommandsEvent
• deviceEvent: DeviceEvent
• deviceHealthEvent: DeviceHealthEvent
• deviceLifecycleEvent: DeviceLifecycleEvent
• eventTime: Date
The IS0-8601 date time string in UTC that this event was created.
• eventType: EventType
• modeEvent: ModeEvent
• sceneLifecycleEvent: SceneLifecycleEvent
• securityArmStateEvent: SecurityArmStateEvent
• timerEvent: TimerEvent
• EventData:
• authToken: string
• events: Array‹Event›
• installedApp: InstalledApp
• ExecuteData:
• authToken: string
An OAuth token to use when calling into SmartThings API's.
• installedApp: InstalledApp
• parameters: object
An arbitrary map of input parameters which the SmartApp can use to build a custom response.
- [ key: string]: string
• ExecutionRequest:
• appId: string
• client: ClientDetails
• configurationData: ConfigurationData
• confirmationData: ConfirmationData
• dashboardData: DashboardData
• eventData: EventData
• executeData: ExecuteData
• executionId: string
• installData: InstallData
• lifecycle: AppLifecycle
• locale: string
An IETF BCP 47 language tag representing the chosen locale for this account.
• oauthCallbackData: OAuthCallbackData
• pingData: PingData
• uninstallData: UninstallData
• updateData: UpdateData
• version: string
• HubHealthEvent:
• eventId: string
The id of the event.
• hubId: string
The id of the hub.
• locationId: string
The id of the location in which the event was triggered.
• reason: ReasonEnum
The reason the hub is offline.
• status: StatusEnum
The status of the hub.
• InstallData:
• authToken: string
An OAuth token to use when calling into SmartThings API's.
• installedApp: InstalledApp
• refreshToken: string
A refresh token which maybe used to obtain authorization to SmartThings API after expiration of the authToken. An integration will need to use this refreshToken to support calling the SmartThings API outside the context of an event.
• InstalledApp:
• config: ConfigMap
• installedAppId: string
• locationId: string
• permissions: Permissions
• ModeEvent:
• eventId: string
The id of the event.
• locationId: string
The id of the location in which the event was triggered.
• modeId: string
The ID of the mode associated with a MODE_EVENT.
• OAuthCallbackData:
• installedAppId: string
The id of the installed app.
• urlPath: string
A relative URL containing all of the query string parameters as returned by the third party oauth system. A SmartApp can parse the urlPath property to extract any sensitive auth codes/tokens which can then be used to access the third party system.
• PingData:
• challenge: string
A challenge phrase that the SmartApp must echo back to validate itself.
• SceneLifecycleEvent:
• eventId: string
The id of the event.
• lifecycle: SceneLifecycle
• locationId: string
The id of the location in which the event was triggered.
• sceneId: string
The id of the scene.
• SecurityArmStateEvent:
• armState: ArmStateEnum
The arm state of a security system.
• eventId: string
The id of the event.
• locationId: string
The id of the location in which the event was triggered.
• optionalArguments: object
A set of key / value pairs useful for passing any optional arguments.
- [ key: string]: SimpleValue
• SimpleValue:
• boolValue: boolean
• doubleValue: number
• intValue: number
• stringValue: string
• valueType: ValueTypeEnum
The type of the value.
• TimerEvent:
• eventId: string
The ID of the event.
• expression: string
The CRON expression if the schedule was of type CRON.
• name: string
The name of the schedule that caused this event.
• time: Date
The IS0-8601 date time strings in UTC that this event was scheduled for.
• type: string
• UninstallData:
• installedApp: InstalledApp
• UpdateData:
• authToken: string
• installedApp: InstalledApp
• previousConfig: ConfigMap
• previousPermissions: Permissions
• refreshToken: string
Ƭ ConfigMap: object
- [ name: string]: ConfigEntry[]
Ƭ Permissions: string | string[]
• DeviceHealthEvent:
• ReasonEnum:
• BLUETOOTH_OFFLINE: = "BLUETOOTH_OFFLINE"
• HUB_DISCONNECTED: = "HUB_DISCONNECTED"
• HUB_OFFLINE: = "HUB_OFFLINE"
• NONE: = "NONE"
• SERVICE_UNAVAILABLE: = "SERVICE_UNAVAILABLE"
• ZIGBEE_OFFLINE: = "ZIGBEE_OFFLINE"
• ZWAVE_OFFLINE: = "ZWAVE_OFFLINE"
• StatusEnum:
• OFFLINE: = "OFFLINE"
• ONLINE: = "ONLINE"
• UNHEALTHY: = "UNHEALTHY"
• HubHealthEvent:
• ReasonEnum:
• DISCONNECTED: = "DISCONNECTED"
• INACTIVE: = "INACTIVE"
• NONE: = "NONE"
• StatusEnum:
• BLUETOOTH_OFFLINE: = "BLUETOOTH_OFFLINE"
• BLUETOOTH_ONLINE: = "BLUETOOTH_ONLINE"
• OFFLINE: = "OFFLINE"
• ONLINE: = "ONLINE"
• ZIGBEE_OFFLINE: = "ZIGBEE_OFFLINE"
• ZIGBEE_ONLINE: = "ZIGBEE_ONLINE"
• ZWAVE_OFFLINE: = "ZWAVE_OFFLINE"
• ZWAVE_ONLINE: = "ZWAVE_ONLINE"
• SecurityArmStateEvent:
• ArmStateEnum:
• ARMED_AWAY: = "ARMED_AWAY"
• ARMED_STAY: = "ARMED_STAY"
• DISARMED: = "DISARMED"
• UNKNOWN: = "UNKNOWN"