API reference
Webhook events.
What a json endpoint receives, and every event type it can receive. How deliveries are signed, retried and checked: the Webhooks guide.
The body
-
The event; pass it as after (GET /v1/events) or resume (the stream) to continue from it.
-
What happened; webhook.ping is a test.
One of
order.createdorder.editedorder.filledorder.canceledorder.rejectedorder.expiredfill.createdposition.openedposition.changedposition.closedstrategy.createdstrategy.leg_placedstrategy.leg_modifiedstrategy.leg_filledstrategy.leg_canceledstrategy.leg_rejectedstrategy.orphan_repairedstrategy.slicestrategy.triggeredstrategy.endedtradingview.alert_executedtradingview.alert_refusedaccount.updatedaccount.passedaccount.failedaccount.payout_eligibleaccount.disabledaccount.removedkey.loss_stopkey.expiringsystem.restartedrisk.warningrisk.clearedalert.triggeredwebhook.ping -
account_idstringThe account number (none on webhook.ping).
-
When it happened.
-
Where it came from: an order placed through this API or by an AI assistant (the MCP server), one placed on a trading platform, the engine itself (positions), a strategy of this API, or a TradingView alert.
One of
apimcpplatformenginestrategytradingview -
order or fill (the objects REST answers), with changes or close_reason when they apply. A position.* event carries position { market, side, size, average_price } as the engine reported it, and previous_size: read GET .../positions/{market} for its margin, P&L and liquidation.
-
The API version the endpoint receives.
-
The environment of the endpoint and the account.
One of
livesandbox -
testbooleanA test (webhook.ping) or a delivery resent as one.
Every event type
| Type | Group | What it means |
|---|---|---|
order.created | orders | An order rests on the engine (or a market order was taken). |
order.edited | orders | An order changed in place (size or price). |
order.filled | orders | An order filled. |
order.canceled | orders | An order was canceled; cancel_reason says why. |
order.rejected | orders | The engine refused an order; reject.code says why. |
order.expired | orders | An order ended by its time in force (gtd, ioc, fok). |
fill.created | orders | An execution, with its price and fee. |
strategy.created | orders | A strategy started. |
strategy.leg_placed | orders | A strategy placed an order. |
strategy.leg_modified | orders | A strategy moved one of its orders (a trailing stop, break-even, a chase). |
strategy.leg_filled | orders | An order of a strategy filled. |
strategy.leg_canceled | orders | An order of a strategy was canceled. |
strategy.leg_rejected | orders | The engine refused an order of a strategy. |
strategy.orphan_repaired | orders | An exit filled past flat and the position it opened was closed at once. |
strategy.slice | orders | A TWAP or VWAP slice was sent, carried or refused. |
strategy.triggered | orders | A conditional order's price was reached: its order was sent. |
strategy.ended | orders | A strategy ended; end_reason says why. |
tradingview.alert_executed | orders | A TradingView alert placed its orders. |
tradingview.alert_refused | orders | A TradingView alert was refused; reason says why. |
position.opened | positions | A position opened (or turned to the other side). |
position.changed | positions | A position's size or entry price changed. |
position.closed | positions | A position closed. |
account.updated | account | An account's balance or status changed. |
account.passed | account | An evaluation account passed. |
account.failed | account | An account breached a rule. |
account.payout_eligible | account | A funded account can request a payout. |
account.disabled | account | An account was disabled. |
account.removed | account | An account was removed. |
key.loss_stop | account | A key reached its daily loss stop: its trading on the account is paused until the next day. |
key.expiring | account | A key expires soon (api.keys.expiry_notice_days before its end), told on each account it reaches. |
system.restarted | account | The trading engine restarted: its orders and positions were reset (one event per account the API was following). |
risk.warning | risk | An account came near a limit. |
risk.cleared | risk | An account moved back from a limit. |
alert.triggered | alerts | A price alert fired: the market's price reached its level. |
webhook.ping | Every endpoint | A test sent from your dashboard or the API. |