¶ Apps Code
The Hubitat community has developed some great apps to help you automate your devices in new, cool ways.
NOTE: Third-party code is not offically supported by Hubitat. Support may (or may not) be provided by the developer.
¶ Installing custom apps
-
The developer of the app will normally post a link to their app code. Follow their directions to get to the source code.
- Often, developers will use GitHub to host code. When copying the code, select the Raw button so that you are getting the plain-text form of the code, with no HTML formatting.
- Select All the raw code, and then Copy the code.
- Often, developers will use GitHub to host code. When copying the code, select the Raw button so that you are getting the plain-text form of the code, with no HTML formatting.
-
From the home page of your hub, select Apps Code in the side bar. NOTE: If you do not see Apps Code, expand the Developer Tools section to expose Apps Code and other developer/code links.
-
Select the +New App button in the upper right corner of the Apps Code page.
-
In the blank text field, paste the code. Alternatively, you can select the Import button and past a URL to the developers code in raw text format.
-
Select the Save button in the top right. When modified goes away, your app is saved.
You may experience an error in this step. If you do, your app will not save and it will not work. Please contact the developer of the app in the Hubitat Community forum (or troubleshoot the code yourself if is your own). It is usually best if you take a screen shot of the error to help them diagnose the problem. Once the code is fixed, come back and try again.
¶ Enabling OAuth
Not all user apps will require OAuth (Open Authorization). Consult the app developers documentation for instruction. If it does require enabling OAuth, follow the steps below.
-
After saving your user app code, select the Enable OAuth button and then Update to automatically generate the keys.
-
If your client secret key becomes compromised, you may refresh it to protect the OAuth2 endpoint security.
- To refresh the client secret, open your user app code, select OAuth and check to box for Refresh Client Secret, the select Update. If integrating with a third-party system, you may need to update the keys/URL in that system after doing this (consult documentation for that system if needed).
- To refresh the client secret, open your user app code, select OAuth and check to box for Refresh Client Secret, the select Update. If integrating with a third-party system, you may need to update the keys/URL in that system after doing this (consult documentation for that system if needed).
¶ Loading Your User Developed App
Once your app has successfully saved, you will need to load it to your hub before you can use it.
- Select Apps from the sidebar.
- Select the +Add User App button.
- Find your User App in the list and select it to instantly add it.
That's it! You're all set to create automations with your new app. (Don't forget to thank the developer in the community forum for their hard work!)