Develop & Integrate
API ReferenceTry in Sandbox

Configuring webhooks

Overview

There are three methods to configure webhooks using the Webhooks v2 service:

  • Via the Fireblocks Console
  • Via the Fireblocks API (requires an API key with Admin-level permissions)
  • Via the Fireblocks TypeScript SDK (requires an API key with Admin-level permissions)

❗️

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) accesible via port 443.
  • Webhook URLs cannot exceed 255 characters in length.
  • You can enter up to 20 webhook URLs. If you want to configure more than 20 webhook URLs, deploy a server that receives webhooks at one of the URLs entered. You can then distribute webhook events to multiple destinations from your server.

If you’re looking for information about Audit Event Webhooks for monitoring your workspace’s audit log, check out this Help Center article instead.

Via the Console

  1. In the Fireblocks Console, go to Developer center > Webhooks and then select Create webhook.
  2. On the Create webhook dialog, complete the following fields:
    1. Endpoint URL: Enter the webhook’s URL address.
    2. Description: Optionally, enter a short description of the webhook.
    3. Status: Select whether you want the webhook to be active or inactive.
    4. Listen for: Select an event category to listen for all its associated events, or select the specific events to listen for from each category.
  3. Select Create webhook.

Via the API

  1. Get your Fireblocks API key with the required permissions to manage webhooks.
  2. Call the Create a new webhook endpoint.
  3. Enter the appropriate values for the required parameters in your request.
  4. Deploy the webhook on your backend.

Via the TypeScript SDK

  1. Get your Fireblocks API key with the required permissions to manage webhooks.
  2. Use the createWebhook command to set up your webhook URL.

🚧

Migrating to Webhooks v2 from Webhooks v1?

Start with our Webhooks v2 Migration Guide to learn more about the benefits of and key changes in the Webhooks v2 service, and to find a mapping guide for converting your Webhooks v1 events to Webhooks v2 events.