BrambleHelp

Developers

Bramble Cloud for developers

Call Bramble's API from your own scripts and products, receive webhooks, add single sign-on, and look up every endpoint.

Everything the Bramble apps do, they do through HTTP APIs, and you can call the same APIs from your own scripts, servers and products.

#Start here

I want to… Read
Call Bramble from a script, a server or another product Calling the API
Get an API key, or sign people in from my own app Authentication
Receive events, webhooks, calendars or status updates Webhooks and integrations
Understand which licences and roles an API call needs Licences and roles
Know how the platform keeps data safe Security
Find a specific endpoint API reference

#Quick start

  1. Create an API key in My account → API Keys. See API keys.
  2. Call the API with the key in the X-API-Key header:
Bash
curl https://yourcompany.brambleit.cloud/api/user/name \
  -H "X-API-Key: $BRAMBLE_KEY"
  1. Browse the API reference for the app you want to work with. Every endpoint has copy-and-paste examples in curl, Node.js, Python and PowerShell.

#Downloads

  • An OpenAPI 3 file for each app, linked from each app's page in the API reference. Import them into Postman, Insomnia or a client generator.
  • routes.json: every public route on the platform, in one machine-readable file.

Note

The API reference is generated from the apps' source code, so it always matches what's running. Descriptions are written by the Bramble team, and anything not described yet gets a short summary from its method and path.

Essentials

For developers