Invite Others to Test Your Integration
SmartThings Schema invitations allow you to invite other users to test your existing Schema integration. To begin, install the SmartThings CLI.
Create an Invitation
To start an interactive session in the CLI:
$ smartthings invites:schema:create
If you already know the ID of your Schema app, you can specify it on the command line (this is particularly helpful if you want to create more than one invitation):
$ smartthings invites:schema:create --schema-app myapp_id
During creation, will have the option to limit the number of users who can accept your invitation. After following the prompts in the CLI, a new invitation will be created for you:
──────────────────────────────────────────────────────────────────────────────────────────────
Invitation Id 0aa97541-0d89-4ff7-b8d6-3553b07a28b1
Description my invitation description
Expiration 2023-10-31T19:48:55.000Z
Acceptances 0
Accept URL https://invitations.smartthings.com/schemaApp/INVITATION_ID
Schema App Id viper_98fdced9-1a7a-48bd-a226-f787d0adc653
Schema App Name My ST-Schema App
──────────────────────────────────────────────────────────────────────────────────────────────
Send the Accept URL
to the users you want to invite to use your SmartThings Schema app.
The Accept URL
expires 7 days after creating your invitation. After 7 days, your Schema app will continue to function for existing users, but will not allow existing users to reinstall your app.
Check the Status of an Invitation
View your existing invitations:
smartthings invites:schema
If you know your invitation ID, you can specify this directly to view the accept URL
link, number of acceptances, and more:
$ smartthings invites:schema 0aa97541-0d89-4ff7-b8d6-3553b07a28b1
─────────────────────────────
Invitation Id 0aa97541-0d89-4ff7-b8d6-3553b07a28b1
Description my invitation description
Expiration 2023-10-31T19:48:55.000Z
Acceptances 0
Accept URL https://invitations.smartthings.com/schemaApp/INVITATION_ID
Schema App Id viper_98fdced9-1a7a-48bd-a226-f787d0adc653
Schema App Name My ST-Schema App
─────────────────────────────
Delete an Invitation
Deleting an invitation will nullify the Accept URL
, preventing new users from installing your Schema app. Existing users will be unable to reinstall your Schema app or change the installed app location.
Existing installations of your shared Schema app will not be affected. To prevent existing users from continuing to use your Schema app, send a proactive discoveryCallback
or stateCallback
with the SmartThings Schema globalError.errorEnum: INTEGRATION-DELETED
. The globalError
can also be provided in a Schema response.
To delete an invitation:
smartthings invites:schema:delete
and select a previously created invitation. If you know your invitation ID, you can specify this directly:
$ smartthings invites:schema:delete 0aa97541-0d89-4ff7-b8d6-3553b07a28b1
Invitation 0aa97541-0d89-4ff7-b8d6-3553b07a28b1 revocation requested. (This may take a few moments to complete.)