Skip to content

Commit 03c02ac

Browse files
andrewsayrecgarwood
authored andcommitted
Add docs describing cloudhook support (home-assistant#8902)
1 parent e4f3c42 commit 03c02ac

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

source/_components/smartthings.markdown

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,17 @@ See it in action, with a step-by-step setup guide, thanks to a fan! (v0.87 featu
5959

6060
## {% linkable_title Basic requirements %}
6161

62+
The SmartThings integration utilizes a webhook to receive push updates from the SmartThings cloud through either a cloudhook or an internet accessible webhook based on whether Home Assistant Cloud is configured and logged in with a non-expired subscription (this is not configurable at this time).
63+
64+
### {% linkable_title Cloudhook via Nabu Casa %}
65+
66+
If you are using Home Assistant Cloud (Nabu Casa) the integraiton will create a cloudhook automatically. This greatly simplifies the basic requirements and does not require Home Assistant to be exposed to the internet. **If you have previously setup the component prior to meeting the requirements for a cloudhook or prior to v0.90.0, you must remove all prior integrations and run through the configuration again.**
67+
68+
1. A [personal access token](https://account.smartthings.com/tokens) tied to a Samsung or SmartThings account (see below for instructions).
69+
2. Home Assistant Cloud is configured and logged-in with a non-expired subscription.
70+
71+
### {% linkable_title Webhook %}
72+
6273
1. A [personal access token](https://account.smartthings.com/tokens) tied to a Samsung or SmartThings account (see below for instructions).
6374
2. Home Assistant setup for [remote access](/docs/configuration/remote/) via a domain name secured with SSL. *Self-signed SSL certificates are not supported by the SmartThings Cloud API.*
6475
3. [`base_url` of the http component](/components/http#base_url) set the URL that Home Assistant is available on the internet.
@@ -281,7 +292,7 @@ The SmartThings Switch platform lets you control devices that have the [`switch`
281292

282293
### {% linkable_title Setup %}
283294

284-
Perform the following steps if you receive one of the following error messages while attempting to setup the integration:
295+
Perform the following steps if you receive one of the following error messages while attempting to setup the integration (this does not apply when integrated through Home Assistant Cloud):
285296

286297
- "SmartThings could not validate the endpoint configured in base_url. Please review the component requirements."
287298
- "Unable to setup the SmartApp. Please try again."

0 commit comments

Comments
 (0)