Managing Webhooks and API Keys
This article explains how to manage Webhooks and API keys for integrating with external systems and building custom integrations.
Webhooks
What is a Webhook
When you set up a Webhook, you can notify an external URL in real time about events that occur in Terasu (Room creation, message sending, etc.). You can use this for integration with CRMs and internal tools.
Create a Webhook
- Click the workspace name at the top of the sidebar to open the menu
- Select "Settings"
- From the settings page sidebar, open "Webhook Settings"
- Click "Add Webhook"
- Enter a name and the destination URL
- Select the events to notify about
- Click "Create"
Test send
After configuring a Webhook, you can verify it with the "Test" button. A test event is sent to the specified URL, and you can review the response.
If your Webhook isn't working correctly, check that the destination URL uses HTTPS and that the server returns a 200 response.
You can create up to 10 Webhooks per workspace.
API keys
What is an API key
With an API key, you can access various Terasu data programmatically. It's useful for building automation scripts and custom dashboards.
Create an API key
- Click the workspace name at the top of the sidebar to open the menu
- Select "Settings"
- From the settings page sidebar, open "API Keys"
- Click "Create API key"
- Set the key's name and scope (permission range)
- Click "Create"
- Copy the displayed key and store it securely
An API key is shown in full only at creation time. Since you can't view it again later, be sure to copy it and store it in a safe place.
Key management
| Action | Description |
|---|---|
| Last used | Check when the key was last used |
| Prefix display | For security, only the first few characters are shown |
| Revoke | Immediately disable a key you no longer need |
API keys are available on the Business plan. You can create up to 3 per workspace.