Create an API key
Server-side credentials, shown once. Who can see them and how to revoke.
API keys are server-side credentials for calling the Bidirection API from your own backend. They are not the key your website widget uses — that one comes from the agent's own page. See Install the script.
Who can see this page: Owners, Admins and Developers. Everyone else sees "Developer access required" and should ask an admin for the Developer role.
Create one#
- Open Settings, then the API keys tab.
- Press Create key.
- Give it a Key name that says where it runs — "Production backend" or "CI". Scope one key per service or environment so you can revoke precisely.
- Press Create key.
- Copy the secret from the dialog now. Press Done when you have stored it.
What the list tells you#
| Column | Meaning |
|---|---|
| Name | What you called it |
| Key | The prefix only, the rest masked |
| Status | Active or Revoked |
| Last used | "Never" until the key authenticates something |
| Created | When it was made |
Last used is the fastest way to find a key nothing is using before you revoke it.
Revoke a key#
Press the bin icon on the key's row and confirm. It stops working immediately and anything still using it starts failing to authenticate. This cannot be undone.
Revoked keys stay in the list, marked Revoked, so the record of what existed survives.