Skip to content

Features Workflow Integrations Docs Changelog

Documentation

Search documentation

Start here

IncidentRelay DocumentationDocumentation for IncidentRelay self-hosted on-call scheduling, alert routing and notification service IncidentRelay Project READMERepository overview, workflow, installation and API summary.

Getting Started

Getting StartedInstallation methods and first setup steps for IncidentRelay. InstallationInstallation guide dispatcher for IncidentRelay deployment methods. Docker InstallationRun IncidentRelay with Docker Compose Kubernetes InstallationDeploy IncidentRelay to Kubernetes with the bundled Helm chart RPM InstallationInstall and verify IncidentRelay on RedHat-like distributions from the RPM repository Systemd InstallationQuick start installation with systemd services ConfigurationIncidentRelay configuration file reference First Login and SetupInitial setup in the IncidentRelay web UI Quickstart ChecklistChecklist for validating a first IncidentRelay installation.

Main Concepts

Main ConceptsCore IncidentRelay concepts and recommended reading order. Groups and RBACAccess boundaries, group roles, team roles and permissions. ChannelsNotification channel concepts Route Intake TokensPer-route alert intake tokens and security model. Alert MatchersShared matcher format, editor behavior and suggestions from recent alerts. Reminders and EscalationsReminder intervals, escalation timing and scheduler behavior. Escalation PoliciesConfigure multi-step alert escalation chains in IncidentRelay HeartbeatsDead-man-switch checks for watchdogs, scheduled jobs and multi-instance producers.

Incident Management

Incident ManagementFirst-class operational Incidents and technical AlertGroup boundaries in IncidentRelay 2.3. IncidentRelay 2.3 API and Upgrade MigrationBreaking AlertGroup/Incident API split, database upgrade checks and rollback boundary for IncidentRelay 2.3. IncidentRelay 2.3 Release NotesBreaking Incident Management Core release notes and operator checklist. Alerts and Alert GroupsAlert group lifecycle, grouping, comments and API examples. Incident PrioritiesP1-P5 incident priority behavior, automatic priority updates and notification output. 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 commentsCreating, viewing, editing and deleting alert group comments in IncidentRelay SilencesSuppress notifications for matching alerts with silence rules. Alert ShelvingTemporarily pause notification and escalation for one AlertGroup without changing technical status. Maintenance WindowsPlanned maintenance schedules, scopes and alert behavior control.

Services

ServicesService inventory, ownership, dependencies, default stakeholders, impact and analytics. ServicesService inventory, ownership, dependencies, impact and 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

SchedulingOn-call calendar, layered rotations, overrides and effective schedule behavior. Teams, Rotations, Layers and RoutesHow teams, layered rotations and alert routes work together CalendarOn-call calendar view Rotation LayersLayered on-call schedules, membership periods, restrictions and final schedule calculation Rotation OverridesTemporary replacements for the final on-call schedule On-call HealthReadiness checks and diagnostics for rotations and teams.

Integrations

IntegrationsIncoming alert sources and outgoing notification channels Alertmanager IntegrationPrometheus Alertmanager route setup and payload handling. Azure MonitorSend Azure Monitor Common Alert Schema notifications to IncidentRelay through a native Action Group webhook. 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. DatadogSend Datadog monitor alerts and recoveries to IncidentRelay through the Datadog Webhooks integration. New RelicSend New Relic Alerts Workflow issue notifications to IncidentRelay 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 KumaSend Uptime Kuma monitor state changes to IncidentRelay and automatically resolve alerts when monitors recover. Generic Webhook and PagerDuty Events API v2Generic incoming webhook route setup, payload format and PagerDuty Events API v2 compatibility. Zabbix IntegrationZabbix incoming alert route setup and payload format. Sentry IntegrationSigned Sentry issue, metric alert and lifecycle webhooks. Sentry Integration TroubleshootingTroubleshoot Sentry signatures, routing, deduplication and resolves. LibreNMS IntegrationReceive LibreNMS API Transport alerts and normalize them into IncidentRelay incidents. Notification channelsCommon behavior for IncidentRelay outgoing notification channels Mattermost ChannelMattermost webhook and Bot API notification setup. Slack ChannelSlack incoming webhook and Bot API notification setup. Feishu / LarkSend IncidentRelay notifications to Feishu or Lark custom bots Telegram ChannelTelegram Bot notification setup and troubleshooting. Email ChannelEmail notification channel setup and troubleshooting. Email TemplatesCustomize IncidentRelay email notification templates. Voice Call ChannelVoice call notification channel setup and DTMF actions. Webhook-Based Notification ChannelsDiscord, Microsoft Teams and generic webhook channels. CalDAV calendar syncRead-only CalDAV sync for IncidentRelay team on-call schedules. ICS calendar feedsTokenized ICS subscription feeds for IncidentRelay team on-call schedules.

User Guide

UsageCommon day-to-day IncidentRelay workflows. Event Orchestration User GuideA practical guide to routing, enriching, suppressing, delaying and automating incoming events with IncidentRelay Event Orchestration. Profile and Personal API TokensUser profile settings, contact fields and personal API tokens. Browser PushProfile-level PWA and browser push notifications for assigned users.

Voice Providers

Custom Voice ProvidersOverview of IncidentRelay custom voice providers Provider APIHow to write a custom IncidentRelay voice provider Voice Provider ConfigurationIncidentRelay voice provider configuration Callbacks and DTMFVoice provider callbacks, statuses and keypad actions Voice Provider SecuritySecurity recommendations for custom voice providers Voice Provider TroubleshootingCommon custom voice provider problems Voice Provider ExamplesExample custom voice providers for IncidentRelay.

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

APIIncidentRelay API overview, authentication and endpoint groups. Event Orchestration APICreate, version, validate, simulate, publish and observe Event Orchestration rules through the IncidentRelay 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 IncidentRelay escalation policies and policy rules Matcher Suggestions APILoad known matcher names and values from recent alerts. Sentry Integration APISigned Sentry webhook endpoint, payload normalization and response codes. Voice Call OpenAPI NotesOpenAPI notes for IncidentRelay voice call endpoints.

Administration

AdministrationAdministration topics for operating IncidentRelay. SSOConfigure OIDC and SAML single sign-on in IncidentRelay. Demo DataCreate and verify IncidentRelay demo data for local testing. Schema CheckCheck the IncidentRelay database schema after migrations. SchedulerRun IncidentRelay reminder and escalation scheduler separately from the web process Data RetentionConfigure automatic retention for resolved alert history and diagnostic traces. LoggingIncidentRelay logging locations, fields and troubleshooting notes. TroubleshootingCommon IncidentRelay operational problems and checks.

Home/Docs/User Guide/Usage

Documentation

Usage

Version v2.3.1 · Updated 2026-09-12

Language Interactive docs View on GitHub

Usage#

This section describes user-owned settings and daily personal workflows:

Profile and Personal API Tokens
Browser Push
Alert Shelving
Event Orchestration

Operational workflows now live in focused sections:

Incident Management
Services
Scheduling

IncidentRelay © IncidentRelay

Product

Documentation Blog Changelog Examples Supporting

Contacts

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

Ecosystem

Roxy-WI RMON