Update webhook
Update a webhook by its id
Endpoint Permission: Owner, Admin, Non-Signing Admin.
Path Parameters
The unique identifier of the webhook
"44fcead0-7053-4831-a53a-df7fb90d440f"
Body
The url of the webhook where notifications will be sent. URL must be valid, unique and https.
1"https://example.com/webhook"
description of the webhook of what it is used for.should not contain special characters.
1"This webhook is used for transactions notifications"
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 The status of the webhook
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.
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.
"123e4567-e89b-12d3-a456-426614174000"
A delta applied to the delivery headers. A header with a value is added or replaced, a header with null is deleted, and one you leave out is untouched. A value replaces what is stored under that name rather than adding to it, so an array is the complete new set of lines for that header.
Send customHeaders: null to clear every header in one call. That does not collide with a null value on a name: one names the header to delete, the other names the whole field.
Names are case-insensitive, so a null under one casing deletes a header stored under another.
Same rules as on create: string or non-empty array, Cookie string-only, 10 lines total and under 16 KB in the resulting set, the same reserved names, and values write-only. Entries set to null do not count towards the limit.
Response
Updated webhook object
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, 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 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.
The id of the OAuth credentials this webhook authenticates with. Absent when the webhook does not use OAuth. Read the credentials themselves from /v1/webhooks_settings/oauth/{webhookOauthId}.
"123e4567-e89b-12d3-a456-426614174000"
Names of the custom headers configured for this webhook. Header values are never returned.