v1

latestOpenAPI 3.1.02026-07-2359362475.0 KB

Smart Alerts

Create a smart alert

Create a smart alert that watches on-chain activity and notifies the configured channels. Choose a type (common-token-transfer, sm-token-flows, or smart-contract-call), an evaluation timeWindow, one or more delivery channels, and the type-specific data filters. If createdBy is omitted it defaults to agent.

post/api/v1/smart-alert

Request body

namestring required

Human-readable name for the alert.

type'common-token-transfer' | 'sm-token-flows' | 'smart-contract-call' required

The kind of activity to watch.

timeWindow'realtime' | '1m' | '5m' | '10m' | '30m' | '1h' | '4h' | '12h' | '1d' | '1w' required

Evaluation window. Use realtime to fire per matching event.

dataobject required

Type-specific filter configuration. The accepted fields depend on type (see the API reference and the worked examples on this endpoint). Common keys include chains, events, inclusion and exclusion.

descriptionstring

Optional longer description of the alert.

isEnabledboolean

Whether the alert is active on creation.

createdBystring

Origin of the alert. Defaults to agent when omitted.

Response

Successful Response

{"stackTrail":"paths:/api/v1/smart-alert:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}