Skip to main content
POST
/
webhooks
Create Webhook
curl --request POST \
  --url https://api.coinvoyage.io/v2/webhooks \
  --header 'Authorization-Signature: <authorization-signature>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subscription_events": [
    "ORDER_CREATED",
    "ORDER_COMPLETED"
  ],
  "url": "https://example.com/webhook"
}
'
{
  "active": true,
  "id": "cuidjkhg3e289y74u5t6v",
  "subscription_events": [
    "ORDER_CREATED",
    "ORDER_COMPLETED"
  ],
  "url": "https://example.com/webhook",
  "webhook_secret": "whsec_xxxxx"
}

Headers

​
Authorization-Signature
string
required

Authorization header format: 'APIKey=<api_key>,signature=,timestamp=<unix_timestamp>'

Body

application/json
​
url
string
required
Example:

"https://example.com/webhook"

​
subscription_events
string[]
Example:
["ORDER_CREATED", "ORDER_COMPLETED"]

Response

Webhook created successfully

​
id
string
required
Example:

"cuidjkhg3e289y74u5t6v"

​
url
string
required
Example:

"https://example.com/webhook"

​
active
boolean
required
Example:

true

​
webhook_secret
string
Example:

"whsec_xxxxx"

​
subscription_events
string[]
Example:
["ORDER_CREATED", "ORDER_COMPLETED"]