SMsmartthings
SchemaApps

Create a Schema App

Changed on

Create a new SmartThings Schema App. When using a Personal Access Token, userId should not be provided in the body as this will be obtained from the access token.

post/schema/apps

Request

Headers

Authorizationstring Bearer token required

Personal Access Token [w:apps:*]

X-ST-Organizationstring organizationId

organizationId

Request body

appNamestring required

The name of your SmartThings Schema App

partnerNamestring required

The name of your brand or organization

oAuthAuthorizationUrlstring required

OAuth authorization url provided by your OAuth application

lambdaArnstring

Lambda ARN of your Cloud Connector in the US region (default). Required if your Cloud Connector uses AWS Lambda.

lambdaArnEUstring

Lambda ARN for the EU region

lambdaArnAPstring

Lambda ARN for the AP region

lambdaArnCNstring

Lambda ARN for the CN region

iconstring

The URL of your integration icon. This icon will be displayed to end users.

icon2xstring

The URL of your integration icon @ 2x dimension

icon3xstring

The URL of your integration icon @ 3x dimension

endpointAppIdstring

Your SmartThings Schema App ID

oAuthClientIdstring required

The Client ID for your OAuth client

oAuthClientSecretstring required

The Client secret for your OAuth client

oAuthTokenUrlstring required

The OAuth token refresh URL of your OAuth client

oAuthScopestring

Your OAuth client scope. Example "remote_control:all".

userIdstring

Your user id

hostingTypestring required

Possible values - "lambda" or "webhook"

schemaTypestring

Possible values - "alexa-schema", "st-schema", "google-schema"

webhookUrlstring

Webhook URL where your Cloud Connector will receive events. Required if your Cloud Connector uses a webhook endpoint.

certificationStatusstring

Possible values - "", "cst", "wwst", "review"

userEmailstring required

The email where SmartThings may contact you regarding your Schema integration.

Response

Success

endpointAppIdstring uuid
stClientIdstring uuid
stClientSecretstring uuid

Example response

{
  "endpointAppId": "viper_9121f970-f503-11e8-a7de-7319cef9605d",
  "stClientId": "e3fd04cb-c488-4bbd-9759-8deb512656a8",
  "stClientSecret": "02c75d945e69e167233cb635b1f9be76d97ebb0b04f4e6839f3acfad320bed64ab86838dc6312585b037259e7797bf2bb44b3caa7a60539c1f402abe3bbe9256424615fddc48e76823b9c230b15669901becb33711e48192aa54a31e4e287ff47295c61c15e2e046103f13aa250bb561136625b69304cc31ef5004d267d0847184426144c60a74329bb47e2f773469ebb6a1e585175370fda78e03413abbcafe51665e8cbe51adf37dd5a3ff376300ebdbe2a359589951a72867bd3fcc574bd77b9ac85127023f931de3c5bcb213efeab3d94a7ee4a3d20acc6f6e575755b10bceb74290f4182c9bddc407d4361710492611568ebcb0b2ffac09e70d0c977d5f"
}

Changes