Webhooks - Subscriptions

Update a webhook subscription

Edit a rule in place. A configuration you send replaces the stored one and is validated exactly as it was at create; enabled switches the rule on or off without touching its configuration. A field you leave out is left alone. Authenticate with an API key or a signed-in dashboard session. Costs no credits.

patch/v1/webhooks/subscriptions/{id}

Request

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

Path parameters

idstring uuid required
Example:3c1f0a52-8d6b-4f0e-9b1a-6f2c4d8e9a10

Subscription identifier.

Request body

enabledboolean

Your own on and off switch for the rule.

Example request

{
  "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
}

Response

The updated 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.