Skip to main content
PATCH
/
webhooks
/
{webhook_id}
Update Webhook (partial)
curl --request PATCH \
  --url https://api.coinvoyage.io/v3/webhooks/{webhook_id} \
  --header 'Authorization: <api-key>' \
  --header 'Authorization-Signature: <authorization-signature>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "active": true,
  "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"
}

Authorizations

​
Authorization
string
header
required

HMAC-SHA256 signature. See the Authorization-Signature header parameter on signed operations.

Headers

​
Authorization-Signature
string
required

HMAC-SHA256 signature header: 'APIKey=<api_key>,signature=,timestamp=<unix_timestamp>'. The signature is computed over METHOD + path (with the /v3 prefix stripped) + timestamp.

Path Parameters

​
webhook_id
string
required

Body

application/json
​
url
string | null
Example:

"https://example.com/webhook"

​
subscription_events
string[]
Example:
["ORDER_CREATED", "ORDER_COMPLETED"]
​
active
boolean | null
Example:

true

Response

Webhook updated

​
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"]