Skip to main content
PUT
/
webhooks
/
{webhook_id}
Error
A valid request URL is required to generate request examples
{
  "active": true,
  "id": "cuidjkhg3e289y74u5t6v",
  "subscription_events": [
    "ORDER_CREATED",
    "ORDER_COMPLETED"
  ],
  "url": "https://example.com/webhook",
  "webhook_secret": "whsec_xxxxx"
}

Documentation Index

Fetch the complete documentation index at: https://coinvoyage-3c99945b.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization-Signature
string
required

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

Path Parameters

​
webhook_id
string
required

The unique identifier of the webhook

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