Beekon Cloud is the managed, hosted side of Beekon: the server API, the console and the SDK’s cloud mode. It is in early access. Self-serve sign-up arrives with a coming console release (Sign up and set up your workspace); until then we set up each early-access organisation with its team. If you have been given a console sign-in or keys, everything on this page and in the server API reference works for you today.
You have been given access: start here
Section titled “You have been given access: start here”-
Sign in to the console at console.getbeekon.com with the account we set up for you. Pick your project in the project switcher. See The console.
-
Issue your keys on the console’s API keys page (owners and admins). A new project starts with none. The SDK key (
bkproj_<cell>_…) goes in your app. A server key (bkserv_<cell>_…) stays on your backend and carries the scopes chosen when it was issued. The second segment of either key is your region, which names your API host:https://api.<cell>.getbeekon.com. -
Call the server API: Server API quickstart takes a server key to a page of locations in four
curlcommands. -
Send locations. From an app, configure the SDK’s Cloud mode with the SDK key. With no app yet, upload locations from your server with
POST /v1/ingest. -
Add a geofence and a webhook, then watch the events arrive: draw one on the console’s Geofences, add an endpoint on Webhooks, and read Events. The Geofences, Webhooks and Events APIs do the same from your backend.
Questions, problems, and the requests on this page that have no button or endpoint yet go to your Beekon contact, or through getbeekon.com.
Cloud mode (the SDK side)
Section titled “Cloud mode (the SDK side)”In Cloud mode you configure the SDK with one project key, and the server owns the rest:
- Setup.
BeekonConfig.cloud(projectKey: "bkproj_<cell>_…"). The key names your project’s region, and the SDK derives its endpoints from it without a network call. See Configuration. - Config. Tracking settings come from the project’s remote config document, cached on the device. The SDK clamps every remote value to its own safe ranges, so no server value can drain the battery or redirect uploads. Tracking never waits for config.
- Geofences. You draw them centrally (circles and polygons). Each device receives the fences near it with its sync response, and shows crossing notifications even when the app has been killed and the device is offline. See Geofencing.
- Device control. Config acknowledgements, health reports and remote commands (flush, upload logs) travel in the same sync exchange.
- Monthly active users.
setUserId(...)binds a user id to each location when it is recorded; a device with no user id counts by its install id.
Cloud mode uses the same SDK client and the same wire contracts as every other mode.
How the platform handles your data
Section titled “How the platform handles your data”These are Beekon Cloud’s rules for your data, in plain words.
Acceptance is durable, within your plan’s retention window.
- A successful upload (
2xx) means the accepted locations are stored durably for as long as your plan retains data. - Locations older than your retention window are deleted by a sweep that deletes nothing when in doubt.
- If your plan has no retention window, data is kept until you delete it.
- Your project’s window is shown on the console’s Locations page and in Project settings › Data retention. It is set by your plan: to change it, ask your Beekon contact.
The MAU cap discards nothing. A project can opt into a monthly active user (MAU) cap. It
alerts — the console, the status pill and billing.usage_threshold events — and never stops
usage: past the cap, new users are still admitted, counted and billed, and every location is
kept. See the MAU cap.
Deletion and export on demand. Everything stored for one end user (user_id) can be erased
or exported: every table, verified by re-count, and recorded with a keyed hash rather than the
identifier itself. A whole project can be erased too. Who can do what, and how, is on
Your data.
Without Beekon Cloud
Section titled “Without Beekon Cloud”The SDK works without Beekon Cloud and needs no account. In Custom mode it uploads to your own server, with batching and retries; in Local mode nothing leaves the device. Background tracking and geofencing work in both (Configuration).
Ask for early access
Section titled “Ask for early access”Want Beekon Cloud for your team? Reach out via getbeekon.com.