Skip to main content
POST
Register a webhook endpoint

Authorizations

Authorization
string
header
required

An Originalis API key: Authorization: Bearer ak_...

Body

application/json
url
string
required

HTTPS endpoint that will receive signed event POSTs. Must resolve to a public address.

Required string length: 12 - 2048
description
string | null

What this endpoint feeds.

Maximum string length: 300

Response

Successful Response

The ONLY response that ever carries the signing secret.

webhook_id
string
required
url
string
required
secret
string
required

whsec_-prefixed signing secret — shown ONCE, store it now. Verify deliveries per the Standard Webhooks scheme.

events
string[]
required

Event types this endpoint will receive (all of them).

created_at
string<date-time>
required
description
string | null