Skip to main content
PATCH
Update a webhook

Authorizations

X-API-Key
string
header
required

API Key

Headers

X-SUB-PARTNER-ID
string

Optional sub-partner UUID, if provided, the webhook will be updated under scope of the sub-partner

X-API-Version
string

Selects the API version for this request, as an ISO date (YYYY-MM-DD). Omit to use the default version (2025-03-13). Supported versions: 2025-03-13, 2026-07-01.

Path Parameters

id
string<uuid>
required

The ID of the webhook to update

Body

application/json; charset=utf-8

The webhook update request

Update Webhook Request

Request to update an existing webhook

enabled
boolean

Optional enabled status

label
string

Optional new label for the webhook

topics
enum<string>[]

Optional new topics for the webhook

Webhook Event Types

Represents the different types of webhook events that can be sent

Available options:
Transaction,
NewBankAccount,
NewAutoramp,
DepositAddressCreated,
RegisterFiatAddressStatus,
RegisterAutorampStatus,
TransactionStatus,
CustomerCreated,
CustomerStatus,
IdentificationStatus,
Ping
url
string

Optional new URL for the webhook

Response

Update successful

Webhook

Response containing webhook details

created_at
string<date-time>
required

When the webhook was created

enabled
boolean
required

Whether the webhook is enabled

id
string<uuid>
required

The ID of the webhook

label
string
required

A descriptive label for the webhook

partner_id
string<uuid>
required

The partner ID that owns this webhook

topics
enum<string>[]
required

The topics this webhook subscribes to

Webhook Event Types

Represents the different types of webhook events that can be sent

Available options:
Transaction,
NewBankAccount,
NewAutoramp,
DepositAddressCreated,
RegisterFiatAddressStatus,
RegisterAutorampStatus,
TransactionStatus,
CustomerCreated,
CustomerStatus,
IdentificationStatus,
Ping
updated_at
string<date-time>
required

When the webhook was last updated

url
string
required

The URL to send webhook events to

last_failure
string<date-time>

The last time the webhook was executed with an error

last_failure_reason
string

The reason for the last failure