Webhooks - Subscriptions

Create a webhook subscription

Subscribe an endpoint to an event type. The configuration is checked against the event type's catalog declaration before anything is stored, so an unknown key, an undeclared parameter, an out of range value or a condition on a metric the event does not carry is refused rather than quietly dropped. The endpoint must be one of yours. Addresses used in the configuration must already be on your watched list. A plan without webhook delivery, or one already at its subscription cap, is refused with the reason and the way forward. Authenticate with an API key or a signed-in dashboard session. Costs no credits.

post/v1/webhooks/subscriptions

Request

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

Request body

endpoint_idstring uuid required

Endpoint that will receive this rule's deliveries.

event_typestring required

Event type to subscribe to, from the catalog.

Example request

{
  "event_type": "market.liquidation",
  "filters": {
    "symbols": [
      "BTC",
      "ETH"
    ],
    "addresses": [
      "0x6b9e773128f453f5c2c60935ee2de2cbc5390a24"
    ],
    "params": {
      "max_age_s": 3600
    },
    "conditions": [
      {
        "metric": "notional_usd",
        "op": "greater_than_or_equal",
        "value": 100000
      }
    ],
    "min_notional_usd": 100000
  }
}

Response

The new subscription

successboolean

Example response

{
  "success": true,
  "data": {
    "event_type": "market.liquidation",
    "filters": {
      "symbols": [
        "BTC",
        "ETH"
      ],
      "addresses": [
        "0x6b9e773128f453f5c2c60935ee2de2cbc5390a24"
      ],
      "params": {
        "max_age_s": 3600
      },
      "conditions": [
        {
          "metric": "notional_usd",
          "op": "greater_than_or_equal",
          "value": 100000
        }
      ],
      "min_notional_usd": 100000
    },
    "enabled": true,
    "status": "active",
    "pause_message": "This rule was paused because the account reached its Pro plan limit of 50000 webhook deliveries in a day. The daily allowance resets at 2026-09-21 00:00 UTC, and a paused rule does not restart with it. Resume it with POST /v1/webhooks/subscriptions/resume.",
    "pause_reason": "deliveries_per_day_cap"
  }
}

Changes

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