Skip to content

API Key Connectors

Many services let you create a key that gives a program access to your account. Connectors for these services sign in with that key. Setting up one of these Connectors follows the same steps every time:

  1. At the other service, create an app, integration or key. Give it only the permissions the Connector needs. The Connector's page lists them.
  2. Copy the key (sometimes called a token, secret key or access token).
  3. In Optima, open the Connector's Configure dialog, go to Credentials, paste the key into Secret, and click Save.

The credential will show configured once it is saved. A few Connectors sign in with a Username and Password instead of a key. You can enter those in the same way.

The tab also shows, read-only, how the key is sent — for example, as a bearer token or in a named header. You do not need to change anything there.

Changing A Key

Once a key is saved, it is never shown again: the field says the existing key is kept. To change it — for example, after rotating it at the other service — click Replace, paste the new key, and click Save. Click ↺ to keep the existing key after all.

What The Key Gives Access To

The Connector can do anything the key allows, for everyone who can use the Connector. Outside Assistants, that is everyone on the Gateway; see Who can use it.

Use a key with the narrowest permissions the service offers. Where possible, create it on an account meant for integrations rather than a person's own account.

Connectors That Use An API Key

The following Connectors sign in with a key:

Connector What you need
HubSpot A service key
Stripe A secret key
BreatheHR An API key from Account → API setup
Companies House An API key from a live application on the developer hub
Trello An API key and a token
Weather An OpenWeatherMap API key
Web Answer A Brave Search API key