Before you begin
Please note the following:
- Only Admin-level users (Owner, Admin, and Non-Signing Admin) can configure webhooks.
- Each webhook URL must be a legal, globally available HTTPS address (e.g., https://example.com) accessible via port 443.
- Webhook URLs cannot exceed 255 characters in length.
- You can enter up to 10 webhook URLs.
- Webhook v2 only: Subdomain URLs cannot contain underscores (_). Including them returns the error:
url must be a URL address.
If you’re looking for information about Audit Event Webhooks for monitoring your workspace’s audit log, check out this article instead.
Note: The BALANCE_UPDATE event is now available through Webhooks v2. Customers can self-subscribe to these events directly via the Fireblocks Console or API. Fireblocks no longer manually enables the BALANCE_UPDATE feature flag for customers.
Configuring Webhooks v1
- In the Fireblocks Console, go to Settings > General > Webhooks and then select Manage webhooks.
- On the Manage webhooks window, enter a URL to define the endpoint, then press Enter.
- Select Save.
Configuring Webhooks v2
There are two methods to configure webhooks using the Webhooks v2 service:
- Via the Fireblocks Console
- Via the Fireblocks API & SDKs (requires an API key with Admin-level permissions)
Creating a webhook
- In the Fireblocks Console, go to Developer center > Webhooks and then select Create webhook.
- On the Create webhook dialog, complete the following fields:
- Endpoint URL: Enter the webhook’s URL address.
- Description: Optionally, enter a short description of the webhook.
- Status: Select whether you want the webhook to be active or inactive.
- Listen for: Select an event category to listen for all its associated events, or select the specific events to listen for from each category.
- Select Create webhook.
Editing a webhook
- In the Fireblocks Console, go to Developer center > Webhooks.
- Find the webhook you want to edit, then select More actions > Edit webhook.
- On the Edit webhook dialog, make the necessary changes and then select Save.
Deactivating & Activating a webhook
- In the Fireblocks Console, go to Developer center > Webhooks.
- Find the webhook you want to deactivate or activate, then select More actions > Deactivate webhook or Activate webhook.
- On the Deactivate or Activate webhook dialog, select Deactivate or Activate.
Deleting a webhook
- In the Fireblocks Console, go to Developer center > Webhooks.
- Find the webhook you want to delete, then select More actions > Delete webhook.
- On the Delete webhook dialog, select Delete.
Via the API & SDKs
Visit our Developer Docs to learn more about configuring webhooks via the Fireblocks API & SDKs.