Create a new webhook
Creates a new webhook, which will be triggered on the specified events
Endpoint Permissions: Owner, Admin, Non-Signing Admin.
Headers
Body
event types the webhook will subscribe to
transaction.created, transaction.status.updated, transaction.approval_status.updated, transaction.network_records.processing_completed, transaction.alert.stuck, 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, vault_account.bulk_create_job_started, vault_account.bulk_create_job_ended, vault_account.asset.bulk_add_job_started, vault_account.asset.bulk_add_job_ended, 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, exchange_account.credentials_replaced, connected_account.credentials_replaced, 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 id of the mTLS configuration this webhook presents when delivering, from /v1/webhooks_settings/mtls. Several webhooks may share one configuration, so replacing its certificate covers all of them at once. Send null to stop using mTLS for this webhook.
"6f1b7c62-0f2e-4f1a-9a5e-9f2b1c3d4e5f"
The id of the OAuth credentials this webhook authenticates with, from /v1/webhooks_settings/oauth. Several webhooks may share one credential set, so rotating its client secret covers all of them at once. Send null to stop using OAuth for this webhook. Cannot be combined with an authorization custom header on the same webhook; a request that would leave both set is rejected.
"123e4567-e89b-12d3-a456-426614174000"
Custom HTTP headers attached to every notification delivered by this webhook.
A value is a string, sent as one header line, or an array of strings, sent as one header line per element under the same name. Cookie and Authorization accept only a string. An empty array is rejected — leave the name out instead.
At most 10 headers, counted by name — an array value counts once, however many lines it sends. Names must be valid HTTP header tokens, are case-insensitive, and are at most 128 characters. A value may be empty and has no length limit of its own; the whole object must be under 16 KB when serialized as UTF-8. A value that large may still be refused by your own endpoint, since web servers commonly cap the whole request header block at around 8 KB.
Reserved names: Host, Content-Type, Content-Length, Transfer-Encoding, Connection, User-Agent, Accept, Accept-Encoding, Fireblocks-Signature, Fireblocks-Webhook-Signature. Authorization may be set, but not together with webhookOauthId; a request that would leave both set is rejected.
Values are write-only; responses return only the header names.
Response
created new webhook successfully
The events that the webhook will be subscribed to
transaction.created, transaction.status.updated, transaction.approval_status.updated, transaction.network_records.processing_completed, transaction.alert.stuck, 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, vault_account.bulk_create_job_started, vault_account.bulk_create_job_ended, vault_account.asset.bulk_add_job_started, vault_account.asset.bulk_add_job_ended, 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, exchange_account.credentials_replaced, connected_account.credentials_replaced, 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