Skip to main content
POST
Create a webhook endpoint

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