Skip to main content
POST
Register a webhook endpoint

Authorizations

Authorization
string
header
required

Partner API key issued by Cactus.

Headers

Idempotency-Key
string

Unique key making the request safely retryable.

Maximum string length: 255

Body

application/json
url
string<uri>
required

HTTPS endpoint to receive events.

events
enum<string>[]
required
Available options:
extraction.completed,
extraction.failed,
underwriting.completed,
underwriting.failed

Response

201 - application/json

Endpoint registered; secret returned once.

id
string
required
Example:

"we_01J9ZKQ2"

url
string<uri>
required
events
enum<string>[]
required
Available options:
extraction.completed,
extraction.failed,
underwriting.completed,
underwriting.failed
status
enum<string>
required
Available options:
enabled,
disabled
created_at
string<date-time>
required
secret
string
required

HMAC signing secret — shown only in this response.

Example:

"whsec_9f2c..."