PUT
/
onboarding
/
api
/
v1
/
webhooks
Update Webhook
curl --request PUT \
  --url https://api.carbnconnect.com/onboarding/api/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "url": "https://testmywebhook.requestcatcher.com/test112",
  "status": "disabled"
}'
{
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "url": "https://testmywebhook.requestcatcher.com/test112",
  "status": "enabled",
  "event_category": "ONRAMP_TRANSACTION_STATUS"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Must be included in the x-api-key header.

Body

application/json
​
id
string<uuid>
required

Unique identifier of the webhook to update

Example:

"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

​
url
string<uri>

The HTTPS URL where webhook events will be sent. Must use HTTPS protocol.

Example:

"https://testmywebhook.requestcatcher.com/test112"

​
status
enum<string>

Status of the webhook. Webhooks are created with 'disabled' status by default and must be enabled using this endpoint.

Available options:
enabled,
disabled
Example:

"disabled"

Response

Webhook updated successfully

​
id
string<uuid>

Unique identifier of the updated webhook

Example:

"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

​
url
string<uri>

Updated webhook URL

Example:

"https://testmywebhook.requestcatcher.com/test112"

​
status
enum<string>

Updated webhook status

Available options:
enabled,
disabled
Example:

"enabled"

​
event_category
string

The event category for this webhook (cannot be changed after creation)

Example:

"ONRAMP_TRANSACTION_STATUS"