Skip to main content
POST
Create a new webhook

Authorizations

Authorization
string
header
required

API key obtained from the Tenant Dashboard. Use as Authorization: Bearer YOUR_API_KEY

Body

application/json
name
string
required

Human-readable name for this webhook

Required string length: 1 - 128
url
string<uri>
required

URL to receive webhook deliveries

events
string[]

Event types to subscribe to (defaults to ["assessment.completed"])

Response

Webhook created

webhook
object
required
secret
string
required

Auto-generated secret. Store securely - not shown again.