Skip to content

docs(e4836e49-db30-4bab-9359-9a91a3e2826a): document trigger failure alarms - #822

Closed
claude[bot] wants to merge 1 commit into
mainfrom
TSP-1451/docs-update
Closed

claude[bot] wants to merge 1 commit into
mainfrom
TSP-1451/docs-update

Conversation

@claude

@claude claude Bot commented Sep 15, 2026

Copy link
Copy Markdown

Summary

  • Added Trigger failure as a new alert type on the Alerts page: card in the Alert types CardGroup, plus a full #### Trigger failure section documenting per-user scope, one-alarm-per-trigger-per-user, and watermark behavior
  • Added a brief <Note> callout in the "Managing your triggers" section of the Triggers page cross-referencing the alerts page

Rollout status

Backend fully available (100% rollout). UI gated to Databricks, Autodesk, and cohort 27933 via trigger-inventory-page-fe flag. Source: PR #17883.

Gotchas

  • UI is in limited release but the backend is fully available, so the feature is documented as generally available
  • Per-user scope — trigger failure alarms differ from agent-level alerts: each team member subscribes independently, so enabling/disabling has no effect on others
  • Watermark behavior — the alarm watermark is set to the current time on creation or re-enable, so only future failures trigger notifications; past failures are not reported

Linear issue

https://linear.app/relevance/issue/e4836e49-db30-4bab-9359-9a91a3e2826a/

@claude claude Bot added the docs-drafter Documentation drafted by Claude label Sep 15, 2026
@mintlify

mintlify Bot commented Sep 15, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
relevanceai 🟢 Ready View Preview Oct 8, 2026, 2:19 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@linear

linear Bot commented Sep 15, 2026

Copy link
Copy Markdown

TSP-1451

@github-actions

Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 2 files (2 with issues, 0 clean)

Scores

Dimension Score What's holding it back
🟡 Consistency 6/10 alerts.mdx uses lowercase agent and tool almost everywhere — both should be Agent and Tool as Relevance AI product features. Secondary issue: the page mixes "alarms" and "alerts" for the same trigger failure feature. triggers.mdx drops to lowercase agent in its bullet list (inconsistent with the rest of the file).
🟢 Technical clarity 9/10 Well-specified UI references throughout. The watermark timing behaviour (only failures after alarm activation are reported) is exactly the kind of non-obvious gotcha worth documenting. Minor gap: triggers.mdx has no description frontmatter, so the page has no search/nav preview text.
🟢 Non-technical clarity 9/10 Both pages lead with plain English before instructions begin. triggers.mdx uses a concrete Gmail example early, which grounds the concept well. No jargon dumps.
🟡 Structure 7/10 Several sequential procedures use plain numbered lists where <Steps> would add visual progress; the "When to use escalation" <CardGroup> in alerts.mdx contains non-navigable items that would read more cleanly as a bullet list.

Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5.

✨ Overall vibe: Solid, useful content — the substance is good and both pages cover their topics clearly. The main thing holding alerts.mdx back is a systematic capitalization pattern where Agent and Tool appear in lowercase throughout; a single find-and-replace pass would close most of the gap. triggers.mdx is close to clean with a few structural tweaks.

🔧 Issues (6)
  • build/agents/build-your-agent/alerts.mdx:7,15,21,30,36,60,82,96,98,102,104,110 — agent and agent's appear in lowercase throughout the entire file. Per the capitalization rules, these all refer to the Relevance AI Agent product feature and should be Agent. This is a file-wide pattern; a global replace is the right fix.

  • build/agents/build-your-agent/alerts.mdx:48 — tools in "leave the selection empty to watch all tools, or pick individual tools to monitor" refers to Relevance AI Tools → Tools.

  • build/agents/build-your-agent/alerts.mdx:96,102,104 — tool in "using the built-in Escalate to Manager tool", "adds the ... tool to your agent's available tools", and "reference the tool in your agent's prompt" all refer to a specific Relevance AI Tool → capitalize as Tool.

  • build/agents/build-your-agent/alerts.mdx:50–56 — The section heading is "Trigger failure" (an alert type), but the body switches to "alarms" three times ("one alarm per trigger per user", "trigger failure alarms", "alarm bell icon", "the alarm was active"). The UI may use an alarm bell icon, but calling the feature "alarms" on this page while the rest of the doc (and the cross-link in triggers.mdx) uses "alerts" is confusing. Either note that the UI element is called an alarm bell but the feature is called a trigger failure alert, or pick one term and stick to it.

  • build/agents/build-your-agent/triggers.mdx:14–15 — The bullet list items use lowercase agent ("Set your agent to run…", "Configure your agent to respond…", "Allow users to directly engage with the agent") while the rest of the file correctly uses Agent. Three instances; should match the file-wide convention.

  • build/agents/build-your-agent/triggers.mdx:1–4 — No description field in the frontmatter. Every other page in this directory has one. Without it the page gets no preview text in search results or the sidebar tooltip.

