Skip to main content
POST
/
ramp
/
webhook
Create webhook
curl --request POST \
  --url https://api.etherfuse.com/ramp/webhook \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "eventType": "order_updated",
  "url": "https://example.com/webhook"
}
'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "eventType": "order_updated",
  "url": "https://example.com/webhook",
  "secret": "base64_encoded_secret",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Pass the key directly (e.g., Authorization: your-api-key). Do not use a Bearer prefix.

Body

application/json
​
id
string<uuid>

Webhook ID

​
eventType
enum<string>

Type of event to subscribe to

Available options:
bank_account_updated,
customer_updated,
order_updated,
swap_updated,
kyc_updated
​
url
string<uri>

URL where webhook events will be sent

Response

Webhook created successfully

​
id
string<uuid>

Webhook ID

​
eventType
enum<string>

Type of event the webhook is subscribed to

Available options:
bank_account_updated,
customer_updated,
order_updated,
swap_updated,
kyc_updated
​
url
string<uri>

URL where webhook events will be sent

​
secret
string

Webhook secret for signing events

​
createdAt
string<date-time>

Timestamp when the webhook was created

​
updatedAt
string<date-time>

Timestamp when the webhook was last updated