Skip to content

Features Workflow Integrations Docs Changelog

Documentation

Search documentation

Start here

HomeIncidentRelay documentation homepage. Project READMEMain project overview from the repository docs.

Getting Started

OverviewGetting started section overview. InstallationBase installation steps and requirements. DockerRun IncidentRelay with Docker Compose. KubernetesDeploy IncidentRelay to Kubernetes with the bundled Helm chart. RPM InstallationInstall IncidentRelay from the RPM repository on Red Hat-like systems. SystemdRun web and scheduler services with systemd. ConfigurationMain configuration file and runtime settings. First Login and SetupInitial group, user, team, rotation and route setup. Quickstart ChecklistChecklist for a working first installation.

Main Concepts

OverviewCore IncidentRelay concepts. Groups and RBACAccess boundaries, memberships and permissions. ChannelsNotification destinations and channel behavior. Route Intake TokensPer-route alert intake tokens and security model. Alert MatchersShared matcher format, reusable presets and suggestions from recent alerts. Reminders and EscalationsReminder intervals, escalation timing and scheduler behavior. Escalation PoliciesMulti-step alert escalation chains, policy rules and routing modes. HeartbeatsDead-man-switch checks for watchdogs, scheduled jobs and multi-instance producers.

Incident Management

OverviewIncident management concepts and workflows. API Migration 2.3Upgrade API clients for separate AlertGroup and Incident resources. 2.3 Release NotesIncident Management 2.3 capabilities and upgrade checklist. Alerts and Alert GroupsAlert list, details, ACK and resolve flows. Incident PrioritiesPriority levels and automatic priority behavior for incidents. Incident RespondersRequest and manage additional responders for active incidents. Notification CenterPending responder requests and user-facing incident notifications. Incident StakeholdersIncident stakeholder snapshots, lifecycle notifications and service default stakeholders. Explain TraceTrace incoming alert processing, routing, grouping and suppression decisions. Alert CorrelationUse service dependencies to identify possible root causes and downstream impact across active alert groups. Alert CommentsInvestigation notes, decisions and handover context attached to alert groups. SilencesSilence known or noisy alerts. ShelvingTemporarily pause alert groups and resume processing when the shelf expires. Maintenance WindowsPlanned maintenance schedules, scopes and alert handling behavior.

Services

OverviewService ownership, matching, impact and default stakeholders. Service ModelLogical services, affected systems, service routing and impact analytics. Business ServicesModel customer-facing capabilities from technical services and calculate business impact. Notification PoliciesSelect shared notification channels for service alert events. Service Standards and ReadinessDefine operational standards, evaluate service readiness and inspect catalog events. Service SLI / SLOConfigure service reliability indicators, objectives, measurements and error budgets. Service Impact HistoryReview historical service impact snapshots, trends, reasons and affected services. Service Default StakeholdersAutomatically attach service owners as incident stakeholders.

Scheduling

OverviewOn-call scheduling, rotations, shifts and overrides. Teams, Rotations and RoutesHow ownership and alert delivery are connected. CalendarOn-call calendar, shift scheduling and team schedules. Rotation LayersLayered on-call schedules, restrictions and final schedule calculation. Rotation OverridesTemporary on-call shift and schedule overrides. On-call HealthReadiness checks and diagnostics for rotations and teams.

Integrations

OverviewInbound and outbound integration overview. AlertmanagerPrometheus Alertmanager integration. Azure MonitorReceive and normalize Azure Monitor common alert schema webhooks. Cloud.ru Cloud Eye / SMNReceive signed Cloud Eye alarm and recovery notifications through SMN. AWS SNS and CloudWatchReceive and normalize AWS SNS and CloudWatch alert lifecycle events. Grafana AlertingConfigure Grafana Alerting webhooks, routing, deduplication and recovery handling. DatadogReceive and normalize Datadog monitor alerts and recovery events. New RelicReceive New Relic Alerts Workflow issue notifications through a native webhook route. NagiosReceive Nagios Core and Nagios XI host, service, recovery and acknowledgement notifications. RMONRoute RMON alerts with normalized labels and lifecycle handling. Uptime KumaTurn Uptime Kuma monitor state changes into routed alerts and automatic recoveries. Generic WebhookGeneric alert webhook payloads. ZabbixZabbix integration setup. SentrySigned Sentry issue, metric alert and lifecycle webhooks. Sentry TroubleshootingTroubleshoot Sentry signatures, routing, deduplication and resolves. LibreNMSLibreNMS API Transport alert normalization and routing. ChannelsIntegration-specific notification channel notes. MattermostMattermost webhook and Bot API mode. SlackSlack incoming webhook and Bot API setup with interactive actions. Feishu / LarkSend text notifications to Feishu or Lark custom bot webhooks. TelegramTelegram Bot notifications. EmailEmail notifications and HTML templates. Email TemplatesHTML template syntax for email channels. Voice CallVoice call channel and provider settings. Webhook ChannelsSlack, Discord, Teams and outbound webhook channels. CalDAV Calendar SyncRead-only on-call calendar sync for CalDAV clients. ICS Calendar FeedsTokenized on-call calendar subscriptions for Outlook and Google Calendar.

User Guide

OverviewUsing IncidentRelay day to day. Event OrchestrationRoute, enrich, suppress, delay and automate incoming events with versioned rules. Profile and Personal API TokensUser profile and scoped personal tokens. Browser PushProfile-level PWA and browser push notifications for assigned users.

Voice Providers

OverviewCustom voice provider architecture. Provider APIProvider interface and expected methods. ConfigurationVoice provider configuration. Callbacks and DTMFCall callbacks and keypad actions. SecuritySecurity notes for voice callbacks. TroubleshootingTroubleshooting voice provider issues. Provider ExampleExample implementation of a custom voice provider.

Architecture

Event Orchestration ArchitectureArchitecture and execution model for Event Orchestration. Incident Management v2Architecture of the IncidentRelay incident-management lifecycle. Notification Template ArchitectureDesign and rendering model for notification templates.

API

OverviewAPI and OpenAPI notes. Event Orchestration APICreate, validate, simulate, publish and observe orchestration rules through the API. Services APIService inventory, match rules, links, runbooks, impact and analytics endpoints. Business Services APIManage business services, components, calculated status, manual overrides and history. Heartbeats APICreate, ping, pause, resume and inspect heartbeat checks and tracked instances. Escalation Policies APIAPI reference for escalation policies and policy rules. Matcher Suggestions APIRetrieve observed matcher names and values from recent alerts. Sentry Integration APISigned Sentry webhook endpoint, payload normalization and responses. Voice Call OpenAPI NotesOpenAPI notes for voice-call endpoints.

Administration

OverviewAdministration section overview. SSOOIDC and SAML SSO provider setup, login policies and group mappings. Demo DataCreate and verify demo data. Schema CheckCheck database schema after migrations. SchedulerScheduler service, reminders and escalations. Data RetentionConfigure automatic retention for resolved alert history and diagnostic traces. LoggingJSON logs and operational logging. TroubleshootingCommon operational problems and checks.

Home/Docs/Administration/Administration

Static Documentation

Administration

Version latest · Updated 2026-09-01

Language Interactive docs View on GitHub

Administration#

Administration topics:

Scheduler
Data Retention
Logging
SSO
Demo Data
Schema Check
Troubleshooting

Production installations should keep web, scheduler and optional workers as separate services.

IncidentRelay © IncidentRelay

Product

Documentation Blog Changelog Examples Supporting

Contacts

hello@roxy-wi.org Telegram chat Telegram channel GitHub

Ecosystem

Roxy-WI RMON