Skip to main content
PUT
/
config
/
webhook
Set or update webhook URL
curl --request PUT \
  --url https://api.vocobase.com/api/v2/config/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhook_url": "https://example.com/webhooks/vocobase"
}
'
{
  "success": true,
  "data": {
    "webhook_url": "https://example.com/webhooks/vocobase",
    "webhook_secret": "whsec_abc123...",
    "message": "Save this secret — it will not be shown again."
  }
}

Authorizations

​
Authorization
string
header
required

API key in format: rg_live_xxxx. Pass as a Bearer token in the Authorization header.

Body

application/json
​
webhook_url
string<uri>
required

HTTPS URL to receive webhook events.

Example:

"https://example.com/webhooks/vocobase"

Response

Webhook configured successfully. The secret is shown only once.

​
success
boolean
​
data
object