Skip to main content
An alert (monitor) reacts to a trigger by opening an issue and/or notifying Slack channels and webhooks. Pick one of three trigger types with trigger.type; the type is immutable once created (a change is delete-and-recreate). name is the slug config identity. displayName (optional) is the alert’s name as it appears in Roark, where spaces and capitals are allowed; it defaults to name. Set it to an alert’s exact existing name to bring one you created in the app under config (apply takes it over instead of creating a duplicate) when that name isn’t slug-shaped.

​
Threshold

Watch a metric aggregate over a rolling window. Opens an issue when it crosses the threshold, and optionally notifies Slack/webhooks. metric is the metric’s slug (a custom metric you defined, or a Roark system metric); the variant defaults to the metric’s default.

​
Event

Fire on platform events (call/chat analysis, simulation jobs, metric collection, issues).

​
Simulation

Notify on a simulation plan’s job outcome. plan (by name) scopes it to one plan; omit for project-wide. A simulation alert requires exactly one Slack channel and does not support webhooks.
A simulation alert reports on one plan’s run. To send a single combined report for several plans, with the PDF to email (including people without a Roark account) and to up to 10 Slack channels, use a simulation group.
  • Threshold alerts always open an issue; Slack and webhook delivery are optional additions.
  • Slack channels are referenced by their Slack-native channelId (e.g. C0123ABC) plus a channelName. The Slack workspace is resolved from the project’s connected Slack integration, so no UUIDs go in config.
  • Webhooks must be public http(s) URLs.
Referencing a Slack channel requires a Slack integration connected to the project in Roark first. Connect Slack under Settings → Project → Notifications (a one-time approval in Slack, which can’t be done from config), then reference the channel by id here. In Slack, the id is at the bottom of the channel’s About tab.
For the full field reference of every kind, see the Config DSL reference schema.