Skip to content
BeeBuzz Docs

Quickstart

This guide is for approved BeeBuzz beta users.

Goal: pair one device, create one API token, and send one notification.

What You Need

Section titled “What You Need”

On iPhone and iPad, BeeBuzz Hive must be installed to the Home Screen before Web Push can work.

1. Open The Web App

Section titled “1. Open The Web App”

Open beebuzz.app and sign in.

During the hosted beta, access is limited to approved accounts. If your email is not approved yet, BeeBuzz records the access request.

2. Pair A Device

Section titled “2. Pair A Device”

Open Account -> Devices and create a device.

BeeBuzz shows:

  • a Hive link or QR code
  • a pairing code

Open the Hive link on the device that should receive notifications. Install Hive when your browser offers it, allow notifications, then enter the pairing code.

After pairing, the device appears in Devices.

3. Create An API Token

Section titled “3. Create An API Token”

Open Account -> API Tokens and create a token.

Copy it immediately. BeeBuzz shows the raw token only once.

If you have only the default topic, keep the token scoped to that topic.

4. Send Your First Notification

Section titled “4. Send Your First Notification”

The shortest test uses trusted HTTP delivery:

Terminal window
curl https://push.beebuzz.app \
  -H "Authorization: Bearer $TOKEN" \
  -F title="Hello from BeeBuzz" \
  -F body="First delivery test"

Trusted delivery means BeeBuzz receives the notification title and body so it can send them to your paired devices.

For end-to-end encrypted sending, use the CLI or the Home Assistant integration.

Common First-Run Issues

Section titled “Common First-Run Issues”

If nothing arrives, check these first:

  • the device is listed as paired in Account -> Devices
  • notification permission is allowed
  • Hive is installed where your platform requires it
  • the API token is allowed to send to the topic
  • the receiving device is subscribed to that topic

On iPhone and iPad, open Hive from the installed app icon. Web Push does not work from a normal browser tab.

Next Steps

Section titled “Next Steps”