Alerts

Create an alert

A rule (what to watch, the filter) times channels. mode instant sends each matching mention as it happens; hourly sends one digest every UTC hour (five minutes past) for the previous full hour, nothing when it had no mention over the rule's floor, to Slack, Telegram and webhook channels only (no schedule); daily sends one digest at schedule.hour in schedule.timezone; weekly sends one a week on schedule.weekday (0 Sunday to 6 Saturday). filter.anyOf adds OR: groups of conditions in the vocabulary of the mentions list, at least one of which must hold on top of the rest of the filter.

post/v1/alerts

Request

  • Base URL: https://api.mentio.dev
  • URL: https://api.mentio.dev/v1/alerts
  • Auth: HTTP bearer

Request body

namestring required
enabledboolean
mode'instant' | 'hourly' | 'daily' | 'weekly'
eventstring nullable

Custom event name for webhook payloads; null for the mode default.

channelIdsstring[]

Channel ids from GET /v1/channels.

Response

The created rule

idstring required

Alert id (feed_...).

namestring required
enabledboolean required
mode'instant' | 'hourly' | 'daily' | 'weekly' required

instant: each matching mention as it happens. hourly: one digest each UTC hour (five minutes past, so the last mentions of the hour are scored) covering the previous full hour, nothing when that hour has no mention at or over the rule's relevance floor; Slack, Telegram and webhook channels only. daily: one digest at the scheduled local time. weekly: one digest a week, on schedule.weekday.

eventstring required

Event name carried in webhook payloads; the mode default unless you set one.

createdAtstring required

ISO 8601 timestamp, UTC.

Changes

No recorded changes to this operation across all 1 revision of this API.