canonical: https://jentic.com/apis/bippybox.io/bippybox # BippyBox API Jentic publishes the only available OpenAPI specification for BippyBox API, keeping it validated and agent-ready. BippyBox is a small IoT notification device that plays a short audio clip and lights an LED in a chosen colour when triggered over the internet. The HTTP API exposes two operations: one to read the user's account data including the list of registered devices, and one to send a notification to a specific BippyBox by combining a sound, a colour, and an optional message. Authentication is a static x-uid header tied to a single user account. ## For AI agents Trigger a BippyBox IoT device to play a sound and light up in a chosen colour, or list the devices registered to a user. Two endpoints, x-uid header authentication. ## Scope Does not handle SMS, email, mobile push notifications, or device firmware updates - use for triggering BippyBox sound-and-colour alerts only. ## Capabilities - List the BippyBox devices registered against a user account via /getuserdata - Trigger a specific device to play a named sound and display a named colour via /send - Notify a household member by sending a coloured audio alert from a server-side workflow - Surface build, deployment, or alerting events on a physical desk device instead of a chat channel - Confirm device registration before a workflow attempts to address it ## Use cases ### Physical alerts from server-side workflows Teams replace a Slack ping with a physical light-and-sound notification by calling /send when a server-side event fires. The endpoint takes the device identifier, a sound name, and a colour, and the device responds within a second over MQTT. Adding a BippyBox to an existing webhook handler is a 10-minute change because the API surface is just two operations. Example prompt: When a webhook fires, call POST /send with the user's device, sound 'chime', and colour 'red' to flash and beep the BippyBox ### Household notifications from automation routines Home automation routines call BippyBox when the dryer finishes, when a child's school bus is two stops away, or when a delivery is at the door. The /getuserdata endpoint enumerates registered devices so a routine can pick the right one, and /send delivers the notification with a colour-coded meaning the household has agreed on. The single x-uid header keeps the integration small enough to fit in a Home Assistant template. Example prompt: Call /getuserdata, find the device named 'kitchen', then POST /send with sound 'doorbell' and colour 'green' to indicate package delivered ### Agent integration via Jentic for physical notifications An AI agent that wants to surface a physical alert can call Jentic with the intent 'notify a physical iot device with sound and colour'. Jentic returns the BippyBox /send operation with its input schema (device, sound, colour, optional text). The x-uid credential never leaves your Jentic One instance, so the agent can fire a notification without ever holding the secret. Example prompt: Search Jentic for 'physical iot notification with sound', load the /send schema, and execute with sound 'chime' and colour 'red' on the user's primary device ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | /getuserdata | Return user account data and the list of registered BippyBox devices | | POST | /send | Trigger a registered BippyBox to play a sound and show a colour | ## Key resources - **User** — Read the user's account data including the list of registered BippyBox devices via /getuserdata - **Device** — Trigger a registered BippyBox to play a sound and display a colour via /send ## Why Jentic - **Setup:** Wiring the BippyBox API by hand means setting the x-uid header, targeting the app.bippybox.io host, and handling alert-trigger errors yourself. Through Jentic you install once, import BippyBox from the API Directory, store the UID once, and your agent calls it. - **Permission scoping:** BippyBox targets the device through the request, not the URL path, so limit the agent to the operations it needs, such as reading user data with /getuserdata or triggering an alert with /send. You choose the operations it may call, so nothing beyond that set runs unless you add it. - **Credential handling:** Your BippyBox x-uid key is stored once, encrypted, by your own Jentic One instance and injected into the header at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'trigger a physical sound and colour alert', and Jentic returns the BippyBox /send operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Pushover** — Hosted notification service that pushes alerts to mobile and desktop apps. - **Pushbullet** — Cross-device push notifications and link sharing across phones and browsers. - **OneSignal** — Push notification platform for mobile apps and web applications at scale. ## FAQ ### Why is there no official OpenAPI spec for BippyBox API? BippyBox does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call BippyBox API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the BippyBox API use? BippyBox uses a static apiKey scheme passed in the x-uid request header. The header value is the user's BippyBox UID. Through Jentic the UID is stored encrypted in the vault and injected at call time, so agents never see the raw secret. ### Can I trigger a specific device with the BippyBox API? Yes. POST /send accepts a device identifier together with a sound name and a colour. Call GET /getuserdata first to retrieve the list of devices registered against the account so you can pick the right one. ### What are the rate limits for the BippyBox API? BippyBox does not publish a numeric rate limit in its specification, but the device is intended for occasional notifications rather than streaming events. Treat /send as a low-frequency operation and avoid bursts that could exceed the MQTT broker's per-device cadence. ### How do I trigger a BippyBox through Jentic? Run pip install jentic, then search Jentic for 'physical iot notification with sound', load the /send operation schema, and execute with the device, sound, and colour fields filled in. Jentic injects the x-uid credential automatically. ### Can I list the devices on my BippyBox account? Yes. GET /getuserdata returns the user's account data including the list of registered BippyBox devices. Use it to validate that a target device exists before issuing /send. ### Can I limit what my agent is allowed to do with the BippyBox API? Yes. Because you run Jentic One yourself, your own rules decide which BippyBox operations the agent may call and which credentials it may use. BippyBox targets the device through the request body rather than the URL path, so you can restrict the agent to just the operations it needs, such as reading account and device data with GET /getuserdata or triggering a sound-and-colour alert with POST /send. Nothing beyond the operations you allow runs.