Generate an API key from your Organization’s admin dashboard, then add it to your Beam configuration. That’s the whole setup.

Generate an API key

1. Open Integrations → API Keys at somewear.app/app/settings/organization/integrations.
2. Create a new API key.
3. Copy it somewhere safe — a password manager, not a text file you’ll lose track of.

Note

If you don’t see the Integrations page or the API Keys section, ask the Somewear team to enable it for your Organization.

Activate the key for a Workspace

An API key can’t send or receive data until it’s added to a Workspace. Click the gear icon next to your new key, then toggle on the Workspace you want this key to act on.

Add the key to Beam

Add the key to your beam.properties file under api-key:

api-key=<YOUR_API_KEY>

Authenticate more than one Beam instance

Running Beam on more than one machine? Give each instance its own API key so you can tell them apart later in the admin dashboard.

If you’d rather share one API key across instances, authenticate with basic auth instead:

api-key=<YOUR_API_KEY>
username=<YOUR_USERNAME>
password=<YOUR_PASSWORD>