Create an alert
POST /api/v1/alerts
Email, Slack or Discord. Each workspace can send 30 alert emails and 200 Slack or Discord messages a day (self-hosted installs set the email cap with SCOUT_ALERT_EMAILS_PER_DAY).
A full-access key (ss_sk_…), or an editor or owner signed in.
Request body
JSON, sent with Content-Type: application/json.
| Name | Type | Description |
|---|---|---|
kind required |
string | digest: one message a day at `hour`. rule: a message the moment a matching mention arrives. One of: digest rule |
name required |
string 1–80 characters |
Shown in the app and in each message. |
enabled |
boolean | |
project_id |
string or null | The project to watch; null for every project. |
channel required |
string | One of: email slack discord |
target required |
string up to 500 characters |
email: an address. slack: a channel ID or #name. discord: a webhook URL (https://discord.com/api/webhooks/…). |
hour |
integer or null 0–23 |
Digest: the local hour to send, 0–23. |
timezone |
string or null | IANA timezone for `hour`, e.g. America/New_York. Defaults to the workspace's. |
filters |
object | Only mentions matching every filter set here. Leave a filter out to match everything. |
filters.sources |
array of string | Only these sources. One of: reddit linkedin x hn instagram github stackoverflow devto bluesky news youtube tiktok threads |
filters.sentiment |
array of string | Only these sentiments. One of: positive negative neutral |
filters.categories |
array of integer | Only these category ids. |
filters.groups |
array of integer | Only these keyword group ids. |
filters.keywords |
array of integer | Only these keyword ids. |
filters.authors |
array of string up to 50 items |
Only these authors: exact handles, any case, e.g. @someone or u/someone. |
filters.min_engagement |
integer at least 0 |
Only posts with at least this much engagement. |
min_urgency |
integer or null 0–100 |
Only mentions at or above this urgency (0–100). |
Returns
Alert
Example
curl -X POST "https://sniffington.com/api/v1/alerts" \
-H "Authorization: Bearer $SCOUT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"kind":"digest","name":"Acme","channel":"email","target":"…"}'