Use Rootly in Sim with a Rootly API key to manage incidents and alerts, add timeline events, and look up services, severities, teams, environments, and incident types. Alert operations support deduplication; retrospective operations retrieve post-incident records for review.
Integrate Rootly incident management into workflows. Create and manage incidents, alerts, services, severities, and retrospectives.
Create a new incident in Rootly with optional severity, services, and teams.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
title | string | No | The title of the incident (auto-generated if not provided) |
summary | string | No | A summary of the incident |
severityId | string | No | Severity ID to attach to the incident |
status | string | No | Incident status (in_triage, started, detected, acknowledged, mitigated, resolved, closed, cancelled, scheduled, in_progress, completed) |
kind | string | No | Incident kind (normal, normal_sub, test, test_sub, example, example_sub, backfilled, scheduled, scheduled_sub) |
serviceIds | string | No | Comma-separated service IDs to attach |
environmentIds | string | No | Comma-separated environment IDs to attach |
groupIds | string | No | Comma-separated team/group IDs to attach |
incidentTypeIds | string | No | Comma-separated incident type IDs to attach |
functionalityIds | string | No | Comma-separated functionality IDs to attach |
labels | string | No | Labels as JSON object, e.g. {"platform":"osx","version":"1.29"} |
private | boolean | No | Create as a private incident (cannot be undone) |
| Parameter | Type | Description |
|---|
incident | object | The created incident |
↳ id | string | Unique incident ID |
↳ sequentialId | number | Sequential incident number |
↳ title | string | Incident title |
↳ slug | string | Incident slug |
↳ kind | string | Incident kind |
↳ summary | string | Incident summary |
↳ status | string | Incident status |
↳ private | boolean | Whether the incident is private |
↳ url | string | URL to the incident |
↳ shortUrl | string | Short URL to the incident |
↳ severityName | string | Severity name |
↳ severityId | string | Severity ID |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
↳ startedAt | string | Start date |
↳ mitigatedAt | string | Mitigation date |
↳ resolvedAt | string | Resolution date |
↳ closedAt | string | Closed date |
Retrieve a single incident by ID from Rootly.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
incidentId | string | Yes | The ID of the incident to retrieve |
| Parameter | Type | Description |
|---|
incident | object | The incident details |
↳ id | string | Unique incident ID |
↳ sequentialId | number | Sequential incident number |
↳ title | string | Incident title |
↳ slug | string | Incident slug |
↳ kind | string | Incident kind |
↳ summary | string | Incident summary |
↳ status | string | Incident status |
↳ private | boolean | Whether the incident is private |
↳ url | string | URL to the incident |
↳ shortUrl | string | Short URL to the incident |
↳ severityName | string | Severity name |
↳ severityId | string | Severity ID |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
↳ startedAt | string | Start date |
↳ mitigatedAt | string | Mitigation date |
↳ resolvedAt | string | Resolution date |
↳ closedAt | string | Closed date |
Update an existing incident in Rootly (status, severity, summary, etc.).
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
incidentId | string | Yes | The ID of the incident to update |
title | string | No | Updated incident title |
summary | string | No | Updated incident summary |
severityId | string | No | Updated severity ID |
status | string | No | Updated status (in_triage, started, detected, acknowledged, mitigated, resolved, closed, cancelled, scheduled, in_progress, completed) |
kind | string | No | Incident kind (normal, normal_sub, test, test_sub, example, example_sub, backfilled, scheduled, scheduled_sub) |
private | boolean | No | Set incident as private (cannot be undone) |
serviceIds | string | No | Comma-separated service IDs |
environmentIds | string | No | Comma-separated environment IDs |
groupIds | string | No | Comma-separated team/group IDs |
incidentTypeIds | string | No | Comma-separated incident type IDs to attach |
functionalityIds | string | No | Comma-separated functionality IDs to attach |
labels | string | No | Labels as JSON object, e.g. {"platform":"osx","version":"1.29"} |
mitigationMessage | string | No | How was the incident mitigated? |
resolutionMessage | string | No | How was the incident resolved? |
cancellationMessage | string | No | Why was the incident cancelled? |
| Parameter | Type | Description |
|---|
incident | object | The updated incident |
↳ id | string | Unique incident ID |
↳ sequentialId | number | Sequential incident number |
↳ title | string | Incident title |
↳ slug | string | Incident slug |
↳ kind | string | Incident kind |
↳ summary | string | Incident summary |
↳ status | string | Incident status |
↳ private | boolean | Whether the incident is private |
↳ url | string | URL to the incident |
↳ shortUrl | string | Short URL to the incident |
↳ severityName | string | Severity name |
↳ severityId | string | Severity ID |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
↳ startedAt | string | Start date |
↳ mitigatedAt | string | Mitigation date |
↳ resolvedAt | string | Resolution date |
↳ closedAt | string | Closed date |
List incidents from Rootly with optional filtering by status, severity, and more.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
status | string | No | Filter by status (in_triage, started, detected, acknowledged, mitigated, resolved, closed, cancelled, scheduled, in_progress, completed) |
severity | string | No | Filter by severity slug |
search | string | No | Search term to filter incidents |
services | string | No | Filter by service slugs (comma-separated) |
teams | string | No | Filter by team slugs (comma-separated) |
environments | string | No | Filter by environment slugs (comma-separated) |
sort | string | No | Sort order (e.g., -created_at, created_at, -started_at) |
pageSize | number | No | Number of items per page (default: 20) |
pageNumber | number | No | Page number for pagination |
| Parameter | Type | Description |
|---|
incidents | array | List of incidents |
↳ id | string | Unique incident ID |
↳ sequentialId | number | Sequential incident number |
↳ title | string | Incident title |
↳ slug | string | Incident slug |
↳ kind | string | Incident kind |
↳ summary | string | Incident summary |
↳ status | string | Incident status |
↳ private | boolean | Whether the incident is private |
↳ url | string | URL to the incident |
↳ shortUrl | string | Short URL to the incident |
↳ severityName | string | Severity name |
↳ severityId | string | Severity ID |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
↳ startedAt | string | Start date |
↳ mitigatedAt | string | Mitigation date |
↳ resolvedAt | string | Resolution date |
↳ closedAt | string | Closed date |
totalCount | number | Total number of incidents returned |
Create a new alert in Rootly for on-call notification and routing.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
summary | string | Yes | The summary of the alert |
description | string | No | A detailed description of the alert |
source | string | No | The source of the alert (e.g., api, manual, datadog, pagerduty) |
status | string | No | Alert status on creation (open, triggered) |
serviceIds | string | No | Comma-separated service IDs to attach |
groupIds | string | No | Comma-separated team/group IDs to attach |
environmentIds | string | No | Comma-separated environment IDs to attach |
externalId | string | No | External ID for the alert |
externalUrl | string | No | External URL for the alert |
deduplicationKey | string | No | Alerts sharing the same deduplication key are treated as a single alert |
| Parameter | Type | Description |
|---|
alert | object | The created alert |
↳ id | string | Unique alert ID |
↳ shortId | string | Short alert ID |
↳ summary | string | Alert summary |
↳ description | string | Alert description |
↳ source | string | Alert source |
↳ status | string | Alert status |
↳ externalId | string | External ID |
↳ externalUrl | string | External URL |
↳ deduplicationKey | string | Deduplication key |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
↳ startedAt | string | Start date |
↳ endedAt | string | End date |
List alerts from Rootly with optional filtering by status, source, and services.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
status | string | No | Filter by status (open, triggered, acknowledged, resolved) |
source | string | No | Filter by source (e.g., api, datadog, pagerduty) |
services | string | No | Filter by service slugs (comma-separated) |
environments | string | No | Filter by environment slugs (comma-separated) |
groups | string | No | Filter by team/group slugs (comma-separated) |
pageSize | number | No | Number of items per page (default: 20) |
pageNumber | number | No | Page number for pagination |
| Parameter | Type | Description |
|---|
alerts | array | List of alerts |
↳ id | string | Unique alert ID |
↳ shortId | string | Short alert ID |
↳ summary | string | Alert summary |
↳ description | string | Alert description |
↳ source | string | Alert source |
↳ status | string | Alert status |
↳ externalId | string | External ID |
↳ externalUrl | string | External URL |
↳ deduplicationKey | string | Deduplication key |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
↳ startedAt | string | Start date |
↳ endedAt | string | End date |
totalCount | number | Total number of alerts returned |
Add a timeline event to an existing incident in Rootly.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
incidentId | string | Yes | The ID of the incident to add the event to |
event | string | Yes | The summary/description of the event |
visibility | string | No | Event visibility (internal or external) |
| Parameter | Type | Description |
|---|
eventId | string | The ID of the created event |
event | string | The event summary |
visibility | string | Event visibility (internal or external) |
occurredAt | string | When the event occurred |
createdAt | string | Creation date |
updatedAt | string | Last update date |
List services from Rootly with optional search filtering.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
search | string | No | Search term to filter services |
pageSize | number | No | Number of items per page (default: 20) |
pageNumber | number | No | Page number for pagination |
| Parameter | Type | Description |
|---|
services | array | List of services |
↳ id | string | Unique service ID |
↳ name | string | Service name |
↳ slug | string | Service slug |
↳ description | string | Service description |
↳ color | string | Service color |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
totalCount | number | Total number of services returned |
List severity levels configured in Rootly.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
search | string | No | Search term to filter severities |
pageSize | number | No | Number of items per page (default: 20) |
pageNumber | number | No | Page number for pagination |
| Parameter | Type | Description |
|---|
severities | array | List of severity levels |
↳ id | string | Unique severity ID |
↳ name | string | Severity name |
↳ slug | string | Severity slug |
↳ description | string | Severity description |
↳ severity | string | Severity level (critical, high, medium, low) |
↳ color | string | Severity color |
↳ position | number | Display position |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
totalCount | number | Total number of severities returned |
List teams (groups) configured in Rootly.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
search | string | No | Search term to filter teams |
pageSize | number | No | Number of items per page (default: 20) |
pageNumber | number | No | Page number for pagination |
| Parameter | Type | Description |
|---|
teams | array | List of teams |
↳ id | string | Unique team ID |
↳ name | string | Team name |
↳ slug | string | Team slug |
↳ description | string | Team description |
↳ color | string | Team color |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
totalCount | number | Total number of teams returned |
List environments configured in Rootly.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
search | string | No | Search term to filter environments |
pageSize | number | No | Number of items per page (default: 20) |
pageNumber | number | No | Page number for pagination |
| Parameter | Type | Description |
|---|
environments | array | List of environments |
↳ id | string | Unique environment ID |
↳ name | string | Environment name |
↳ slug | string | Environment slug |
↳ description | string | Environment description |
↳ color | string | Environment color |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
totalCount | number | Total number of environments returned |
List incident types configured in Rootly.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
search | string | No | Filter incident types by name |
pageSize | number | No | Number of items per page (default: 20) |
pageNumber | number | No | Page number for pagination |
| Parameter | Type | Description |
|---|
incidentTypes | array | List of incident types |
↳ id | string | Unique incident type ID |
↳ name | string | Incident type name |
↳ slug | string | Incident type slug |
↳ description | string | Incident type description |
↳ color | string | Incident type color |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
totalCount | number | Total number of incident types returned |
List functionalities configured in Rootly.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
search | string | No | Search term to filter functionalities |
pageSize | number | No | Number of items per page (default: 20) |
pageNumber | number | No | Page number for pagination |
| Parameter | Type | Description |
|---|
functionalities | array | List of functionalities |
↳ id | string | Unique functionality ID |
↳ name | string | Functionality name |
↳ slug | string | Functionality slug |
↳ description | string | Functionality description |
↳ color | string | Functionality color |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
totalCount | number | Total number of functionalities returned |
List incident retrospectives (post-mortems) from Rootly.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
status | string | No | Filter by status (draft, published) |
search | string | No | Search term to filter retrospectives |
pageSize | number | No | Number of items per page (default: 20) |
pageNumber | number | No | Page number for pagination |
| Parameter | Type | Description |
|---|
retrospectives | array | List of retrospectives |
↳ id | string | Unique retrospective ID |
↳ title | string | Retrospective title |
↳ status | string | Status (draft or published) |
↳ url | string | URL to the retrospective |
↳ startedAt | string | Incident start date |
↳ mitigatedAt | string | Mitigation date |
↳ resolvedAt | string | Resolution date |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
totalCount | number | Total number of retrospectives returned |
Delete an incident by ID from Rootly.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
incidentId | string | Yes | The ID of the incident to delete |
| Parameter | Type | Description |
|---|
success | boolean | Whether the deletion succeeded |
message | string | Result message |
Retrieve a single alert by ID from Rootly.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
alertId | string | Yes | The ID of the alert to retrieve |
| Parameter | Type | Description |
|---|
alert | object | The alert details |
↳ id | string | Unique alert ID |
↳ shortId | string | Short alert ID |
↳ summary | string | Alert summary |
↳ description | string | Alert description |
↳ source | string | Alert source |
↳ status | string | Alert status |
↳ externalId | string | External ID |
↳ externalUrl | string | External URL |
↳ deduplicationKey | string | Deduplication key |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
↳ startedAt | string | Start date |
↳ endedAt | string | End date |
Update an existing alert in Rootly.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
alertId | string | Yes | The ID of the alert to update |
summary | string | No | Updated alert summary |
description | string | No | Updated alert description |
source | string | No | Updated alert source |
serviceIds | string | No | Comma-separated service IDs to attach |
groupIds | string | No | Comma-separated team/group IDs to attach |
environmentIds | string | No | Comma-separated environment IDs to attach |
externalId | string | No | Updated external ID |
externalUrl | string | No | Updated external URL |
deduplicationKey | string | No | Updated deduplication key |
| Parameter | Type | Description |
|---|
alert | object | The updated alert |
↳ id | string | Unique alert ID |
↳ shortId | string | Short alert ID |
↳ summary | string | Alert summary |
↳ description | string | Alert description |
↳ source | string | Alert source |
↳ status | string | Alert status |
↳ externalId | string | External ID |
↳ externalUrl | string | External URL |
↳ deduplicationKey | string | Deduplication key |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
↳ startedAt | string | Start date |
↳ endedAt | string | End date |
Acknowledge an alert in Rootly.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
alertId | string | Yes | The ID of the alert to acknowledge |
| Parameter | Type | Description |
|---|
alert | object | The acknowledged alert |
↳ id | string | Unique alert ID |
↳ shortId | string | Short alert ID |
↳ summary | string | Alert summary |
↳ description | string | Alert description |
↳ source | string | Alert source |
↳ status | string | Alert status |
↳ externalId | string | External ID |
↳ externalUrl | string | External URL |
↳ deduplicationKey | string | Deduplication key |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
↳ startedAt | string | Start date |
↳ endedAt | string | End date |
Resolve an alert in Rootly.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
alertId | string | Yes | The ID of the alert to resolve |
resolutionMessage | string | No | Message describing how the alert was resolved |
resolveRelatedIncidents | boolean | No | Whether to also resolve related incidents |
| Parameter | Type | Description |
|---|
alert | object | The resolved alert |
↳ id | string | Unique alert ID |
↳ shortId | string | Short alert ID |
↳ summary | string | Alert summary |
↳ description | string | Alert description |
↳ source | string | Alert source |
↳ status | string | Alert status |
↳ externalId | string | External ID |
↳ externalUrl | string | External URL |
↳ deduplicationKey | string | Deduplication key |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
↳ startedAt | string | Start date |
↳ endedAt | string | End date |
Create a new action item for an incident in Rootly.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
incidentId | string | Yes | The ID of the incident to add the action item to |
summary | string | Yes | The title of the action item |
description | string | No | A detailed description of the action item |
kind | string | No | The kind of action item (task, follow_up) |
priority | string | No | Priority level (high, medium, low) |
status | string | No | Action item status (open, in_progress, cancelled, done) |
assignedToUserId | string | No | The user ID to assign the action item to |
dueDate | string | No | Due date for the action item |
| Parameter | Type | Description |
|---|
actionItem | object | The created action item |
↳ id | string | Unique action item ID |
↳ summary | string | Action item title |
↳ description | string | Action item description |
↳ kind | string | Action item kind (task, follow_up) |
↳ priority | string | Priority level |
↳ status | string | Action item status |
↳ dueDate | string | Due date |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
List action items for an incident in Rootly.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
incidentId | string | Yes | The ID of the incident to list action items for |
pageSize | number | No | Number of items per page (default: 20) |
pageNumber | number | No | Page number for pagination |
| Parameter | Type | Description |
|---|
actionItems | array | List of action items |
↳ id | string | Unique action item ID |
↳ summary | string | Action item title |
↳ description | string | Action item description |
↳ kind | string | Action item kind (task, follow_up) |
↳ priority | string | Priority level |
↳ status | string | Action item status |
↳ dueDate | string | Due date |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
totalCount | number | Total number of action items returned |
List users from Rootly with optional search and email filtering.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
search | string | No | Search term to filter users |
email | string | No | Filter users by email address |
pageSize | number | No | Number of items per page (default: 20) |
pageNumber | number | No | Page number for pagination |
| Parameter | Type | Description |
|---|
users | array | List of users |
↳ id | string | Unique user ID |
↳ email | string | User email address |
↳ firstName | string | User first name |
↳ lastName | string | User last name |
↳ fullName | string | User full name |
↳ timeZone | string | User time zone |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
totalCount | number | Total number of users returned |
List current on-call entries from Rootly with optional filtering.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
scheduleIds | string | No | Comma-separated schedule IDs to filter by |
escalationPolicyIds | string | No | Comma-separated escalation policy IDs to filter by |
userIds | string | No | Comma-separated user IDs to filter by |
serviceIds | string | No | Comma-separated service IDs to filter by |
| Parameter | Type | Description |
|---|
onCalls | array | List of on-call entries |
↳ id | string | Unique on-call entry ID |
↳ userId | string | ID of the on-call user |
↳ userName | string | Name of the on-call user |
↳ scheduleId | string | ID of the associated schedule |
↳ scheduleName | string | Name of the associated schedule |
↳ escalationPolicyId | string | ID of the associated escalation policy |
↳ startTime | string | On-call start time |
↳ endTime | string | On-call end time |
totalCount | number | Total number of on-call entries returned |
List on-call schedules from Rootly with optional search filtering.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
search | string | No | Search term to filter schedules |
pageSize | number | No | Number of items per page (default: 20) |
pageNumber | number | No | Page number for pagination |
| Parameter | Type | Description |
|---|
schedules | array | List of schedules |
↳ id | string | Unique schedule ID |
↳ name | string | Schedule name |
↳ description | string | Schedule description |
↳ allTimeCoverage | boolean | Whether schedule provides 24/7 coverage |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
totalCount | number | Total number of schedules returned |
List escalation policies from Rootly with optional search filtering.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
search | string | No | Search term to filter escalation policies |
pageSize | number | No | Number of items per page (default: 20) |
pageNumber | number | No | Page number for pagination |
| Parameter | Type | Description |
|---|
escalationPolicies | array | List of escalation policies |
↳ id | string | Unique escalation policy ID |
↳ name | string | Escalation policy name |
↳ description | string | Escalation policy description |
↳ repeatCount | number | Number of times to repeat escalation |
↳ groupIds | array | Associated group IDs |
↳ serviceIds | array | Associated service IDs |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
totalCount | number | Total number of escalation policies returned |
List causes from Rootly with optional search filtering.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
search | string | No | Search term to filter causes |
pageSize | number | No | Number of items per page (default: 20) |
pageNumber | number | No | Page number for pagination |
| Parameter | Type | Description |
|---|
causes | array | List of causes |
↳ id | string | Unique cause ID |
↳ name | string | Cause name |
↳ slug | string | Cause slug |
↳ description | string | Cause description |
↳ position | number | Cause position |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
totalCount | number | Total number of causes returned |
List playbooks from Rootly with pagination support.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
pageSize | number | No | Number of items per page (default: 20) |
pageNumber | number | No | Page number for pagination |
| Parameter | Type | Description |
|---|
playbooks | array | List of playbooks |
↳ id | string | Unique playbook ID |
↳ title | string | Playbook title |
↳ summary | string | Playbook summary |
↳ externalUrl | string | External URL |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
totalCount | number | Total number of playbooks returned |
Transition a Rootly incident to the mitigated state.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
incidentId | string | Yes | The ID of the incident to mitigate |
mitigationMessage | string | No | How was the incident mitigated? |
| Parameter | Type | Description |
|---|
incident | object | The mitigated incident |
↳ id | string | Unique incident ID |
↳ sequentialId | number | Sequential incident number |
↳ title | string | Incident title |
↳ slug | string | Incident slug |
↳ kind | string | Incident kind |
↳ summary | string | Incident summary |
↳ status | string | Incident status |
↳ private | boolean | Whether the incident is private |
↳ url | string | URL to the incident |
↳ shortUrl | string | Short URL to the incident |
↳ severityName | string | Severity name |
↳ severityId | string | Severity ID |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
↳ startedAt | string | Start date |
↳ mitigatedAt | string | Mitigation date |
↳ resolvedAt | string | Resolution date |
↳ closedAt | string | Closed date |
Transition a Rootly incident to the resolved state.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
incidentId | string | Yes | The ID of the incident to resolve |
resolutionMessage | string | No | How was the incident resolved? |
| Parameter | Type | Description |
|---|
incident | object | The resolved incident |
↳ id | string | Unique incident ID |
↳ sequentialId | number | Sequential incident number |
↳ title | string | Incident title |
↳ slug | string | Incident slug |
↳ kind | string | Incident kind |
↳ summary | string | Incident summary |
↳ status | string | Incident status |
↳ private | boolean | Whether the incident is private |
↳ url | string | URL to the incident |
↳ shortUrl | string | Short URL to the incident |
↳ severityName | string | Severity name |
↳ severityId | string | Severity ID |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
↳ startedAt | string | Start date |
↳ mitigatedAt | string | Mitigation date |
↳ resolvedAt | string | Resolution date |
↳ closedAt | string | Closed date |
Assign an incident role (e.g. commander) to a user on a Rootly incident.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
incidentId | string | Yes | The ID of the incident |
userId | string | Yes | The ID of the user to assign (use List Users to find IDs) |
incidentRoleId | string | Yes | The ID of the incident role (use List Incident Roles to find IDs) |
| Parameter | Type | Description |
|---|
incident | object | The incident after the role assignment |
↳ id | string | Unique incident ID |
↳ sequentialId | number | Sequential incident number |
↳ title | string | Incident title |
↳ slug | string | Incident slug |
↳ kind | string | Incident kind |
↳ summary | string | Incident summary |
↳ status | string | Incident status |
↳ private | boolean | Whether the incident is private |
↳ url | string | URL to the incident |
↳ shortUrl | string | Short URL to the incident |
↳ severityName | string | Severity name |
↳ severityId | string | Severity ID |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
↳ startedAt | string | Start date |
↳ mitigatedAt | string | Mitigation date |
↳ resolvedAt | string | Resolution date |
↳ closedAt | string | Closed date |
Remove an incident role assignment from a user on a Rootly incident.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
incidentId | string | Yes | The ID of the incident |
userId | string | Yes | The ID of the user to unassign (use List Users to find IDs) |
incidentRoleId | string | Yes | The ID of the incident role to remove (use List Incident Roles to find IDs) |
| Parameter | Type | Description |
|---|
incident | object | The incident after the role was unassigned |
↳ id | string | Unique incident ID |
↳ sequentialId | number | Sequential incident number |
↳ title | string | Incident title |
↳ slug | string | Incident slug |
↳ kind | string | Incident kind |
↳ summary | string | Incident summary |
↳ status | string | Incident status |
↳ private | boolean | Whether the incident is private |
↳ url | string | URL to the incident |
↳ shortUrl | string | Short URL to the incident |
↳ severityName | string | Severity name |
↳ severityId | string | Severity ID |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
↳ startedAt | string | Start date |
↳ mitigatedAt | string | Mitigation date |
↳ resolvedAt | string | Resolution date |
↳ closedAt | string | Closed date |
Subscribe users to a Rootly incident so they receive updates.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
incidentId | string | Yes | The ID of the incident |
userIds | string | Yes | Comma-separated user IDs to subscribe (use List Users to find IDs) |
| Parameter | Type | Description |
|---|
incident | object | The incident after subscribers were added |
↳ id | string | Unique incident ID |
↳ sequentialId | number | Sequential incident number |
↳ title | string | Incident title |
↳ slug | string | Incident slug |
↳ kind | string | Incident kind |
↳ summary | string | Incident summary |
↳ status | string | Incident status |
↳ private | boolean | Whether the incident is private |
↳ url | string | URL to the incident |
↳ shortUrl | string | Short URL to the incident |
↳ severityName | string | Severity name |
↳ severityId | string | Severity ID |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
↳ startedAt | string | Start date |
↳ mitigatedAt | string | Mitigation date |
↳ resolvedAt | string | Resolution date |
↳ closedAt | string | Closed date |
Unsubscribe users from a Rootly incident.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
incidentId | string | Yes | The ID of the incident |
userIds | string | Yes | Comma-separated user IDs to unsubscribe (use List Users to find IDs) |
| Parameter | Type | Description |
|---|
incident | object | The incident after subscribers were removed |
↳ id | string | Unique incident ID |
↳ sequentialId | number | Sequential incident number |
↳ title | string | Incident title |
↳ slug | string | Incident slug |
↳ kind | string | Incident kind |
↳ summary | string | Incident summary |
↳ status | string | Incident status |
↳ private | boolean | Whether the incident is private |
↳ url | string | URL to the incident |
↳ shortUrl | string | Short URL to the incident |
↳ severityName | string | Severity name |
↳ severityId | string | Severity ID |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
↳ startedAt | string | Start date |
↳ mitigatedAt | string | Mitigation date |
↳ resolvedAt | string | Resolution date |
↳ closedAt | string | Closed date |
Post a public status page update for a Rootly incident.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
incidentId | string | Yes | The ID of the incident |
event | string | Yes | The status page update message to publish |
statusPageId | string | No | The ID of the status page to post to |
status | string | No | Status to set (investigating, identified, monitoring, resolved, scheduled, in_progress, completed) |
notifySubscribers | boolean | No | Whether to notify status page subscribers |
shouldTweet | boolean | No | Whether to post the update to the linked Twitter/X account |
| Parameter | Type | Description |
|---|
statusPageEvent | object | The created status page event |
↳ id | string | Unique status page event ID |
↳ event | string | The published update message |
↳ statusPageId | string | Status page ID |
↳ status | string | Status that was set |
↳ notifySubscribers | boolean | Whether subscribers were notified |
↳ shouldTweet | boolean | Whether the update was tweeted |
↳ startedAt | string | When the event started |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
Update a Rootly incident action item (status, priority, assignee, etc.).
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
actionItemId | string | Yes | The ID of the action item to update |
summary | string | No | Updated action item title |
description | string | No | Updated description |
kind | string | No | The kind of action item (task, follow_up) |
priority | string | No | Priority level (high, medium, low) |
status | string | No | Action item status (open, in_progress, cancelled, done) |
assignedToUserId | string | No | The user ID to assign the action item to |
dueDate | string | No | Due date for the action item |
| Parameter | Type | Description |
|---|
actionItem | object | The updated action item |
↳ id | string | Unique action item ID |
↳ summary | string | Action item title |
↳ description | string | Action item description |
↳ kind | string | Action item kind (task, follow_up) |
↳ priority | string | Priority level |
↳ status | string | Action item status |
↳ dueDate | string | Due date |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
Delete a Rootly incident action item.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
actionItemId | string | Yes | The ID of the action item to delete |
| Parameter | Type | Description |
|---|
success | boolean | Whether the action item was deleted |
message | string | Result message |
Snooze a Rootly alert for a set number of minutes.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
alertId | string | Yes | The ID of the alert to snooze |
delayMinutes | number | Yes | Number of minutes to snooze the alert |
| Parameter | Type | Description |
|---|
alert | object | The snoozed alert |
↳ id | string | Unique alert ID |
↳ shortId | string | Short alert ID |
↳ summary | string | Alert summary |
↳ description | string | Alert description |
↳ source | string | Alert source |
↳ status | string | Alert status |
↳ externalId | string | External ID |
↳ externalUrl | string | External URL |
↳ deduplicationKey | string | Deduplication key |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
↳ startedAt | string | Start date |
↳ endedAt | string | End date |
Escalate a Rootly alert, optionally to a specific escalation policy or level.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
alertId | string | Yes | The ID of the alert to escalate |
escalationPolicyId | string | No | Escalation policy ID to escalate to (use List Escalation Policies to find IDs) |
escalationPolicyLevel | number | No | Escalation policy level to escalate to |
| Parameter | Type | Description |
|---|
alert | object | The escalated alert |
↳ id | string | Unique alert ID |
↳ shortId | string | Short alert ID |
↳ summary | string | Alert summary |
↳ description | string | Alert description |
↳ source | string | Alert source |
↳ status | string | Alert status |
↳ externalId | string | External ID |
↳ externalUrl | string | External URL |
↳ deduplicationKey | string | Deduplication key |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
↳ startedAt | string | Start date |
↳ endedAt | string | End date |
List the timeline events for a Rootly incident.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
incidentId | string | Yes | The ID of the incident |
pageSize | number | No | Number of items per page (default: 20) |
pageNumber | number | No | Page number for pagination |
| Parameter | Type | Description |
|---|
events | array | List of incident timeline events |
↳ id | string | Unique event ID |
↳ event | string | The event description |
↳ visibility | string | Event visibility (internal or external) |
↳ occurredAt | string | When the event occurred |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
totalCount | number | Total number of events returned |
Trigger a Rootly automation workflow, optionally scoped to an incident or alert.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
workflowId | string | Yes | The ID of the workflow to run |
incidentId | string | No | Incident ID to run the workflow against |
alertId | string | No | Alert ID to run the workflow against |
immediate | boolean | No | Run immediately (true) or respect the workflow wait time (false). Default true |
checkConditions | boolean | No | Whether to evaluate the workflow conditions before running. Default false |
| Parameter | Type | Description |
|---|
workflowRun | object | The triggered workflow run |
↳ id | string | Unique workflow run ID |
↳ workflowId | string | ID of the workflow that ran |
↳ status | string | Run status (queued, started, completed, completed_with_errors, failed, canceled) |
↳ statusMessage | string | Status detail message |
↳ triggeredBy | string | What triggered the run (system, user, workflow) |
↳ incidentId | string | Associated incident ID |
↳ alertId | string | Associated alert ID |
↳ startedAt | string | When the run started |
↳ completedAt | string | When the run completed |
↳ failedAt | string | When the run failed |
↳ canceledAt | string | When the run was canceled |
List incident roles configured in Rootly (e.g. commander, scribe).
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rootly API key |
search | string | No | Search term to filter incident roles |
pageSize | number | No | Number of items per page (default: 20) |
pageNumber | number | No | Page number for pagination |
| Parameter | Type | Description |
|---|
incidentRoles | array | List of incident roles |
↳ id | string | Unique incident role ID |
↳ name | string | Role name |
↳ slug | string | Role slug |
↳ summary | string | Role summary |
↳ description | string | Role description |
↳ position | number | Display position |
↳ optional | boolean | Whether the role is optional |
↳ enabled | boolean | Whether the role is enabled |
↳ createdAt | string | Creation date |
↳ updatedAt | string | Last update date |
totalCount | number | Total number of incident roles returned |
A Trigger is a block that starts a workflow when an event happens in this service.
Trigger workflow when a new alert is created in Rootly
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | API Key |
| Parameter | Type | Description |
|---|
eventId | string | Unique webhook event ID |
eventType | string | Rootly event type (e.g. alert.created) |
issuedAt | string | When the event was issued (ISO 8601) |
data | object | data output from the tool |
↳ id | string | Alert ID |
↳ team_id | number | Team ID |
↳ source | string | Alert source (e.g. pagerduty) |
↳ summary | string | Alert summary |
↳ labels | json | Alert labels |
↳ data | json | Raw alert payload data |
↳ external_id | string | External alert ID |
↳ external_url | string | External alert URL |
↳ webhook_type | string | Webhook type |
↳ webhook_id | string | Webhook ID |
↳ webhook_idempotency_key | string | Webhook idempotency key |
↳ started_at | string | When the alert started |
↳ ended_at | string | When the alert ended |
↳ deleted_at | string | When the alert was deleted |
↳ created_at | string | Alert creation timestamp |
↳ updated_at | string | Alert last update timestamp |
Trigger workflow when a new incident is created in Rootly
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | API Key |
| Parameter | Type | Description |
|---|
eventId | string | Unique webhook event ID |
eventType | string | Rootly event type (e.g. incident.created) |
issuedAt | string | When the event was issued (ISO 8601) |
data | object | data output from the tool |
↳ id | string | Incident ID |
↳ sequential_id | number | Sequential incident number |
↳ title | string | Incident title |
↳ public_title | string | Public-facing incident title |
↳ slug | string | Incident slug |
↳ kind | string | Incident kind (normal, test, etc.) |
↳ private | boolean | Whether the incident is private |
↳ summary | string | Incident summary |
↳ status | string | Incident status |
↳ url | string | Incident URL in Rootly |
↳ short_url | string | Shortened incident URL |
↳ mitigation_message | string | Mitigation message |
↳ resolution_message | string | Resolution message |
↳ cancellation_message | string | Cancellation message |
↳ slack_channel_name | string | Linked Slack channel name |
↳ slack_channel_id | string | Linked Slack channel ID |
↳ slack_channel_url | string | Linked Slack channel URL |
↳ started_at | string | When the incident started |
↳ detected_at | string | When the incident was detected |
↳ acknowledged_at | string | When the incident was acknowledged |
↳ mitigated_at | string | When the incident was mitigated |
↳ resolved_at | string | When the incident was resolved |
↳ cancelled_at | string | When the incident was cancelled |
↳ created_at | string | Incident creation timestamp |
↳ updated_at | string | Incident last update timestamp |
↳ labels | json | Incident labels (key-value pairs) |
↳ severity | json | Incident severity object |
↳ user | json | User who owns the incident |
↳ started_by | json | User who started the incident |
↳ mitigated_by | json | User who mitigated the incident |
↳ resolved_by | json | User who resolved the incident |
↳ cancelled_by | json | User who cancelled the incident |
↳ roles | json | Assigned incident roles |
↳ environments | json | Affected environments |
↳ incident_types | json | Incident types |
↳ services | json | Affected services |
↳ functionalities | json | Affected functionalities |
↳ groups | json | Associated teams/groups |
↳ events | json | Timeline events |
↳ action_items | json | Action items |
↳ incident_post_mortem | json | Retrospective/post-mortem object |
Trigger workflow when an incident is resolved in Rootly
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | API Key |
| Parameter | Type | Description |
|---|
eventId | string | Unique webhook event ID |
eventType | string | Rootly event type (e.g. incident.created) |
issuedAt | string | When the event was issued (ISO 8601) |
data | object | data output from the tool |
↳ id | string | Incident ID |
↳ sequential_id | number | Sequential incident number |
↳ title | string | Incident title |
↳ public_title | string | Public-facing incident title |
↳ slug | string | Incident slug |
↳ kind | string | Incident kind (normal, test, etc.) |
↳ private | boolean | Whether the incident is private |
↳ summary | string | Incident summary |
↳ status | string | Incident status |
↳ url | string | Incident URL in Rootly |
↳ short_url | string | Shortened incident URL |
↳ mitigation_message | string | Mitigation message |
↳ resolution_message | string | Resolution message |
↳ cancellation_message | string | Cancellation message |
↳ slack_channel_name | string | Linked Slack channel name |
↳ slack_channel_id | string | Linked Slack channel ID |
↳ slack_channel_url | string | Linked Slack channel URL |
↳ started_at | string | When the incident started |
↳ detected_at | string | When the incident was detected |
↳ acknowledged_at | string | When the incident was acknowledged |
↳ mitigated_at | string | When the incident was mitigated |
↳ resolved_at | string | When the incident was resolved |
↳ cancelled_at | string | When the incident was cancelled |
↳ created_at | string | Incident creation timestamp |
↳ updated_at | string | Incident last update timestamp |
↳ labels | json | Incident labels (key-value pairs) |
↳ severity | json | Incident severity object |
↳ user | json | User who owns the incident |
↳ started_by | json | User who started the incident |
↳ mitigated_by | json | User who mitigated the incident |
↳ resolved_by | json | User who resolved the incident |
↳ cancelled_by | json | User who cancelled the incident |
↳ roles | json | Assigned incident roles |
↳ environments | json | Affected environments |
↳ incident_types | json | Incident types |
↳ services | json | Affected services |
↳ functionalities | json | Affected functionalities |
↳ groups | json | Associated teams/groups |
↳ events | json | Timeline events |
↳ action_items | json | Action items |
↳ incident_post_mortem | json | Retrospective/post-mortem object |
Trigger workflow when an incident is updated in Rootly
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | API Key |
| Parameter | Type | Description |
|---|
eventId | string | Unique webhook event ID |
eventType | string | Rootly event type (e.g. incident.created) |
issuedAt | string | When the event was issued (ISO 8601) |
data | object | data output from the tool |
↳ id | string | Incident ID |
↳ sequential_id | number | Sequential incident number |
↳ title | string | Incident title |
↳ public_title | string | Public-facing incident title |
↳ slug | string | Incident slug |
↳ kind | string | Incident kind (normal, test, etc.) |
↳ private | boolean | Whether the incident is private |
↳ summary | string | Incident summary |
↳ status | string | Incident status |
↳ url | string | Incident URL in Rootly |
↳ short_url | string | Shortened incident URL |
↳ mitigation_message | string | Mitigation message |
↳ resolution_message | string | Resolution message |
↳ cancellation_message | string | Cancellation message |
↳ slack_channel_name | string | Linked Slack channel name |
↳ slack_channel_id | string | Linked Slack channel ID |
↳ slack_channel_url | string | Linked Slack channel URL |
↳ started_at | string | When the incident started |
↳ detected_at | string | When the incident was detected |
↳ acknowledged_at | string | When the incident was acknowledged |
↳ mitigated_at | string | When the incident was mitigated |
↳ resolved_at | string | When the incident was resolved |
↳ cancelled_at | string | When the incident was cancelled |
↳ created_at | string | Incident creation timestamp |
↳ updated_at | string | Incident last update timestamp |
↳ labels | json | Incident labels (key-value pairs) |
↳ severity | json | Incident severity object |
↳ user | json | User who owns the incident |
↳ started_by | json | User who started the incident |
↳ mitigated_by | json | User who mitigated the incident |
↳ resolved_by | json | User who resolved the incident |
↳ cancelled_by | json | User who cancelled the incident |
↳ roles | json | Assigned incident roles |
↳ environments | json | Affected environments |
↳ incident_types | json | Incident types |
↳ services | json | Affected services |
↳ functionalities | json | Affected functionalities |
↳ groups | json | Associated teams/groups |
↳ events | json | Timeline events |
↳ action_items | json | Action items |
↳ incident_post_mortem | json | Retrospective/post-mortem object |