🧩 Component suggestions (3)
  • build/agents/build-your-agent/alerts.mdx:82–88 — The "Setting up an alert rule" section uses a plain numbered list for a 7-step sequential procedure. This is exactly what <Steps> is for — it adds visual progress indicators and makes multi-step procedures scannable. Wrap lines 82–88 in <Steps>.

  • build/agents/build-your-agent/alerts.mdx:108–121 — The "When to use escalation" <CardGroup cols={2}> has 4 cards with no href attributes. Per the component guidelines, <CardGroup> is intended for navigable items or equal parallel choices — non-linked cards with short descriptions are better expressed as a bullet list. Since these are brief use-case examples, a plain <ul> or a 2-column <CardGroup> with links to relevant pages (e.g. the prompt editor) would work better than decorative non-linked cards.

  • build/agents/build-your-agent/triggers.mdx:40–46 — "To pause or resume a single trigger" uses a plain numbered list for a 4-step procedure. Wrap in <Steps> to match the recommended pattern for sequential UI instructions.

🏗️ Page structure (1)
  • build/agents/build-your-agent/alerts.mdx — The frontmatter description ("Set up rules to get notified when your agent encounters an issue, reaches a threshold, or gets updated.") only covers the alert rules half of the page. The page also covers agent escalations, which is a distinct, fairly substantial section. Either update the description to cover both topics, or consider whether escalations warrants its own page. If it stays on the same page, the description should reflect it: e.g. "Set up alert rules for agent issues and configure the Escalate to Manager Tool for in-conversation human handoffs."
⚠️ Contradictions (1)
  • build/agents/build-your-agent/triggers.mdx:34 says "You can set up failure alerts for individual triggers" — build/agents/build-your-agent/alerts.mdx:52–54 describes the same feature using "alarms" ("trigger failure alarms", "one alarm per trigger per user"). Same feature, two different nouns across two pages that explicitly cross-link to each other. Align on one term — "alerts" is consistent with the page title and the rest of the Alerts page.
🔋 Credit usage
Item Count
Files reviewed 2
Context pages read 2
Total lines processed ~309

Files read: build/agents/build-your-agent/alerts.mdx (122 lines), build/agents/build-your-agent/triggers.mdx (126 lines), build/agents/build-your-agent/build-overview.mdx (26 lines), build/agents/build-your-agent/agent-triggers/scheduled-triggers.mdx (159 lines)

@jordanc-relevanceai jordanc-relevanceai added drafter:go When you review an AI generated PR, add this label to have the AI action your review. and removed drafter:go When you review an AI generated PR, add this label to have the AI action your review. labels Oct 8, 2026
…alarms

Add Trigger failure as a new alert type on the alerts page, covering
per-user subscription scope, one alarm per trigger per user, and
watermark behavior (only future failures fire notifications). Add a
cross-reference callout on the triggers page pointing to the alerts page.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@vercel

vercel Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
relevance-docs Ready Ready Preview Oct 8, 2026 2:20am UTC

Request Review

@jordanc-relevanceai

Copy link
Copy Markdown
Collaborator

add beta badge to the docs so that its known it may not be available everywhere.

@jordanc-relevanceai jordanc-relevanceai added the drafter:go When you review an AI generated PR, add this label to have the AI action your review. label Oct 8, 2026
@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 2 files (2 with issues, 0 clean)

Scores

Dimension Score What's holding it back
🟡 Consistency 7/10 alerts.mdx uses "alarms" 4× in the Trigger failure section while the rest of the page and triggers.mdx say "alerts". triggers.mdx capitalizes "Agent" in the intro then drops to "agent" in the bullet list immediately below.
🟡 Technical clarity 7/10 "Triggers monitoring page" in alerts.mdx:54 is undefined — no path, no link, no explanation of how it differs from the Alerts tab. Also, alerts.mdx:84 says "Select a trigger type" when it means "Select an alert type", which is confusing on a page where Trigger is also a product concept. triggers.mdx is missing a frontmatter description.
🟢 Non-technical clarity 8/10 Both pages are written in plain English. The three-methods overview in triggers.mdx is a solid entry point for non-technical readers. Minor: "Manual Activation" in the intro list doesn't feel like a trigger in the same sense as the others and could confuse readers about what Triggers actually do.
🟡 Structure 7/10 Both pages use plain numbered lists for setup procedures (<Steps> would give visual progress). triggers.mdx FAQ item 3 restates the pausing section almost verbatim. alerts.mdx opening paragraph is a word-for-word copy of the frontmatter description.

Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5.

