Skip to main content
GET
cURL
List every webhook event type with its payload shape and producer status. Use this endpoint before you create or update a subscription.

Read the catalog

  • id is the value you list in event_types.
  • payload_shape describes the data object of each delivery.
  • status is active or dormant. A dormant type accepts a subscription but sends no delivery yet.
  • live_sports_updated is the one dormant type. The other six are active.
  • whale_trades_inserted, wallet_grade_changed, insider_radar_flag_raised, and smart_money_flow_detected deliver only to a key on an active Pro subscription.
  • The catalog is the same for every key. It holds no account data.
Create Webhook takes one or more of these id values in event_types.

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.

Response

Webhook event catalog

object
string
required
Allowed value: "list"
data
object[]
required
has_more
boolean
required
meta
object
required
next_cursor
string | null
total
integer | null