Alerts

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.

post/v1/alerts

Request

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

Request body

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

Custom webhook event name. Null keeps the mode's default.

channelIdsstring[]

Where to send, as ids from GET /v1/channels.

Response

The new alert

idstring required

The alert's id (feed_...).

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

instant sends each matching mention as it arrives. hourly sends a digest of the previous full UTC hour at five past the hour, so the hour's last mentions are scored. It skips hours with no mention at or above the rule's relevance minimum, and works with Slack, Telegram and webhook channels only. daily sends one digest at the scheduled local time. weekly sends one digest a week on schedule.weekday.

eventstring required

The event name sent in webhook payloads. Unless you set one, it is the default for the mode.

createdAtstring required

UTC time in ISO 8601.

Changes

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