Create an alert
Creates an alert, which pairs a filter with one or more channels. instant mode sends each matching mention as it arrives. hourly sends a digest of the previous full UTC hour at five past, skips hours with no mention above the rule's minimum, takes no schedule and works with Slack, Telegram and webhook channels only. daily sends one digest at schedule.hour in schedule.timezone. weekly sends one a week on schedule.weekday, from 0 for Sunday to 6 for Saturday. filter.anyOf adds OR logic with groups of mention-list conditions. At least one group must match, as well as the rest of the filter.
Authorization
bearerAuth An API key from POST /v1/api-keys. Keys start with ref_.
In: header
Request Body
application/json
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/alerts" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{ "id": "string", "name": "string", "enabled": true, "mode": "instant", "filter": { "keywordIds": [ "string" ], "groupIds": [ "string" ], "platforms": [ "bluesky" ], "minRelevance": 0, "minConfidence": 0, "sentiments": [ "positive" ], "intents": [ "string" ], "excludeAuthors": [ "string" ], "minFollowers": 0, "tags": [ "string" ], "linkHosts": [ "string" ], "languages": [ "string" ], "automated": true, "ratings": [ 1 ], "notRatings": [ 1 ], "minLikes": 0, "minReposts": 0, "minReplies": 0, "minQuotes": 0, "minViews": 0, "minBookmarks": 0, "anyOf": [ { "q": "string", "keywordIds": [ "string" ], "notKeywordIds": [ "string" ], "keywordKinds": [ "brand" ], "groupIds": [ "string" ], "notGroupIds": [ "string" ], "platforms": [ "bluesky" ], "notPlatforms": [ "bluesky" ], "status": "open", "relevant": true, "minRelevance": 0, "minConfidence": 0, "sentiments": [ "positive" ], "notSentiments": [ "positive" ], "intents": [ "string" ], "notIntents": [ "string" ], "automated": true, "languages": [ "string" ], "notLanguages": [ "string" ], "tags": [ "string" ], "notTags": [ "string" ], "linkHosts": [ "string" ], "notLinkHosts": [ "string" ], "minFollowers": 0, "maxFollowers": 0, "isReply": true, "excludeAuthors": [ "string" ], "ratings": [ 1 ], "notRatings": [ 1 ], "minLikes": 0, "minReposts": 0, "minReplies": 0, "minQuotes": 0, "minViews": 0, "minBookmarks": 0 } ] }, "schedule": { "hour": 0, "minute": 0, "timezone": "string", "skipEmpty": true, "weekday": 0 }, "event": "string", "channels": [ { "id": "string", "kind": "slack", "label": "string" } ], "stats": { "sentLast7d": 0, "lastSentAt": "string", "nextRunAt": "string" }, "createdAt": "string"}Get Health
Checks that the API is up. Needs no key and is not rate limited. Returns `ok: true` with the state of the database and each background worker.
Create a channel
Creates a webhook (the default), email or Slack channel. Slack needs a connected workspace, otherwise 409. Telegram chats are connected in the dashboard. A webhook's signing secret appears only in this response.