Create a new webhook
Creates a new webhook, which will be triggered on the specified events
Endpoint Permissions: Owner, Admin, Non-Signing Admin.
Headers
A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.
Body
The url of the webhook where notifications will be sent. URL must be valid, unique and https.
1"https://example.com/webhook"
event types the webhook will subscribe to
transaction.created, transaction.status.updated, transaction.approval_status.updated, transaction.network_records.processing_completed, external_wallet.asset.added, external_wallet.asset.removed, internal_wallet.asset.added, internal_wallet.asset.removed, contract_wallet.asset.added, contract_wallet.asset.removed, vault_account.created, vault_account.asset.added, vault_account.asset.balance_updated, vault_account.nft.balance_updated, embedded_wallet.status.updated, embedded_wallet.created, embedded_wallet.asset.balance_updated, embedded_wallet.asset.added, embedded_wallet.account.created, embedded_wallet.device.added, onchain_data.updated, connection.added, connection.removed, connection.request.waiting_peer_approval, connection.request.rejected_by_peer, exchange_account.connected, fiat_account.connected, connected_account.connected, ticket.created, ticket.submitted, ticket.expired, ticket.canceled, ticket.fulfilled, ticket.counterparty.added, ticket.counterparty_external_id.set, ticket.note.added, ticket.expires_at.set, ticket.expires_in.set, ticket.term.added, ticket.term.updated, ticket.term.deleted, ticket.term.funded, ticket.term.manually_funded, ticket.term.funding_canceled, ticket.term.funding_failed, ticket.term.funding_completed, ticket.term.transaction_status_changed, settlement.created, order.updated, automation_execution.update description of the webhook. should not contain special characters.
1"This webhook is used for transactions notifications"
The status of the webhook. If false, the webhook will not receive notifications.
false
mTLS configuration for the webhook. On responses, present only when a signed client certificate is set. On requests, provide a signed client certificate to enable mTLS, or null to remove it.
OAuth 2.0 client credentials configuration for the webhook. When set, the webhook dispatcher fetches a bearer token from the configured token endpoint before each delivery and attaches it as Authorization: Bearer {token}. Send null to remove OAuth configuration entirely.
Custom HTTP headers attached to every notification delivered by this webhook (max 10). Header names must be valid RFC 7230 tokens (printable ASCII, no separators), are treated case-insensitively (duplicate names differing only in case are rejected), and may not exceed 128 characters. The following names are reserved and cannot be used: Host, Content-Type, Content-Length, Transfer-Encoding, Connection, User-Agent, Accept, Accept-Encoding, Fireblocks-Signature, Fireblocks-Webhook-Signature. Header values are write-only — never returned in responses.
Response
created new webhook successfully
The id of the webhook
"123e4567-e89b-12d3-a456-426614174000"
The url of the webhook where notifications will be sent. Must be a valid URL and https.
1"https://example.com/webhook"
The events that the webhook will be subscribed to
transaction.created, transaction.status.updated, transaction.approval_status.updated, transaction.network_records.processing_completed, external_wallet.asset.added, external_wallet.asset.removed, internal_wallet.asset.added, internal_wallet.asset.removed, contract_wallet.asset.added, contract_wallet.asset.removed, vault_account.created, vault_account.asset.added, vault_account.asset.balance_updated, vault_account.nft.balance_updated, embedded_wallet.status.updated, embedded_wallet.created, embedded_wallet.asset.balance_updated, embedded_wallet.asset.added, embedded_wallet.account.created, embedded_wallet.device.added, onchain_data.updated, connection.added, connection.removed, connection.request.waiting_peer_approval, connection.request.rejected_by_peer, exchange_account.connected, fiat_account.connected, connected_account.connected, ticket.created, ticket.submitted, ticket.expired, ticket.canceled, ticket.fulfilled, ticket.counterparty.added, ticket.counterparty_external_id.set, ticket.note.added, ticket.expires_at.set, ticket.expires_in.set, ticket.term.added, ticket.term.updated, ticket.term.deleted, ticket.term.funded, ticket.term.manually_funded, ticket.term.funding_canceled, ticket.term.funding_failed, ticket.term.funding_completed, ticket.term.transaction_status_changed, settlement.created, order.updated, automation_execution.update The status of the webhook
DISABLED, ENABLED, SUSPENDED "ENABLED"
The date and time the webhook was created in milliseconds
1625126400000
The date and time the webhook was last updated in milliseconds
1625126400000
description of the webhook of what it is used for
1"This webhook is used for transactions notifications"
mTLS configuration for the webhook. On responses, present only when a signed client certificate is set. On requests, provide a signed client certificate to enable mTLS, or null to remove it.
OAuth 2.0 client credentials configuration for the webhook. Present only when OAuth is configured. The clientSecret is write-only and is never returned.
Names of the custom headers configured for this webhook. Header values are never returned.