Rootly

Usage Instructions

Integrate Rootly incident management into workflows. Create and manage incidents, alerts, services, severities, and retrospectives.

Tools

`rootly_create_incident`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`title`	string	No	No description
`summary`	string	No	No description
`severityId`	string	No	No description
`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	No description
`environmentIds`	string	No	No description
`groupIds`	string	No	No description
`incidentTypeIds`	string	No	No description
`functionalityIds`	string	No	No description
`labels`	string	No	Labels as JSON object, e.g. {"platform":"osx","version":"1.29"}
`private`	boolean	No	No description

Output

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

`rootly_get_incident`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`incidentId`	string	Yes	No description

Output

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

`rootly_update_incident`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`incidentId`	string	Yes	No description
`title`	string	No	No description
`summary`	string	No	No description
`severityId`	string	No	No description
`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	No description
`serviceIds`	string	No	No description
`environmentIds`	string	No	No description
`groupIds`	string	No	No description
`incidentTypeIds`	string	No	No description
`functionalityIds`	string	No	No description
`labels`	string	No	Labels as JSON object, e.g. {"platform":"osx","version":"1.29"}
`mitigationMessage`	string	No	No description
`resolutionMessage`	string	No	No description
`cancellationMessage`	string	No	No description

Output

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

`rootly_list_incidents`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`status`	string	No	Filter by status (in_triage, started, detected, acknowledged, mitigated, resolved, closed, cancelled, scheduled, in_progress, completed)
`severity`	string	No	No description
`search`	string	No	No description
`services`	string	No	No description
`teams`	string	No	No description
`environments`	string	No	No description
`sort`	string	No	No description
`pageSize`	number	No	No description
`pageNumber`	number	No	No description

Output

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

`rootly_create_alert`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`summary`	string	Yes	No description
`description`	string	No	No description
`source`	string	Yes	No description
`status`	string	No	No description
`serviceIds`	string	No	No description
`groupIds`	string	No	No description
`environmentIds`	string	No	No description
`externalId`	string	No	No description
`externalUrl`	string	No	No description
`deduplicationKey`	string	No	No description

Output

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

`rootly_list_alerts`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`status`	string	No	No description
`source`	string	No	No description
`services`	string	No	No description
`environments`	string	No	No description
`groups`	string	No	No description
`pageSize`	number	No	No description
`pageNumber`	number	No	No description

Output

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

`rootly_add_incident_event`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`incidentId`	string	Yes	No description
`event`	string	Yes	No description
`visibility`	string	No	No description

Output

Parameter	Type	Description
`eventId`	string	The ID of the created event
`event`	string	The event summary
`visibility`	string	visibility output from the tool
`occurredAt`	string	When the event occurred
`createdAt`	string	Creation date
`updatedAt`	string	Last update date

`rootly_list_services`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`search`	string	No	No description
`pageSize`	number	No	No description
`pageNumber`	number	No	No description

Output

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

`rootly_list_severities`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`search`	string	No	No description
`pageSize`	number	No	No description
`pageNumber`	number	No	No description

Output

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

`rootly_list_teams`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`search`	string	No	No description
`pageSize`	number	No	No description
`pageNumber`	number	No	No description

Output

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

`rootly_list_environments`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`search`	string	No	No description
`pageSize`	number	No	No description
`pageNumber`	number	No	No description

Output

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

`rootly_list_incident_types`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`search`	string	No	No description
`pageSize`	number	No	No description
`pageNumber`	number	No	No description

Output

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

`rootly_list_functionalities`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`search`	string	No	No description
`pageSize`	number	No	No description
`pageNumber`	number	No	No description

Output

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

`rootly_list_retrospectives`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`status`	string	No	No description
`search`	string	No	No description
`pageSize`	number	No	No description
`pageNumber`	number	No	No description

Output

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

`rootly_delete_incident`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`incidentId`	string	Yes	No description

Output

Parameter	Type	Description
`success`	boolean	Whether the deletion succeeded
`message`	string	Result message

`rootly_get_alert`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`alertId`	string	Yes	No description

Output

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

`rootly_update_alert`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`alertId`	string	Yes	No description
`summary`	string	No	No description
`description`	string	No	No description
`source`	string	No	No description
`serviceIds`	string	No	No description
`groupIds`	string	No	No description
`environmentIds`	string	No	No description
`externalId`	string	No	No description
`externalUrl`	string	No	No description
`deduplicationKey`	string	No	No description

Output

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

`rootly_acknowledge_alert`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`alertId`	string	Yes	No description

Output

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

`rootly_resolve_alert`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`alertId`	string	Yes	No description
`resolutionMessage`	string	No	No description
`resolveRelatedIncidents`	boolean	No	No description

Output

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

`rootly_create_action_item`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`incidentId`	string	Yes	No description
`summary`	string	Yes	No description
`description`	string	No	No description
`kind`	string	No	No description
`priority`	string	No	No description
`status`	string	No	No description
`assignedToUserId`	string	No	No description
`dueDate`	string	No	No description

Output

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

`rootly_list_action_items`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`incidentId`	string	Yes	No description
`pageSize`	number	No	No description
`pageNumber`	number	No	No description

Output

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

`rootly_list_users`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`search`	string	No	No description
`email`	string	No	No description
`pageSize`	number	No	No description
`pageNumber`	number	No	No description

Output

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

`rootly_list_on_calls`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`scheduleIds`	string	No	No description
`escalationPolicyIds`	string	No	No description
`userIds`	string	No	No description
`serviceIds`	string	No	No description

Output

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

`rootly_list_schedules`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`search`	string	No	No description
`pageSize`	number	No	No description
`pageNumber`	number	No	No description

Output

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

`rootly_list_escalation_policies`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`search`	string	No	No description
`pageSize`	number	No	No description
`pageNumber`	number	No	No description

Output

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

`rootly_list_causes`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`search`	string	No	No description
`pageSize`	number	No	No description
`pageNumber`	number	No	No description

Output

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

`rootly_list_playbooks`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`pageSize`	number	No	No description
`pageNumber`	number	No	No description

Output

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

Rootly

On this page