Skip to main content
POST
/
config
/
webhooks
Create a webhook endpoint
curl --request POST \
  --url https://api.vocobase.com/api/v2/config/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "prod",
  "url": "https://example.com/webhooks/vocobase",
  "enabled": true
}
'
{
  "success": true,
  "data": {
    "id": "12345678-abcd-1234-abcd-123456789012",
    "label": "prod",
    "url": "https://example.com/webhooks/vocobase",
    "enabled": true,
    "last_delivery_at": null,
    "last_delivery_status": null,
    "created_at": "2026-05-25T10:00:00.000Z",
    "updated_at": "2026-05-25T10:00:00.000Z",
    "secret": "whsec_abc123...",
    "message": "Save this secret — it will not be shown again."
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.vocobase.com/llms.txt

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

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
label
string
required

Partner-chosen endpoint label. Lowercase letters, numbers, and hyphens only; 1-31 characters.

Pattern: ^[a-z0-9][a-z0-9-]{0,30}$
Example:

"prod"

​
url
string<uri>
required

HTTPS URL that receives webhook events.

Example:

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

​
enabled
boolean
default:true

Whether the endpoint should receive new webhook events.

Response

Webhook endpoint created. Save the secret immediately.

​
success
boolean
​
data
object