Alerts and channels

Every alert has a rule and sends to one or more channels. Its filter decides which mentions count, by keyword, platform, relevance, sentiment, intent, language, links, authors and more. Its mode decides how often. instant sends each mention as soon as it is scored. hourly, daily and weekly send one digest per period, at the local time and weekday you choose.

One channel can serve many rules. Alerts and digests cost nothing.

ChannelsCopy Anchor Link

Attention alertsCopy Anchor Link

Any channel can also get attention alerts, without a rule. These are short messages when a keyword spikes, turns negative or gets noisy, or when a channel keeps failing. Turn them on per channel under Alerts, or with events on PATCH /v1/channels/{id}.

EmailCopy Anchor Link

A workspace created in the dashboard starts with a Daily digest rule that emails you at 09:00 your time. To email more addresses, add them in Alerts or in Settings › Integrations › Email. Team members with a verified email are confirmed right away. Anyone else first has to click a confirmation link, which is valid for 24 hours.

After 20 instant emails in an hour, further mentions wait for the channel's daily digest (up to 100). If the channel has no daily digest rule, they only stay in the feed.

What reaches a ruleCopy Anchor Link

• A mention is sent when it passes the filter and its relevance is at least minRelevance (40 by default, and 0 sends everything).
• The look-back of a new keyword goes to the feed and digests, never to instant alerts.
• People muted for the whole workspace never reach any channel.
• If you mark a mention not relevant, done or ignored before it is sent, it isn't sent.
• In Slack and Telegram, a post matched by several keywords or rules arrives as one message per channel.

Mute authorsCopy Anchor Link

A rule's muted list keeps certain people out of that rule, such as your team, a bot or a competitor. Their mentions still appear in the feed and still count toward usage. A profile link or a link to one of their posts mutes that account.

Links that don't name a person, such as a subreddit, a thread or a story, are refused, and the error names the entry. A YouTube @handle link is saved but never matches, because mentions carry the channel link and name, so use one of those. A rule can mute up to 200 authors.

Watch a linkCopy Anchor Link

A rule can react to what a post links to, for example a partner's referral link or a competitor's website. Put up to 20 hosts in filter.linkHosts ("Links to" in the dashboard). ["linear.app"] also matches docs.linear.app, and a full URL or a www. prefix counts as the same host. Posts without links never match. GET /v1/mentions and GET /v1/people accept the same linkHosts filter.

await rumoro.createAlert({
  body: { name: 'Links to our docs', mode: 'instant', filter: { linkHosts: ['docs.example.dev'] }, channelIds: ['dest_...'] },
});

One rule, several casesCopy Anchor Link

To catch, say, "negative posts on Hacker News, or any question", list the cases in filter.anyOf. A mention is sent when the rest of the filter matches and at least one case does (Conventions).

await rumoro.createAlert({
  body: {
    name: 'Needs a reply',
    mode: 'instant',
    filter: { anyOf: [{ platforms: ['hackernews'], sentiments: ['negative'] }, { intents: ['question'] }] },
    channelIds: ['dest_...'],
  },
});

The relevance minimum applies to every case. The dashboard shows the cases on the rule and keeps them when you edit other settings. A rule can also filter by groupIds, author tags, minFollowers, minConfidence, star ratings and notRatings, and engagement minimums.

Daily and weekly digestsCopy Anchor Link

A daily rule sends one digest per channel at the hour and time zone you choose. Mentions count by the time they were scored. A day without a relevant mention (40 or higher) is skipped unless you turn skipEmpty off. A weekly rule works the same way on schedule.weekday (0 is Sunday, 6 is Saturday).

What a digest contains depends on the channel.

• Email, Slack and Telegram show how many mentions came in and how many are relevant, the change against the previous period, the platforms and the keywords. Then come two lists, "Needs you today" and "Also worth a look", with negative mentions and those showing buying intent, questions, bug reports or complaints, most urgent first. Email shows up to 5 and 7, Slack and Telegram up to 5 and 5.
• Webhooks get the JSON described in Digest events.

Run now sends the rule's period (the last hour, day or week) immediately and doesn't change the schedule.

Hourly digestsCopy Anchor Link

An hourly rule sends five minutes past every UTC hour and covers the hour before. An hour with nothing at or above the minimum sends nothing, except with Run now. Hourly rules take no schedule, and a weekday is refused.

Only Slack, Telegram and webhook channels take hourly digests. A rule with an email channel is refused (400 hourly_email_unsupported). A delivery that fails on a rate limit or a 5xx is retried until 45 minutes past the hour after it was due, and then skipped, leaving the mentions in the feed.

Through the APICopy Anchor Link

ChannelsCopy Anchor Link

// List your channels
const { data: channels } = await rumoro.listChannels();

// Create an email channel
await rumoro.createChannel({ body: { kind: 'email', emails: ['support@example.dev'] } });

A Slack channel needs Slack connected first (409 slack_not_connected). Telegram chats are added with POST /v1/telegram/links.

RulesCopy Anchor Link

// Daily at 08:30 in New York
await rumoro.createAlert({
  body: { name: 'Morning summary', mode: 'daily', schedule: { hour: 8, minute: 30, timezone: 'America/New_York' }, channelIds: ['dest_...'] },
});

// Every hour, relevant mentions only
await rumoro.createAlert({ body: { name: 'Hourly pulse', mode: 'hourly', channelIds: ['dest_...'] } });

// Every Friday at 16:00 in Paris, French posts only
await rumoro.createAlert({
  body: {
    name: 'Weekly recap',
    mode: 'weekly',
    schedule: { hour: 16, minute: 0, timezone: 'Europe/Paris', weekday: 5 },
    filter: { languages: ['fr'] },
    channelIds: ['dest_...'],
  },
});

PATCH /v1/alerts/{id} replaces the whole filter, including excludeAuthors. A rule's name is 1 to 80 characters, and a rule can have up to 20 channels.

Mute and unmuteCopy Anchor Link

These change the muted list without rewriting the filter. Both take the same body, are safe to repeat and return the rule.

await rumoro.muteAlertAuthors({
  path: { id: 'feed_...' },
  body: { authors: ['https://x.com/ourcompany', 'u/release-bot', 'name.bsky.social'] },
});

await rumoro.unmuteAlertAuthors({ path: { id: 'feed_...' }, body: { authors: ['name.bsky.social'] } });

Test and runCopy Anchor Link

// Send a test through every channel of the rule
await rumoro.testAlert({ path: { id: 'feed_...' } });

// Send the digest for the current period now
await rumoro.runAlertDigest({ path: { id: 'feed_...' } });