AIXBT Docs
API v3Reference

Create an alert subscription

POST
/v3/alerts

Creates an owner-scoped subscription: selector + one trigger + delivery cadence + explicit destination ids. Destinations are provisioned in product Settings and referenced here by id. Chat cadence defaults to hourly; instant is subject to a per-day platform safety ceiling. Webhook destinations receive every admitted event regardless of cadence. The 50-subscription owner cap and selector list bounds (20 values per list) are enforced. An account holds at most one rank.entered subscription; creating a second while one exists fails with invalid_request.

Authorization

ApiKeyAuth
x-api-key<token>

API key. The Authorization header is accepted as an equivalent carrier. Responses echo the credential class in X-API-Key-Type.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v3/alerts" \  -H "Content-Type: application/json" \  -d '{    "trigger": "intelligence.material",    "selector": {      "followedProjects": true,      "qualifiers": {        "grades": [          "polished",          "flawless"        ]      }    },    "cadence": "hourly",    "destinationIds": [      "66a10a2b1c9d440000aa0001"    ]  }'
{
  "data": {
    "id": "66a10a2b1c9d440000d1e2f4",
    "status": "active",
    "trigger": "rank.entered",
    "rankThreshold": 10,
    "selector": {
      "qualifiers": {
        "categories": [
          "modular-blockchains"
        ]
      }
    },
    "cadence": "instant",
    "destinationIds": [
      "66a10a2b1c9d440000aa0002"
    ],
    "createdAt": "2026-08-05T05:00:00Z",
    "updatedAt": "2026-08-05T05:00:00Z"
  },
  "meta": {}
}
{
  "code": "invalid_request",
  "message": "minTrend must be numeric",
  "details": {
    "fields": [
      "minTrend"
    ]
  }
}

{
  "code": "credential_required",
  "message": "Provide an API key via the x-api-key header."
}

{
  "code": "entitlement_required",
  "message": "This resource requires the topic-reports entitlement.",
  "details": {
    "entitlement": "topic-reports"
  }
}

{
  "code": "rate_limited",
  "message": "Minute limit reached.",
  "details": {
    "limit": 30,
    "window": "minute"
  }
}
{
  "code": "internal_error",
  "message": "Unexpected error."
}

List my alert subscriptions GET

Alert subscriptions owned by the calling credential. One owner may hold at most 50 subscriptions, paused rows included. Lists the API-manageable kinds (`intelligence.material`, `rank.entered`); preset subscriptions managed in product Settings do not appear here.

Delete an alert subscription DELETE

Removes the subscription; delivery history retention is unaffected.