Skip to main content
POST
Register a webhook endpoint

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
url
string<uri>
required

HTTPS endpoint URL.

Example:

"https://yourapp.com/webhooks/orbit"

events
string[]
required

Subscribed event types. See WEBHOOK_EVENT_TYPES (e.g. message.delivered, call.completed, verification.approved).

Minimum array length: 1
Example:
secret
string

Optional shared secret. Used to verify the X-Orbit-Signature HMAC (canonical header) on every delivery. X-Devotel-Signature carries the identical value for back-compat. Prefer X-Orbit-Signature in verifier code.

Minimum string length: 16
active
boolean
default:true

Whether to start dispatching events immediately.

description
string
Maximum string length: 255
timeout_seconds
integer
default:30

Per-endpoint HTTP delivery timeout in seconds (1-30). The dispatcher aborts an in-flight delivery once this many seconds elapse. Defaults to 30 (the platform hard ceiling) when omitted.

Required range: 1 <= x <= 30
retry_policy
object

Response

Endpoint registered

Endpoint registered

data
object
meta
object