Skip to main content
POST
cURL
Register an HTTPS endpoint to receive webhook events as they happen. The endpoint starts in pending_verification and must be verified before deliveries begin.
The response includes a one-time signing_secret and a verification.token. Copy the secret now. You can’t retrieve it later. Use it to verify the x-0xinsider-signature header on every delivery; see the Webhooks guide. Then send the verification token to Verify Webhook to activate the endpoint. If the secret leaks, rotate it. Send Idempotency-Key when retrying after a timeout. The same key with the same body returns the original webhook; the same key with a different body returns 422.

Authorizations

Authorization
string
header
required

API key authentication. Send your key in the Authorization header as Bearer oxi_sk_live_.... Live keys require an active Pro subscription and return live data.

Headers

Idempotency-Key
string

Optional safe-retry key. Reuse the same value only when retrying the exact same mutation request body; a different body returns 422 and an in-flight matching request returns 409.

Required string length: 1 - 255

Body

application/json
name
string
required
Maximum string length: 100
url
string<uri>
required

Public HTTPS callback URL. Local/private/internal targets are rejected.

event_types
enum<string>[]
required
Minimum array length: 1
Available options:
whale_trades_inserted,
live_sports_updated,
whale_trader_synced,
large_positions_updated,
wallet_grade_changed,
insider_radar_flag_raised,
smart_money_flow_detected

Response

Webhook destination

object
string
required
Allowed value: "webhook"
data
object
required
meta
object
required