Skip to main content
POST
/
api
/
v1
/
webhooks
Register or update a merchant webhook URL
curl --request POST \
  --url https://core-dev.quidkey.com/api/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhook_url": "https://example.com/webhook"
}
'
{
  "success": true,
  "data": {
    "webhook_url": "https://example.com/webhook",
    "message": "Webhook URL successfully configured"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Webhook configuration input

Webhook configuration input

​
webhook_url
string<uri>
required

The URL where webhook notifications will be sent

Example:

"https://example.com/webhook"

Response

Success

​
success
boolean
required

Indicates if the request was successful

Example:

true

​
data
Webhook · object
required

Webhook configuration