Skip to main content
Every API call carries an API key in the Authorization header.

Key format

The key starts with unite_live_ followed by 40 letters and numbers. In the examples in this documentation we use the value unite_live_YOUR_KEY_HERE, which does not work. Unite stores only an irreversible version of the key. That is why the full value is shown only once, when it is created. If you lose it, create another one and revoke the old one.
The key is a server secret. Do not use it in a browser, in a mobile app or in a repository. Whoever has the key can do everything its permissions allow.

Who creates keys

Only workspace administrators create and revoke keys, under API keys, in the workspace dashboard. In the same dashboard, administrators also manage the webhook endpoints. The API must be enabled for the workspace. If it is not, the screen says so and the API responds feature_not_enabled.

Permissions

Each key has one or more permissions (scopes). For the complete first pre-test flow, the key needs both scopes. Without the required scope, the response is insufficient_scope. Give each integration only what it uses. Receiving notifications through webhooks requires the webhooks:manage scope only to register and manage the endpoints. The events themselves reach your server without using the key.

Expiry

When creating, choose 30, 90 or 365 days, or no expiry. Once expired, the key responds api_key_expired. Prefer keys with an expiry and replace them before they expire.

Revocation

Any administrator revokes a key on the same screen. Revocation takes effect immediately and cannot be undone: the key starts responding api_key_revoked. Revoke whenever you suspect a leak.

The key acts on behalf of its creator

The key represents the member who created it. Pre-tests created by it are recorded under that person’s name. If that person leaves the workspace or loses access to it, the key stops working. The webhook endpoints created by that person are also disabled (disabledReason: "creator_removed"); revoking a key, by contrast, does not affect endpoints. On every call, Unite checks again that this person is still an active member of the workspace. If they leave the workspace or lose access, the key stops working and responds key_owner_not_member, even if it was not revoked. For a long-lived integration, create the key with an account that should stay in the workspace.

Isolation

The key only sees the workspace where it was created. Ids from another workspace respond as if they did not exist (404).