Webhooks

Subscribe to market state-change webhooks

Register a webhook URL to receive signed receipts when a market transitions between states (OPEN↔CLOSED, HALT). Builder+ plans only. Sandbox keys are rejected. Returns webhook_id and subscription_id.

post/v5/webhooks/subscribe

Request

  • Base URL: https://headlessoracle.com
  • URL: https://headlessoracle.com/v5/webhooks/subscribe
  • Auth: API key in header X-Oracle-Key

Request body

urlstring uri required

HTTPS endpoint to receive webhook deliveries.

micsstring[] required

MIC codes to subscribe to (e.g. ["XNYS","XNAS"]).

eventsstring[]

Event types to subscribe to. Default: ["status_change"].

Response

Subscription created

webhook_idstring

Unique ID for this webhook. Use for DELETE /v5/webhooks/{webhook_id}.

subscription_idstring

Legacy alias for webhook_id (backward compat).

urlstring
micsstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.