Overview

Build with BWEE

Use the BWEE Gateway API to connect your application to a gateway on the local network. Discover devices, control lighting, organize rooms, and recall scenes through HTTP requests. Subscribe to MQTT events to receive updates as resources change.

Who This Guide Is For

This guide is for developers and integration partners building applications that work with BWEE gateways. Each endpoint includes request parameters, response examples, and field definitions to help you implement and troubleshoot your integration.

Find What You Need

• Connect an application: start with gateway discovery, registration, and authentication.
• Read or change a resource: use the HTTP endpoints for devices, rooms, lights, scenes, and sync devices.
• Receive updates: subscribe to the MQTT notification topics.
• Look up a field: see the data model reference.

Get Started

1. Review the connection settings.
2. Discover a gateway and enable registration using its physical button.
3. Register your application and save the returned credential.
4. Include that credential in the application-key header to authenticate API requests.

Keep the credential secure: it grants access to the gateway API. If you need help with an integration, visit the Community link in the navigation bar.