Webhooks - Catalog and Limits

List webhook event types

Return the served event catalog: one declaration per event type, carrying its scope, covered venues, accepted filters, tunable parameters, the metrics conditions may be written against, the operator vocabulary for each metric type, and the smallest occurrence the type reports. Subscriptions are validated against these declarations, so this is the authority on what a configuration may contain. Types marked live: false are published but do not yet accept subscriptions. Authenticate with an API key or a signed-in dashboard session. Costs no credits.

get/v1/webhooks/event-types

Request

  • Base URL: https://api.0xarchive.io
  • URL: https://api.0xarchive.io/v1/webhooks/event-types
  • Auth: API key in header X-API-Key

Response

The served webhook event catalog

successboolean

Example response

{
  "success": true,
  "data": [
    {
      "type": "market.liquidation",
      "schema_version": 1,
      "live": true,
      "scope": "public",
      "venues": [
        "hyperliquid",
        "hip3",
        "lighter"
      ],
      "filters": [
        "venue",
        "symbols"
      ],
      "cost_floor": {
        "metric": "notional_usd",
        "min": 100
      },
      "latency_class": "seconds",
      "description": "A liquidation on a covered venue."
    }
  ]
}

Changes

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