Create Alert

Create an alert that periodically polls an endpoint and delivers new results to your configured receivers (webhook, email, and/or telegram).

Request body

namestring nullable

Unique label; auto-generated if omitted

Endpoint the alert polls.

argumentsobject required

Endpoint arguments, dont provide system timestamps.

interval_minutesinteger required

Poll interval; multiple of 5.

lookback_minutesinteger nullable

Defaults to interval_minutes

thresholdinteger

Items required to fire.

Example request

{
  "name": "apple_wire_sentiment",
  "path": "/v0/search/list_wire",
  "arguments": {
    "entities": [
      "Apple Inc."
    ],
    "max_entity_sentiment": -0.3,
    "min_entity_sentiment": 0.3,
    "novelty": [
      "new",
      "update",
      "correction"
    ]
  },
  "interval_minutes": 15
}

Response

Successful Response

alert_idinteger required

Unique identifier for the alert.

namestring required

Human label for the alert.

status'active' | 'paused' required

Current status of the alert.

The endpoint the alert polls.

argumentsobject required

The endpoint arguments.

interval_minutesinteger required

How often the alert checks the endpoint, in minutes.

lookback_minutesinteger required

Rolling lookback window, in minutes.

thresholdinteger required

Minimum item count before the alert fires.

last_triggered_end_timestampstring date-time nullable required

end_timestamp of the last successful delivery, or null.

created_atstring date-time required

When the alert was created.

Create Alert

Request

Request body

Example request

Response

Changes