✨ Overall vibe: Solid content additions — the trigger pausing feature and alert types are well-documented with useful detail (the watermark behavior for trigger failure alarms is a good gotcha to call out). The main thing to fix before shipping is the "alarms" vs "alerts" terminology split, which is confusing enough to send readers in circles, and the undefined "Triggers monitoring page" navigation path.

🔧 Issues (5)
  • alerts.mdx:52-56 — "alarms" used four times in the Trigger failure section (their own **alarms** independently, disabling an **alarm**, one **alarm** per trigger, trigger failure **alarms** from the Triggers monitoring page, re-enable an **alarm**). The page header, all other alert types, and triggers.mdx:38 all say "alerts". Standardize on "alerts" unless the product UI explicitly labels this feature "alarms" — and if it does, add a brief parenthetical the first time.

  • alerts.mdx:54 — "Set up trigger failure alarms from the Triggers monitoring page" — "Triggers monitoring page" is not defined, linked, or mentioned anywhere else in this file or in triggers.mdx. Readers who followed the general setup steps (Alerts tab → Create alert rule) won't know where this is. Either clarify the navigation path (e.g., "Go to your agent's Triggers section") or link to it.

  • alerts.mdx:84 — "Select a trigger type from the left panel" → should be "Select an alert type" (or "Select the type of event to alert on"). On a page that also discusses the Trigger product, "trigger type" makes readers think of Gmail/Slack/webhook triggers rather than alert categories.

  • triggers.mdx:12-13 — "Set your agent to run at specific times" and "Configure your agent to respond" — lowercase "agent" in both bullet items while the three paragraphs directly above consistently use "Agent". These refer to the Relevance AI product, so capitalize: "Set your Agent to run…" and "Configure your Agent to respond…".

  • triggers.mdx:3 — Missing description in frontmatter. Every sibling page in this directory has one (alerts.mdx has 'Set up rules to get notified…', build-overview.mdx has 'Get started by building your first Agent!'). Add a one-line description for SEO and the Mintlify page card.

🧩 Component suggestions (3)
  • alerts.mdx:82-88 — 7-step "Setting up an alert rule" procedure uses a plain numbered list. This is a sequential user procedure — wrap it in <Steps> for visual progress indicators. Same content, just swap the list format.

  • triggers.mdx:22-27 — 6-step "Setting up a trigger" procedure uses a plain numbered list. Same suggestion: wrap in <Steps>.

  • triggers.mdx:18-20 — <Info> callout points beginners to Relevance AI Academy. This isn't factual information — it's a suggestion. Use <Tip> instead, which matches the intent ("here's a helpful resource if you're new").

🏗️ Page structure (2)
  • triggers.mdx:122-128 — The third FAQ answer ("Can I pause or disable a Trigger without deleting it?") runs 4 sentences and restates the "Pausing and resuming triggers" section almost verbatim, including the Pause all button and visual status indicators. Trim the FAQ answer to 1–2 sentences and reference the section: e.g., "Yes — see Pausing and resuming triggers for the full details."

  • alerts.mdx:7 — Opening paragraph is a word-for-word copy of the frontmatter description field. Either drop the paragraph and let the description render as a lede, or rewrite the paragraph to add information the description doesn't cover.

⚠️ Contradictions (1)
  • alerts.mdx:52-56 calls trigger failure subscriptions "alarms" throughout; triggers.mdx:38 calls the same feature "failure alerts" ("You can set up failure alerts for individual triggers"). Both files are in this PR — align them on the same term before merging.
🔋 Credit usage
Item Count
Files reviewed 2
Context pages read 2
Total lines processed ~316

Files read: alerts.mdx (122 lines), triggers.mdx (130 lines), agent-triggers/integrations.mdx (38 lines), build-overview.mdx (26 lines)

@jordanc-relevanceai jordanc-relevanceai removed the drafter:go When you review an AI generated PR, add this label to have the AI action your review. label Oct 9, 2026

This branch was successfully deployed

2 active deployments
Preview — cb7b4824 Deployed Oct 8, 2026 by vercel[bot]
staging — cb7b4824 Deployed Oct 8, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-drafter Documentation drafted by Claude

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant