Skip to main content
POST
Webhooks
Receive push notifications instead of polling the Whale tracking feed or Arbitrage scanner. Each customer may register one webhook per type: whale and arbitrage. All routes require an API key — see Authentication.

Plan requirements

Registering or updating below the required plan returns 403 with an entitlement message naming the plan you need.

Endpoint reference

Request

Body

string
required
Public http or https callback URL. Private, loopback, and link-local hosts are rejected at registration time.

Response

Registration responses wrap data in the standard envelope (success, data, message). The data object includes:
string
whale or arbitrage.
string
Your registered callback URL.
string
Shared signing secret — store it to verify deliveries. Returned on every GET / POST / PUT, not only at creation.
boolean
Whether deliveries are active.

What triggers a delivery

Delivery is best-effort: slow or failing endpoints are logged and skipped — there is no automatic retry queue.

Delivery payload

type is whale.entry or arbitrage.opportunity. The data object follows the field names used in Whales and Cross-venue arbitrage.

Verifying deliveries

Every delivery includes: Recompute the HMAC with your stored secret over the exact signed string before trusting the payload.

Examples

Register and manage

Example registration response