Skip to main content
The API Keys section allows you to create and manage API keys that can be used to connect external applications or services with your Verbex account. API keys help authorized applications communicate with the Verbex platform securely.

​
Creating a New API Key

To create a new API key, click the + Add new API key button in the top-right corner of the API Keys page. A pop-up window titled Create new API key will appear. You will need to provide the following information:

​
Name

Enter a name for your API key.
  • Choose a meaningful name that helps you identify its purpose, for example Metabob Inbound Agent or CRM Integration.
  • This field is required.

​
Workspace

Select the workspace the API key will be associated with.
  1. Click the workspace dropdown.
  2. Select the appropriate workspace from the available options.
The API key will be associated with your selected workspace.

​
Create the API Key

Once you have entered the required information:
  1. Review the API key name.
  2. Confirm that you have selected the correct workspace.
  3. Click Create to generate your API key.
Click Cancel if you do not want to proceed with the creation.

​
Understanding the API Keys List

After creating API keys, you can view and manage them from the API Keys page. The list provides the following information:

​
Understanding API Key Status

  • Active: The API key is currently enabled and can be used for authorized API requests.
  • Revoked: The API key has been disabled and can no longer be used.

​
Revoking an API Key

If an API key is no longer needed or you want to stop an integration from accessing your workspace, you can revoke it.
  1. Find the API key you want to disable in the list.
  2. Navigate to the Actions column.
  3. Click the Revoke button next to that API key.
  4. Confirm the action if a confirmation message appears.
Once revoked, the API key should no longer be used by your integrations. If the integration still needs access, you will need to create and configure a replacement API key.

​
API Key Security Recommendations

For better account security, follow these recommendations:
  • Use a descriptive name for each API key so you can easily identify its purpose.
  • Create separate API keys for different applications or integrations.
  • Never share your API key publicly or include it in screenshots, emails, or public code repositories.
  • Store API keys securely and avoid exposing them in frontend applications.
  • Revoke API keys that are no longer in use.
  • If you suspect an API key has been exposed, revoke it and replace it with a new one.
These practices help reduce the risk of unauthorized access.
API keys should be treated like passwords. Only share them with trusted developers or systems that require access to your Verbex workspace.