Skip to main content
POST
Register a webhook endpoint

Authorizations

Authorization
string
header
required

JWT Bearer token for user session auth. Format: "Bearer {token}". Used by User and Organization endpoints.

Body

application/json
url
string
required

Webhook endpoint URL. Must be HTTPS.

Example:

"https://your-server.com/webhooks/hyperprop"

events
enum<string>[]
required

Event types to subscribe to. Use ["*"] for all current and future events.

Minimum array length: 1
Available options:
*,
account.created,
account.status_changed,
account.updated,
account.imported,
account.unlinked,
account.passed,
account.failed,
account.lockout_created,
account.lockout_removed,
account.lockout_updated,
account.payout_processed,
account.max_payouts_reached,
purchase.created,
purchase.status_changed,
trader.created,
snapshot.ready,
fill.created
Example:
description
string

Optional label (e.g. "Production", "Staging CRM")

Maximum string length: 255
Example:

"Production webhook"

Response

Webhook created — the signing secret is included in this response only

success
boolean
Example:

true

data
object
message
string
Example:

"Webhook created. Save your signing secret — it won't be shown again."