Create API keys
Create API keys and manage products, webhooks, IP access, replacement, and status.
This page explains how to create and manage API credentials for the current Workspace in Console > Developers. For code integration and request authentication, see Authentication.
Before you start
-
Check the selected Workspace: API keys belong to that Workspace, not to the individual who created them.
-
Activate at least one product: you cannot create an API key without an activated product. Only activated products can be selected for key authorization.
-
Have the required permissions: permissions to view, create, and manage API keys are determined by the role assigned in the current Workspace. Organization Owner is an ownership identity at the organization level and is not used to determine Workspace role permissions.
| Credential | Purpose |
|---|---|
| API Key | Identifies the key used for the request and its Workspace. |
| API Secret | Works with the API Key to authenticate requests according to the product requirements. Store it securely. |
Create an API key
Enter basic information
Select Create ApiKey. Enter APIKEY NAME to identify the application or purpose; Description is optional. Select Continue.
Select products
Under Activate products, select the activated products this key needs, then select Continue.
Review and generate
Review the name and selected products. Webhook and IP whitelist settings are initially Not configured and can be added from the details. Select Generate ApiKey.
Authorization for the selected products requires no review and can be activated directly. Check the key and associated product statuses before sending production traffic.
Save the credentials
Copy API KEY and API SECRET, or select Download TXT, and store them securely on the server. Select I have copied and stored the secret safely, then Continue to ApiKey detail.
The secret is shown only once and cannot be recovered after closing. Keep it out of browser code, repositories, logs, and shared screenshots.
View and manage API keys
Find a key and view its details
Use all, active, or disabled, and Search name or prefix, to find a key. Select the eye icon under Actions to open its details. In Overview, check the key prefix, status, creator, creation time, and associated products.
Add product authorization
Select Add products, choose products already activated in the current Workspace and not yet associated with this key, then select Confirm. Products marked Already added cannot be selected again. Neither product activation nor key product authorization requires review; both can be activated directly.
Removing existing product bindings and reapplying for authorization for an already added product are not supported. Confirm the product and purpose before adding it.
Configure webhooks
Open Webhooks → Add webhook.
-
Product — Select the product receiving this configuration. Webhooks are configured per API key and product; products already configured are hidden when adding.
-
Endpoint URL — Enter your callback endpoint using HTTPS.
-
Event types — Select the events to receive. Available events vary by product.
-
Signing secret — Optionally enable callback verification; implement verification using the product's documented mechanism.
Select Add webhook to save.
Configure an IP whitelist
Open IP Whitelist. Enter your calling server's public IP or CIDR, optionally add a description, then select Add. Use the delete icon to remove an entry.
Check the actual outbound IP of your application before changing the whitelist, so intended callers remain allowed.
Replace a key
Use Replace Key when a Secret is lost, credentials may have been exposed, or you need to rotate credentials regularly. A lost Secret cannot be recovered; update every caller with the replacement credentials.
If credentials may have been exposed, disable the old key promptly to prevent further use. This may interrupt callers that have not switched. For routine rotation, test the replacement before disabling the old key.
Open Replace Key, enter New key name, and select Create replacement. The new key copies the product bindings, webhooks, and IP whitelist. Save its secret, update your application's credentials, and test the new key before disabling the old one.
The old key does not expire automatically. Disable it manually after switching all callers to the replacement.
Disable and restore
Disable
Open the key details, go to Danger Zone, select Disable this ApiKey, then Confirm.
Restore
Find the disabled key, select Restore, then Confirm. Check its status before resuming requests.
Disabling immediately blocks API calls with this key while retaining its history and configuration. The current interface supports disabling rather than deleting keys.
Next step: call an API with your credentials
See Authentication for the exact credential and header requirements, then verify a controlled request with the relevant product quickstart.
Last updated on