POST · alerts:write

Create alert

Create an email alert rule targeting keyword groups, individual keywords, or one exact mentioning account, while enforcing the workspace alert cap and owner-only recipient policy. No separate email verification is required. Digests and custom alerts share a daily limit of 3 emails for trial workspaces and 30 for paid workspaces, resetting at midnight UTC.

External side effects

REST

POST/api/v1/alerts

curl "https://www.stalkr.ai/api/v1/alerts" \
  --request POST \
  --header "Authorization: Bearer $STALKR_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: unique-operation-key"

MCP

Tool name: create_alert

The MCP tool accepts the same input schema and returns the same structured { data, meta } result as REST.

Input

projectIdrequired

string | null

namerequired

string

typerequired

string

activerequired

boolean

channelsrequired

array

Exactly one email channel; Stalkr delivers alerts only to the workspace owner

digest

object

filters

object

idempotencyKey

string

Unique key used to safely retry this write operation

Safe retries

Pass idempotencyKey to the MCP tool or Idempotency-Key to REST when retrying this write.

Authorization

Required scope: alerts:write.

Scope authorization is followed by resource authorization. Project operations check current membership and the minimum role required by the underlying workflow.

Related resources

REST conventions · MCP setup · Errors and limits