Skip to main content
POST
Register a webhook endpoint

Authorizations

X-API-Key
string
header
required

Organization API key (hp_live_...), sent in the X-API-Key header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A full-access key can call every endpoint in this reference. A read-only key can call GET endpoints (and create a trading stream token); any other request returns 403 READ_ONLY_KEY. A key with an IP allowlist returns 403 IP_NOT_ALLOWED from any other address. Each endpoint lists which keys can call it under Access.

Headers

Idempotency-Key
string

Optional. A value that identifies this operation on your side, at most 255 characters. A retry with the same key, method, path and body within 24 hours returns the original response (with Idempotency-Replayed: true) instead of repeating the change. The same key with a different body returns 409 IDEMPOTENCY_KEY_REUSED; a retry while the first request is still running returns 409 IDEMPOTENCY_KEY_IN_PROGRESS. A response that contains a credential (such as a new API key or signing secret) is not saved: the change is still not repeated, and a retry returns 409 IDEMPOTENCY_KEY_COMPLETED with the original status in originalStatus. Server errors (5xx) are not saved, so a retry runs again. If the key cannot be recorded, the request is not run and returns 503 IDEMPOTENCY_UNAVAILABLE; retry with the same key.

Maximum string length: 255

Body

application/json
url
string
required

Webhook endpoint URL. Must be HTTPS, at most 2048 characters.

Maximum string length: 2048
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,
account.payout_reversed,
account.time_limit_extended,
account.daily_loss_limit_off,
account.daily_loss_limit_on,
account.claim_refused,
purchase.created,
purchase.status_changed,
trader.created,
snapshot.ready,
fill.created,
account.balance_changed,
account.balance_adjusted,
account.trading_day_reverted,
account.trading_day_revert_undone,
risk.report_ready,
risk.hedge_pair_flagged,
risk.copy_trading_flagged,
risk.shared_device_flagged,
trader.signed_in,
alert.limit_crossed,
alert.limit_cleared
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."