POST
/
onboarding
/
api
/
v1
/
webhooks
Register Webhook
curl --request POST \
  --url https://api.carbnconnect.com/onboarding/api/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "url": "https://testmywebhook.requestcatcher.com/test",
  "event_category": "ONRAMP_TRANSACTION_STATUS"
}'
{
  "public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA...\n-----END PUBLIC KEY-----",
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "event_category": "ONRAMP_TRANSACTION_STATUS",
  "url": "https://testmywebhook.requestcatcher.com/test",
  "status": "disabled"
}

Authorizations

​
x-api-key
string
header
required

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

Body

application/json
​
url
string<uri>
required

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

Example:

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

​
event_category
enum<string>
required

The category of events this webhook should receive

Available options:
ONRAMP_TRANSACTION_STATUS,
USER_STATUS_UPDATE
Example:

"ONRAMP_TRANSACTION_STATUS"

Response

Webhook registered successfully

​
public_key
string

PEM-formatted public key for webhook signature verification. Use this key to verify the authenticity of webhook events sent to your endpoint.

Example:

"-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA...\n-----END PUBLIC KEY-----"

​
id
string<uuid>

Unique identifier for the registered webhook

Example:

"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

​
event_category
string

The event category for this webhook

Example:

"ONRAMP_TRANSACTION_STATUS"

​
url
string<uri>

The registered webhook URL

Example:

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

​
status
enum<string>

Current status of the webhook (created as 'disabled' by default)

Available options:
enabled,
disabled
Example:

"disabled"