Welcome to the Web API documentation ๐
๐ Learn how to build great integrations.
Last updated
Was this helpful?
๐ Learn how to build great integrations.
Last updated
Was this helpful?
The Homey Web API is a HTTP + Socket.IO API to control Devices, start Flows, view Insights and more. It is used by Athom internally for the , , , , and is available to 3rd party developers to create their own integrations.
As opposed to the apps running on Homey Pro or Homey Cloud, using the , integrating with the Homey Web API requires your own server or front-end.
The Web API can also used from within a HomeyScript.
Homey Pro apps with the homey:manager:api
permission can also use some endpoints from within their app.
Before you can get started, you need to create your own Web API Client, to receive your Client ID & Secret.
Customers must authenticate using OAuth2 with your application, before you can make API calls on their behalf.
Create your own API Client in the .
New API Clients are limited to a maximum of 100 Homey Pro users. To remove this limit, and optionally connect to Homey Cloud, click the Request Limit Increase link in the Developer Tools. We will try to handle your request as soon as possible.
We provide a JavaScript & Node.js library, , to take care of the heavy lifting by authenticating & connecting to a customer's Homey Pro or Homey Cloud.
Questions? Ask them on with the homey
tag.
Please report any issues you find in the .