Create alert configuration

POST https://api.unusualwhales.com/api/alerts/configuration

Request

Security: Bearer Auth Authorization: Bearer <token>

Responses

200 400 404 500

Response Body 200 OK

config The configuration of an alert.

An alert configuration, there is no fixed schema for this as each alert will have a different configuration.

Example: {"config":{"option_symbols":["TGT241122C00177500"],"symbols":"all"}}

created_at The creation timestamp

Example: 2024-11-19T18:19:14Z

dsl string

The canonical DSL representation when the configuration was created or updated using `input`.

id The alert id

Example: ebe24953-a0bf-4b4d-98be-14f721a1199a

name The name of the alert

Example: Chain OI Chg: TGT241122C00177500

noti_type The type of the alert

Example: chain_oi_change

status The status of the alert

Example: active

Try It POST

API Token

Request Sample

curl -X POST "https://api.unusualwhales.com/api/alerts/configuration" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

import http.client

conn = http.client.HTTPSConnection("api.unusualwhales.com")
headers = {"Authorization": "Bearer YOUR_API_KEY", "Accept": "application/json"}
conn.request("POST", "/api/alerts/configuration", headers=headers)
response = conn.getresponse()
print(response.read().decode("utf-8"))

Response Example 200

{
  "data": {
    "config": {
      "expression": {
        "op": "and",
        "terms": [
          {
            "sectors": [
              "Energy"
            ]
          },
          {
            "op": "and",
            "terms": [
              {
                "is_call": true
              },
              {
                "compare": {
                  "lhs": {
                    "field": "volume"
                  },
                  "op": "gt",
                  "rhs": {
                    "literal": "100"
                  }
                }
              }
            ]
          }
        ]
      },
      "symbols": "all"
    },
    "created_at": "2025-07-01T14:00:00Z",
    "dsl": "@Energy where calls and volume > 100",
    "id": "ebe24953-a0bf-4b4d-98be-14f721a1199a",
    "name": "Energy call sweeps",
    "noti_type": "flow_alerts",
    "status": "active"
  }
}