SmartThings Schema

COMING SOON

Details on using SmartThings Schema to quickly integrate your devices.

The SmartThings Schema is a specification for use in a cloud-to-cloud device integration. It does not require using the SmartThings API.

When using the Schema for a C2C integration, you must:

  1. Register a Connector in the Developer Workspace that can fulfill requests sent from SmartThings.
  2. Create an OAuth2 client from your cloud.
  3. Implement the Schema in the HTTPS response.
  4. Test your integration.

The Schema defines the format of the JSON payloads sent from your server.

NOTE

Your cloud must support OAuth2 with authorization code and multiple redirect URIs.

Basic concept

The SmartThings Schema recognizes three interaction types that define how your server responds to SmartThings.

  • Discovery: Return a list of devices.
  • State Refresh: Return the state of the devices.
  • Command: Issue commands to the device.

SmartThings specifies an interaction type when sending a request to your server, which replies with the appropriate information in a JSON payload.

Cloud Connector

You will set up a Connector to handle the interaction types. This Connector can be a WebHook endpoint or AWS Lambda function.

OAuth2

You must generate an OAuth2 application from your cloud. You supply the OAuth2 credentials and details for your application when registering your Connector in Developer Workspace.

When creating your OAuth2 application, you will need to supply the following SmartThings redirect URIs: