Skip to content

Update docs with corrected dashboard URLs #1158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dshokouhi merged 4 commits into from
Jan 10, 2025
Merged

Update docs with corrected dashboard URLs #1158

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e26c5cd
Remove lovelace from url-handler docs
travissanderson Jan 10, 2025
acccf04
Add step-by-step for crafting a navigate URL
travissanderson Jan 10, 2025
42b76d2
Deeplink to specific server is iOS only as of now
travissanderson Jan 10, 2025
6b627ff
Remove step 4 since it is redundant with the Specify server section
travissanderson Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/integrations/url-handler.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,17 @@ If multiple servers are connected to an app, you will be prompted to select a se
:::

## Navigate
This allows you to update the frontend page location via a deeplink.
This allows you to update the frontend page location via a deeplink. To build a deeplink, follow these steps:

For example: if you had a dashboard at `/lovelace/webcams` you can use `homeassistant://navigate/lovelace/webcams` to launch the app there.
1. Navigate to the link you'd like to deeplink to in the web app, e.g. `http://homeassistant.local:8123/dashboard-mobile/my-subview`
2. Copy the path portion of the URL, in this example that would be `/dashboard-mobile/my-subview`
3. Craft your URL by starting with `homeassistant://navigate` and adding the path, e.g. `homeassistant://navigate/dashboard-mobile/my-subview`

#### Define server
### Specify server to navigate to
![iOS](/assets/iOS.svg) <span class='beta'>BETA</span><br />
By default the App will ask which server you want to navigate to in case you have multiple servers.
To define which server you want to navigate to, use the query param `?server=` like the example below:<br /><br />
`homeassistant://navigate/lovelace/webcams?server=My%20home` when your server name is `My Home`, or use `?server=default` if you want to navigate to the first server available.
`homeassistant://navigate/webcams?server=My%20home` when your server name is `My Home`, or use `?server=default` if you want to navigate to the first server available.

## Call service
![iOS](/assets/iOS.svg)<br />
Expand Down