Skip to main content
PATCH
/
webhooks
/
{id}
Update a webhook
curl --request PATCH \
  --url https://api.sandbox.iron.xyz/api/webhooks/{id} \
  --header 'Content-Type: application/json; charset=utf-8' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-SUB-PARTNER-ID: <x-sub-partner-id>' \
  --data '
{
  "enabled": true,
  "label": "<string>",
  "topics": [
    "Transaction"
  ],
  "url": "<string>"
}
'
{
  "created_at": "2023-11-07T05:31:56Z",
  "enabled": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "label": "<string>",
  "partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "topics": [
    "Transaction"
  ],
  "updated_at": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "last_failure": "2023-11-07T05:31:56Z",
  "last_failure_reason": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

API Key

Headers

​
X-SUB-PARTNER-ID
string
required

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

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