Rootly

App · 29 actions

Run incident response from your workflows: declare, update, mitigate and resolve incidents, add timeline notes and action items, raise and update alerts, and manage services.

Actions

ActionWhat it does
Add action itemAdd a task or follow-up to an incident, with a priority, an owner and a due date.
Add timeline noteAdd a note to an incident's timeline, visible to responders or shown on status pages.
Create serviceAdd a service to your catalog, so incidents and alerts can be tied to it.
Declare incidentDeclare a new incident with a title and, if you like, a severity, the services, environments, types and teams involved, and labels.
Delete action itemDelete an action item from an incident.
Delete incidentPermanently delete an incident and its timeline.
Delete serviceDelete a service from your catalog.
Get alertGet one alert with its status, services, labels and times.
Get current userGet the Rootly user the API key acts as: name, email and time zone.
Get incidentGet one incident with its status, severity, services, teams, messages and timestamps.
Get serviceGet one service with its owners and environments.
List action itemsList the action items on an incident.
List alertsList alerts, filtered by status or source.
List environmentsList environments such as production and staging.
List functionalitiesList the functionalities (the capabilities of your product) defined in Rootly.
List incident typesList the types an incident can be tagged with.
List incidentsList incidents, filtered by text, status, severity, service, team, environment, type or creation date.
List servicesList the services in your catalog.
List severitiesList the severities an incident can be given.
List teamsList the teams in your organisation.
List timeline notesList the notes on an incident's timeline.
List usersList the people in your Rootly organisation, optionally narrowed by name or email.
Mitigate incidentMark an incident mitigated: customers are no longer affected but the cause may remain.
Raise alertRaise an alert in Rootly from a workflow, for the services, environments and teams it concerns.
Resolve incidentMark an incident resolved: the problem is fixed.
Update action itemChange an action item's summary, status, priority, owner or due date.
Update alertChange an alert's summary, description, noise flag, services, environments, teams or labels.
Update incidentChange an incident's title, summary, status, severity, services, environments, types, teams or labels.
Update serviceChange a service's name, description, color, environments or owner teams.

Add action item

Add a task or follow-up to an incident, with a priority, an owner and a due date.

Inputs

Incident IDincident_idtextRequired
The incident's id, from 'List incidents' or 'Declare incident'.
SummarysummarytextRequired
What needs doing, in a line.
Descriptiondescriptiontext
More detail on what needs doing.
Kinditem_kindtext
A task, or a follow-up for after the incident.One of: task, follow_up (Follow-up).
Priorityprioritytext
How urgent it is.One of: high, medium, low.
Statusstatustext
Where it stands. Rootly starts new ones as open.One of: open, in_progress (In progress), done, cancelled.
Assign toassignee_idtext
The person responsible. Pick one, or give their user id.
Due datedue_datedate
When it should be done.

Outputs

action_itemobject
The action item
Example output
{
  "action_item": {
    "assigned_to": {},
    "created_at": "2026-10-15T09:00:00.000Z",
    "created_by": {},
    "description": "",
    "due_date": "2026-10-30",
    "id": "3a2b1c0d-9e8f-4a7b-8c6d-5e4f3a2b1c0d",
    "kind": "task",
    "priority": "medium",
    "status": "open",
    "summary": "Add an alert for 500 errors",
    "updated_at": "2026-10-15T09:00:00.000Z"
  }
}

Add timeline note

Add a note to an incident's timeline, visible to responders or shown on status pages.

Inputs

Incident IDincident_idtextRequired
The incident's id, from 'List incidents' or 'Declare incident'.
NoteeventtextRequired
What happened.
Who can see itvisibilitytext
Defaults to responders only.One of: internal (Internal (responders only)), external (External (shown on status pages)).

Outputs

eventobject
The timeline note
Example output
{
  "event": {
    "created_at": "2026-10-15T09:00:00.000Z",
    "event": "Rolled back the 14:02 deploy.",
    "id": "7e1d2c3b-4a5f-4e6d-8c7b-9a0f1e2d3c4b",
    "occurred_at": "2026-10-15T09:00:00.000Z",
    "updated_at": "2026-10-15T09:00:00.000Z",
    "visibility": "internal"
  }
}

Create service

Add a service to your catalog, so incidents and alerts can be tied to it.

Inputs

NamenametextRequired
The service's name.
Descriptiondescriptiontext
What the service does.
Colorcolortext
A hex color for the service, like #1F8A70.
Environmentsenvironment_idslist
The environments the service runs in. Choose any number.
Owner teamsowner_team_idslist
The teams that own the service. Choose any number of them.
External IDexternal_idtext
The service's id in another system, such as a service catalog.

Outputs

serviceobject
The service
Example output
{
  "service": {
    "color": "#1F8A70",
    "created_at": "2026-10-15T09:00:00.000Z",
    "description": "Takes payments.",
    "environment_ids": [],
    "external_id": "",
    "id": "6f5e4d3c-2b1a-4f0e-9d8c-7b6a5f4e3d2c",
    "name": "Checkout API",
    "owner_group_ids": [],
    "slug": "checkout-api",
    "updated_at": "2026-10-15T09:00:00.000Z"
  }
}

Declare incident

Declare a new incident with a title and, if you like, a severity, the services, environments, types and teams involved, and labels. Rootly then runs the workflows you set up for new incidents.

Inputs

TitletitletextRequired
What happened, in a line.
Summarysummarytext
More detail for the responders.
Public titlepublic_titletext
The title shown on status pages, if different from the title.
Severityseverity_idtext
How serious the incident is. Pick one, or give its id.
Statusstatustext
Where the incident starts. Rootly starts it as started.One of: in_triage (In triage), started, detected, acknowledged, mitigated, resolved, closed, cancelled, scheduled (Scheduled (maintenance)), in_progress (In progress (maintenance)), completed (Completed (maintenance)).
Kindincident_kindtext
Use Test or Example to keep it out of your real incident reports.One of: normal, test, example, backfilled.
Privateprivatetrue/false
Hide the incident from people who are not responders. It cannot be made public again.
Servicesservice_idslist
The services affected. Choose any number of them.
Environmentsenvironment_idslist
The environments affected, such as production. Choose any number.
Incident typesincident_type_idslist
The types to tag the incident with. Choose any number of them.
Teamsteam_idslist
The teams involved. Choose any number of them.
Labelslabelsobject
Your own keys and values, such as platform and version.
Started atstarted_atdate and time
When the incident began. Defaults to now.

Outputs

incidentobject
The incident
Example output
{
  "incident": {
    "acknowledged_at": "",
    "cancellation_message": "",
    "cancelled_at": "",
    "closed_at": "",
    "created_at": "2026-10-15T09:00:00.000Z",
    "detected_at": "",
    "environments": [],
    "functionalities": [],
    "groups": [],
    "id": "0d9f4f0c-6c1e-4b5e-8f0a-1f3f4a2b9c10",
    "incident_types": [],
    "kind": "normal",
    "labels": {},
    "mitigated_at": "",
    "mitigation_message": "",
    "private": false,
    "public_title": "",
    "resolution_message": "",
    "resolved_at": "",
    "sequential_id": 42,
    "services": [],
    "severity": {},
    "short_url": "https://rootly.com/i/abc123",
    "slack_channel_id": "",
    "slack_channel_name": "",
    "slack_channel_url": "",
    "slug": "checkout-is-returning-500-errors",
    "source": "",
    "started_at": "2026-10-15T09:00:00.000Z",
    "status": "started",
    "summary": "Customers cannot pay.",
    "title": "Checkout is returning 500 errors",
    "updated_at": "2026-10-15T09:00:00.000Z",
    "url": "https://rootly.com/account/incidents/42",
    "user": {}
  }
}

Delete action item

Delete an action item from an incident.

Inputs

Action item IDaction_item_idtextRequired
The action item's id, from 'List action items' or 'Add action item'.

Outputs

action_itemobject
The action item, as it was when deleted
action_item_idtext
The action item deleted
deletedtrue/false
Always true once deleted
Example output
{
  "action_item": {
    "assigned_to": {},
    "created_at": "2026-10-15T09:00:00.000Z",
    "created_by": {},
    "description": "",
    "due_date": "2026-10-30",
    "id": "3a2b1c0d-9e8f-4a7b-8c6d-5e4f3a2b1c0d",
    "kind": "task",
    "priority": "medium",
    "status": "open",
    "summary": "Add an alert for 500 errors",
    "updated_at": "2026-10-15T09:00:00.000Z"
  },
  "action_item_id": "3a2b1c0d-9e8f-4a7b-8c6d-5e4f3a2b1c0d",
  "deleted": true
}

Delete incident

Permanently delete an incident and its timeline. This cannot be undone.

Inputs

Incident IDincident_idtextRequired
The incident's id, from 'List incidents' or 'Declare incident'.

Outputs

deletedtrue/false
Always true once deleted
incidentobject
The incident, as it was when deleted
incident_idtext
The incident deleted
Example output
{
  "deleted": true,
  "incident": {
    "acknowledged_at": "",
    "cancellation_message": "",
    "cancelled_at": "",
    "closed_at": "",
    "created_at": "2026-10-15T09:00:00.000Z",
    "detected_at": "",
    "environments": [],
    "functionalities": [],
    "groups": [],
    "id": "0d9f4f0c-6c1e-4b5e-8f0a-1f3f4a2b9c10",
    "incident_types": [],
    "kind": "normal",
    "labels": {},
    "mitigated_at": "",
    "mitigation_message": "",
    "private": false,
    "public_title": "",
    "resolution_message": "",
    "resolved_at": "",
    "sequential_id": 42,
    "services": [],
    "severity": {},
    "short_url": "https://rootly.com/i/abc123",
    "slack_channel_id": "",
    "slack_channel_name": "",
    "slack_channel_url": "",
    "slug": "checkout-is-returning-500-errors",
    "source": "",
    "started_at": "2026-10-15T09:00:00.000Z",
    "status": "started",
    "summary": "Customers cannot pay.",
    "title": "Checkout is returning 500 errors",
    "updated_at": "2026-10-15T09:00:00.000Z",
    "url": "https://rootly.com/account/incidents/42",
    "user": {}
  },
  "incident_id": "0d9f4f0c-6c1e-4b5e-8f0a-1f3f4a2b9c10"
}

Delete service

Delete a service from your catalog.

Inputs

Serviceservice_idtextRequired
The service. Pick one, or give its id from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
serviceobject
The service, as it was when deleted
service_idtext
The service deleted
Example output
{
  "deleted": true,
  "service": {
    "color": "#1F8A70",
    "created_at": "2026-10-15T09:00:00.000Z",
    "description": "Takes payments.",
    "environment_ids": [],
    "external_id": "",
    "id": "6f5e4d3c-2b1a-4f0e-9d8c-7b6a5f4e3d2c",
    "name": "Checkout API",
    "owner_group_ids": [],
    "slug": "checkout-api",
    "updated_at": "2026-10-15T09:00:00.000Z"
  },
  "service_id": "6f5e4d3c-2b1a-4f0e-9d8c-7b6a5f4e3d2c"
}

Get alert

Get one alert with its status, services, labels and times.

Inputs

Alert IDalert_idtextRequired
The alert's id, from 'List alerts' or 'Raise alert'.

Outputs

alertobject
The alert
Example output
{
  "alert": {
    "acknowledged_at": "",
    "created_at": "2026-10-15T09:00:00.000Z",
    "data": {},
    "deduplication_key": "",
    "description": "",
    "ended_at": "",
    "environments": [],
    "external_id": "",
    "external_url": "",
    "groups": [],
    "id": "9c8b7a6d-5e4f-4d3c-8b2a-1f0e9d8c7b6a",
    "labels": [
      {
        "key": "host",
        "value": "web-1"
      }
    ],
    "noise": "not_noise",
    "resolved_at": "",
    "services": [],
    "short_id": "AB12",
    "source": "api",
    "started_at": "2026-10-15T09:00:00.000Z",
    "status": "open",
    "summary": "CPU above 90% on web-1",
    "updated_at": "2026-10-15T09:00:00.000Z",
    "url": ""
  }
}

Get current user

Get the Rootly user the API key acts as: name, email and time zone.

Inputs

None.

Outputs

userobject
The connected user
Example output
{
  "user": {
    "created_at": "2026-10-15T09:00:00.000Z",
    "email": "jo@example.com",
    "first_name": "Jo",
    "full_name": "Jo Bloggs",
    "id": "4821",
    "last_name": "Bloggs",
    "time_zone": "America/New_York",
    "updated_at": "2026-10-15T09:00:00.000Z"
  }
}

Get incident

Get one incident with its status, severity, services, teams, messages and timestamps.

Inputs

Incident IDincident_idtextRequired
The incident's id, from 'List incidents' or 'Declare incident'.

Outputs

incidentobject
The incident
Example output
{
  "incident": {
    "acknowledged_at": "",
    "cancellation_message": "",
    "cancelled_at": "",
    "closed_at": "",
    "created_at": "2026-10-15T09:00:00.000Z",
    "detected_at": "",
    "environments": [],
    "functionalities": [],
    "groups": [],
    "id": "0d9f4f0c-6c1e-4b5e-8f0a-1f3f4a2b9c10",
    "incident_types": [],
    "kind": "normal",
    "labels": {},
    "mitigated_at": "",
    "mitigation_message": "",
    "private": false,
    "public_title": "",
    "resolution_message": "",
    "resolved_at": "",
    "sequential_id": 42,
    "services": [],
    "severity": {},
    "short_url": "https://rootly.com/i/abc123",
    "slack_channel_id": "",
    "slack_channel_name": "",
    "slack_channel_url": "",
    "slug": "checkout-is-returning-500-errors",
    "source": "",
    "started_at": "2026-10-15T09:00:00.000Z",
    "status": "started",
    "summary": "Customers cannot pay.",
    "title": "Checkout is returning 500 errors",
    "updated_at": "2026-10-15T09:00:00.000Z",
    "url": "https://rootly.com/account/incidents/42",
    "user": {}
  }
}

Get service

Get one service with its owners and environments.

Inputs

Serviceservice_idtextRequired
The service. Pick one, or give its id from an earlier step.

Outputs

serviceobject
The service
Example output
{
  "service": {
    "color": "#1F8A70",
    "created_at": "2026-10-15T09:00:00.000Z",
    "description": "Takes payments.",
    "environment_ids": [],
    "external_id": "",
    "id": "6f5e4d3c-2b1a-4f0e-9d8c-7b6a5f4e3d2c",
    "name": "Checkout API",
    "owner_group_ids": [],
    "slug": "checkout-api",
    "updated_at": "2026-10-15T09:00:00.000Z"
  }
}

List action items

List the action items on an incident. Returns one page.

Inputs

Incident IDincident_idtextRequired
The incident's id, from 'List incidents' or 'Declare incident'.
Pagepagenumber
Which page to return, starting at 1. 'next_page' says the next one.At least 1.
Page sizepage_sizenumber
How many to return per page, 1 to 100.From 1 to 100.

Outputs

action_itemslist
The action items
countnumber
How many on this page
next_pagenumber
Pass as 'page' for the next page; 0 on the last one
pagenumber
The page number this is
total_countnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "action_items": [
    {
      "assigned_to": {},
      "created_at": "2026-10-15T09:00:00.000Z",
      "created_by": {},
      "description": "",
      "due_date": "2026-10-30",
      "id": "3a2b1c0d-9e8f-4a7b-8c6d-5e4f3a2b1c0d",
      "kind": "task",
      "priority": "medium",
      "status": "open",
      "summary": "Add an alert for 500 errors",
      "updated_at": "2026-10-15T09:00:00.000Z"
    }
  ],
  "count": 1,
  "next_page": 0,
  "page": 1,
  "total_count": 1,
  "total_pages": 1
}

List alerts

List alerts, filtered by status or source. Gets one page; to see more, run it again with the next page it gives.

Inputs

Statusstatustext
Only alerts in this status.One of: open, triggered, acknowledged, resolved, deferred.
Sourcesourcetext
Only alerts from this source, such as datadog.
Pagepagenumber
Which page to return, starting at 1. 'next_page' says the next one.At least 1.
Page sizepage_sizenumber
How many to return per page, 1 to 100.From 1 to 100.

Outputs

alertslist
The alerts
countnumber
How many on this page
next_pagenumber
Pass as 'page' for the next page; 0 on the last one
pagenumber
The page number this is
total_countnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "alerts": [
    {
      "acknowledged_at": "",
      "created_at": "2026-10-15T09:00:00.000Z",
      "data": {},
      "deduplication_key": "",
      "description": "",
      "ended_at": "",
      "environments": [],
      "external_id": "",
      "external_url": "",
      "groups": [],
      "id": "9c8b7a6d-5e4f-4d3c-8b2a-1f0e9d8c7b6a",
      "labels": [
        {
          "key": "host",
          "value": "web-1"
        }
      ],
      "noise": "not_noise",
      "resolved_at": "",
      "services": [],
      "short_id": "AB12",
      "source": "api",
      "started_at": "2026-10-15T09:00:00.000Z",
      "status": "open",
      "summary": "CPU above 90% on web-1",
      "updated_at": "2026-10-15T09:00:00.000Z",
      "url": ""
    }
  ],
  "count": 1,
  "next_page": 0,
  "page": 1,
  "total_count": 1,
  "total_pages": 1
}

List environments

List environments such as production and staging.

Inputs

Searchsearchtext
Only those whose name contains this text.
Pagepagenumber
Which page to return, starting at 1. 'next_page' says the next one.At least 1.
Page sizepage_sizenumber
How many to return per page, 1 to 100.From 1 to 100.

Outputs

countnumber
How many on this page
environmentslist
The environments
next_pagenumber
Pass as 'page' for the next page; 0 on the last one
pagenumber
The page number this is
total_countnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "count": 1,
  "environments": [
    {
      "color": "#00AA55",
      "created_at": "2026-10-15T09:00:00.000Z",
      "description": "",
      "id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
      "name": "Production",
      "slug": "production",
      "updated_at": "2026-10-15T09:00:00.000Z"
    }
  ],
  "next_page": 0,
  "page": 1,
  "total_count": 1,
  "total_pages": 1
}

List functionalities

List the functionalities (the capabilities of your product) defined in Rootly.

Inputs

Searchsearchtext
Only those whose name contains this text.
Pagepagenumber
Which page to return, starting at 1. 'next_page' says the next one.At least 1.
Page sizepage_sizenumber
How many to return per page, 1 to 100.From 1 to 100.

Outputs

countnumber
How many on this page
functionalitieslist
The functionalities
next_pagenumber
Pass as 'page' for the next page; 0 on the last one
pagenumber
The page number this is
total_countnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "count": 1,
  "functionalities": [
    {
      "color": "#3366CC",
      "created_at": "2026-10-15T09:00:00.000Z",
      "description": "",
      "environment_ids": [],
      "id": "3c4d5e6f-7a8b-4c9d-8e1f-2a3b4c5d6e7f",
      "name": "Payments",
      "service_ids": [],
      "slug": "payments",
      "updated_at": "2026-10-15T09:00:00.000Z"
    }
  ],
  "next_page": 0,
  "page": 1,
  "total_count": 1,
  "total_pages": 1
}

List incident types

List the types an incident can be tagged with.

Inputs

Pagepagenumber
Which page to return, starting at 1. 'next_page' says the next one.At least 1.
Page sizepage_sizenumber
How many to return per page, 1 to 100.From 1 to 100.

Outputs

countnumber
How many on this page
incident_typeslist
The incident types
next_pagenumber
Pass as 'page' for the next page; 0 on the last one
pagenumber
The page number this is
total_countnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "count": 1,
  "incident_types": [
    {
      "color": "#00AA55",
      "created_at": "2026-10-15T09:00:00.000Z",
      "description": "",
      "id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
      "name": "Production",
      "slug": "production",
      "updated_at": "2026-10-15T09:00:00.000Z"
    }
  ],
  "next_page": 0,
  "page": 1,
  "total_count": 1,
  "total_pages": 1
}

List incidents

List incidents, filtered by text, status, severity, service, team, environment, type or creation date. Gets one page; to see more, run it again with the next page it gives.

Inputs

Searchsearchtext
Only incidents whose title or summary contains this text.
Statusstatustext
Only incidents in this status.One of: in_triage (In triage), started, detected, acknowledged, mitigated, resolved, closed, cancelled, scheduled (Scheduled (maintenance)), in_progress (In progress (maintenance)), completed (Completed (maintenance)).
Kindincident_kindtext
Only incidents of this kind.One of: normal, test, example, backfilled, scheduled, normal_sub (Normal (sub-incident)), test_sub (Test (sub-incident)), example_sub (Example (sub-incident)), scheduled_sub (Scheduled (sub-incident)).
Severityseverity_idtext
Only incidents with this severity.
Serviceservice_idtext
Only incidents that affect this service.
Teamgroup_idtext
Only incidents this team is involved in.
Environmentenvironment_idtext
Only incidents in this environment.
Incident typeincident_type_idtext
Only incidents of this type.
Created on or aftercreated_afterdate
Only incidents created on or after this date (UTC).
Created on or beforecreated_beforedate
Only incidents created on or before this date (UTC).
Ordersorttext
How to order the incidents. Rootly's default is newest first.One of: -created_at (Newest first), created_at (Oldest first), -updated_at (Recently updated first), updated_at (Least recently updated first), -started_at (Latest start first), started_at (Earliest start first), -resolved_at (Latest resolved first), resolved_at (Earliest resolved first).
Pagepagenumber
Which page to return, starting at 1. 'next_page' says the next one.At least 1.
Page sizepage_sizenumber
How many to return per page, 1 to 100.From 1 to 100.

Outputs

countnumber
How many on this page
incidentslist
The incidents
next_pagenumber
Pass as 'page' for the next page; 0 on the last one
pagenumber
The page number this is
total_countnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "count": 1,
  "incidents": [
    {
      "acknowledged_at": "",
      "cancellation_message": "",
      "cancelled_at": "",
      "closed_at": "",
      "created_at": "2026-10-15T09:00:00.000Z",
      "detected_at": "",
      "environments": [],
      "functionalities": [],
      "groups": [],
      "id": "0d9f4f0c-6c1e-4b5e-8f0a-1f3f4a2b9c10",
      "incident_types": [],
      "kind": "normal",
      "labels": {},
      "mitigated_at": "",
      "mitigation_message": "",
      "private": false,
      "public_title": "",
      "resolution_message": "",
      "resolved_at": "",
      "sequential_id": 42,
      "services": [],
      "severity": {},
      "short_url": "https://rootly.com/i/abc123",
      "slack_channel_id": "",
      "slack_channel_name": "",
      "slack_channel_url": "",
      "slug": "checkout-is-returning-500-errors",
      "source": "",
      "started_at": "2026-10-15T09:00:00.000Z",
      "status": "started",
      "summary": "Customers cannot pay.",
      "title": "Checkout is returning 500 errors",
      "updated_at": "2026-10-15T09:00:00.000Z",
      "url": "https://rootly.com/account/incidents/42",
      "user": {}
    }
  ],
  "next_page": 0,
  "page": 1,
  "total_count": 1,
  "total_pages": 1
}

List services

List the services in your catalog. Returns one page.

Inputs

Searchsearchtext
Only those whose name contains this text.
Pagepagenumber
Which page to return, starting at 1. 'next_page' says the next one.At least 1.
Page sizepage_sizenumber
How many to return per page, 1 to 100.From 1 to 100.

Outputs

countnumber
How many on this page
next_pagenumber
Pass as 'page' for the next page; 0 on the last one
pagenumber
The page number this is
serviceslist
The services
total_countnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "count": 1,
  "next_page": 0,
  "page": 1,
  "services": [
    {
      "color": "#1F8A70",
      "created_at": "2026-10-15T09:00:00.000Z",
      "description": "Takes payments.",
      "environment_ids": [],
      "external_id": "",
      "id": "6f5e4d3c-2b1a-4f0e-9d8c-7b6a5f4e3d2c",
      "name": "Checkout API",
      "owner_group_ids": [],
      "slug": "checkout-api",
      "updated_at": "2026-10-15T09:00:00.000Z"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

List severities

List the severities an incident can be given.

Inputs

Searchsearchtext
Only those whose name contains this text.
Pagepagenumber
Which page to return, starting at 1. 'next_page' says the next one.At least 1.
Page sizepage_sizenumber
How many to return per page, 1 to 100.From 1 to 100.

Outputs

countnumber
How many on this page
next_pagenumber
Pass as 'page' for the next page; 0 on the last one
pagenumber
The page number this is
severitieslist
The severities
total_countnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "count": 1,
  "next_page": 0,
  "page": 1,
  "severities": [
    {
      "color": "#FF0000",
      "created_at": "2026-10-15T09:00:00.000Z",
      "description": "Critical impact",
      "id": "5b0b1b0e-8f1c-4f2e-9a1d-2f4f0f6a7c11",
      "name": "SEV1",
      "position": 1,
      "severity": "critical",
      "slug": "sev1",
      "updated_at": "2026-10-15T09:00:00.000Z"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

List teams

List the teams in your organisation. Returns one page.

Inputs

Searchsearchtext
Only those whose name contains this text.
Pagepagenumber
Which page to return, starting at 1. 'next_page' says the next one.At least 1.
Page sizepage_sizenumber
How many to return per page, 1 to 100.From 1 to 100.

Outputs

countnumber
How many on this page
next_pagenumber
Pass as 'page' for the next page; 0 on the last one
pagenumber
The page number this is
teamslist
The teams
total_countnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "count": 1,
  "next_page": 0,
  "page": 1,
  "teams": [
    {
      "admin_ids": [
        4821
      ],
      "color": "#6D55BD",
      "created_at": "2026-10-15T09:00:00.000Z",
      "description": "Runs the platform.",
      "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "name": "Platform",
      "slug": "platform",
      "updated_at": "2026-10-15T09:00:00.000Z",
      "user_ids": [
        4821
      ]
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

List timeline notes

List the notes on an incident's timeline. Returns one page.

Inputs

Incident IDincident_idtextRequired
The incident's id, from 'List incidents' or 'Declare incident'.
Pagepagenumber
Which page to return, starting at 1. 'next_page' says the next one.At least 1.
Page sizepage_sizenumber
How many to return per page, 1 to 100.From 1 to 100.

Outputs

countnumber
How many on this page
eventslist
The timeline notes
next_pagenumber
Pass as 'page' for the next page; 0 on the last one
pagenumber
The page number this is
total_countnumber
How many there are in all
total_pagesnumber
How many pages there are
Example output
{
  "count": 1,
  "events": [
    {
      "created_at": "2026-10-15T09:00:00.000Z",
      "event": "Rolled back the 14:02 deploy.",
      "id": "7e1d2c3b-4a5f-4e6d-8c7b-9a0f1e2d3c4b",
      "occurred_at": "2026-10-15T09:00:00.000Z",
      "updated_at": "2026-10-15T09:00:00.000Z",
      "visibility": "internal"
    }
  ],
  "next_page": 0,
  "page": 1,
  "total_count": 1,
  "total_pages": 1
}

List users

List the people in your Rootly organisation, optionally narrowed by name or email. Returns one page.

Inputs

Searchsearchtext
Only those whose name contains this text.
Emailemailtext
Only the user with this email address.
Pagepagenumber
Which page to return, starting at 1. 'next_page' says the next one.At least 1.
Page sizepage_sizenumber
How many to return per page, 1 to 100.From 1 to 100.

Outputs

countnumber
How many on this page
next_pagenumber
Pass as 'page' for the next page; 0 on the last one
pagenumber
The page number this is
total_countnumber
How many there are in all
total_pagesnumber
How many pages there are
userslist
The users
Example output
{
  "count": 1,
  "next_page": 0,
  "page": 1,
  "total_count": 1,
  "total_pages": 1,
  "users": [
    {
      "created_at": "2026-10-15T09:00:00.000Z",
      "email": "jo@example.com",
      "first_name": "Jo",
      "full_name": "Jo Bloggs",
      "id": "4821",
      "last_name": "Bloggs",
      "time_zone": "America/New_York",
      "updated_at": "2026-10-15T09:00:00.000Z"
    }
  ]
}

Mitigate incident

Mark an incident mitigated: customers are no longer affected but the cause may remain. Optionally say how.

Inputs

Incident IDincident_idtextRequired
The incident's id, from 'List incidents' or 'Declare incident'.
How it was mitigatedmessagetext
A line on what was done, shown on the incident.

Outputs

incidentobject
The incident
Example output
{
  "incident": {
    "acknowledged_at": "",
    "cancellation_message": "",
    "cancelled_at": "",
    "closed_at": "",
    "created_at": "2026-10-15T09:00:00.000Z",
    "detected_at": "",
    "environments": [],
    "functionalities": [],
    "groups": [],
    "id": "0d9f4f0c-6c1e-4b5e-8f0a-1f3f4a2b9c10",
    "incident_types": [],
    "kind": "normal",
    "labels": {},
    "mitigated_at": "",
    "mitigation_message": "",
    "private": false,
    "public_title": "",
    "resolution_message": "",
    "resolved_at": "",
    "sequential_id": 42,
    "services": [],
    "severity": {},
    "short_url": "https://rootly.com/i/abc123",
    "slack_channel_id": "",
    "slack_channel_name": "",
    "slack_channel_url": "",
    "slug": "checkout-is-returning-500-errors",
    "source": "",
    "started_at": "2026-10-15T09:00:00.000Z",
    "status": "mitigated",
    "summary": "Customers cannot pay.",
    "title": "Checkout is returning 500 errors",
    "updated_at": "2026-10-15T09:00:00.000Z",
    "url": "https://rootly.com/account/incidents/42",
    "user": {}
  }
}

Raise alert

Raise an alert in Rootly from a workflow, for the services, environments and teams it concerns.

Inputs

SummarysummarytextRequired
What the alert says, in a line.
Descriptiondescriptiontext
More detail about the alert.
Noisenoisetext
Mark the alert as noise, or as a real alert.One of: noise, not_noise (Not noise).
Servicesservice_idslist
The services affected. Choose any number of them.
Environmentsenvironment_idslist
The environments affected, such as production. Choose any number.
Teamsteam_idslist
The teams involved. Choose any number of them.
Deduplication keydeduplication_keytext
Alerts that share this key are grouped as one.
External IDexternal_idtext
The alert's id in the system it came from.
External linkexternal_urltext
A link to the alert in the system it came from.
Labelslabelsobject
Your own keys and values, such as platform and version.
Started atstarted_atdate and time
When the problem began. Defaults to now.

Outputs

alertobject
The alert
Example output
{
  "alert": {
    "acknowledged_at": "",
    "created_at": "2026-10-15T09:00:00.000Z",
    "data": {},
    "deduplication_key": "",
    "description": "",
    "ended_at": "",
    "environments": [],
    "external_id": "",
    "external_url": "",
    "groups": [],
    "id": "9c8b7a6d-5e4f-4d3c-8b2a-1f0e9d8c7b6a",
    "labels": [
      {
        "key": "host",
        "value": "web-1"
      }
    ],
    "noise": "not_noise",
    "resolved_at": "",
    "services": [],
    "short_id": "AB12",
    "source": "api",
    "started_at": "2026-10-15T09:00:00.000Z",
    "status": "open",
    "summary": "CPU above 90% on web-1",
    "updated_at": "2026-10-15T09:00:00.000Z",
    "url": ""
  }
}

Resolve incident

Mark an incident resolved: the problem is fixed. Optionally say how.

Inputs

Incident IDincident_idtextRequired
The incident's id, from 'List incidents' or 'Declare incident'.
How it was resolvedmessagetext
A line on the fix, shown on the incident.

Outputs

incidentobject
The incident
Example output
{
  "incident": {
    "acknowledged_at": "",
    "cancellation_message": "",
    "cancelled_at": "",
    "closed_at": "",
    "created_at": "2026-10-15T09:00:00.000Z",
    "detected_at": "",
    "environments": [],
    "functionalities": [],
    "groups": [],
    "id": "0d9f4f0c-6c1e-4b5e-8f0a-1f3f4a2b9c10",
    "incident_types": [],
    "kind": "normal",
    "labels": {},
    "mitigated_at": "",
    "mitigation_message": "",
    "private": false,
    "public_title": "",
    "resolution_message": "",
    "resolved_at": "",
    "sequential_id": 42,
    "services": [],
    "severity": {},
    "short_url": "https://rootly.com/i/abc123",
    "slack_channel_id": "",
    "slack_channel_name": "",
    "slack_channel_url": "",
    "slug": "checkout-is-returning-500-errors",
    "source": "",
    "started_at": "2026-10-15T09:00:00.000Z",
    "status": "resolved",
    "summary": "Customers cannot pay.",
    "title": "Checkout is returning 500 errors",
    "updated_at": "2026-10-15T09:00:00.000Z",
    "url": "https://rootly.com/account/incidents/42",
    "user": {}
  }
}

Update action item

Change an action item's summary, status, priority, owner or due date. Only the fields you fill in are changed.

Inputs

Action item IDaction_item_idtextRequired
The action item's id, from 'List action items' or 'Add action item'.
Summarysummarytext
A new summary. Leave empty to keep it.
Descriptiondescriptiontext
More detail on what needs doing.
Kinditem_kindtext
A task, or a follow-up for after the incident.One of: task, follow_up (Follow-up).
Priorityprioritytext
How urgent it is.One of: high, medium, low.
Statusstatustext
Where it stands. Rootly starts new ones as open.One of: open, in_progress (In progress), done, cancelled.
Assign toassignee_idtext
The person responsible. Pick one, or give their user id.
Due datedue_datedate
When it should be done.

Outputs

action_itemobject
The action item
Example output
{
  "action_item": {
    "assigned_to": {},
    "created_at": "2026-10-15T09:00:00.000Z",
    "created_by": {},
    "description": "",
    "due_date": "2026-10-30",
    "id": "3a2b1c0d-9e8f-4a7b-8c6d-5e4f3a2b1c0d",
    "kind": "task",
    "priority": "medium",
    "status": "done",
    "summary": "Add an alert for 500 errors",
    "updated_at": "2026-10-15T09:00:00.000Z"
  }
}

Update alert

Change an alert's summary, description, noise flag, services, environments, teams or labels. Only the fields you fill in are changed.

Inputs

Alert IDalert_idtextRequired
The alert's id, from 'List alerts' or 'Raise alert'.
Summarysummarytext
A new summary. Leave empty to keep it.
Descriptiondescriptiontext
More detail about the alert.
Noisenoisetext
Mark the alert as noise, or as a real alert.One of: noise, not_noise (Not noise).
Servicesservice_idslist
The services affected. Choose any number of them.
Environmentsenvironment_idslist
The environments affected, such as production. Choose any number.
Teamsteam_idslist
The teams involved. Choose any number of them.
Deduplication keydeduplication_keytext
Alerts that share this key are grouped as one.
External IDexternal_idtext
The alert's id in the system it came from.
External linkexternal_urltext
A link to the alert in the system it came from.
Labelslabelsobject
Your own keys and values, such as platform and version.

Outputs

alertobject
The alert
Example output
{
  "alert": {
    "acknowledged_at": "",
    "created_at": "2026-10-15T09:00:00.000Z",
    "data": {},
    "deduplication_key": "",
    "description": "",
    "ended_at": "",
    "environments": [],
    "external_id": "",
    "external_url": "",
    "groups": [],
    "id": "9c8b7a6d-5e4f-4d3c-8b2a-1f0e9d8c7b6a",
    "labels": [
      {
        "key": "host",
        "value": "web-1"
      }
    ],
    "noise": "not_noise",
    "resolved_at": "",
    "services": [],
    "short_id": "AB12",
    "source": "api",
    "started_at": "2026-10-15T09:00:00.000Z",
    "status": "open",
    "summary": "Updated summary",
    "updated_at": "2026-10-15T09:00:00.000Z",
    "url": ""
  }
}

Update incident

Change an incident's title, summary, status, severity, services, environments, types, teams or labels. Only the fields you fill in are changed.

Inputs

Incident IDincident_idtextRequired
The incident's id, from 'List incidents' or 'Declare incident'.
Titletitletext
A new title. Leave empty to keep it.
Summarysummarytext
A new summary. Leave empty to keep it.
Public titlepublic_titletext
A new status page title. Leave empty to keep it.
Severityseverity_idtext
How serious the incident is. Pick one, or give its id.
Statusstatustext
Move the incident to this status. Leave empty to keep it.One of: in_triage (In triage), started, detected, acknowledged, mitigated, resolved, closed, cancelled, scheduled (Scheduled (maintenance)), in_progress (In progress (maintenance)), completed (Completed (maintenance)).
Kindincident_kindtext
Change the kind. Leave empty to keep it.One of: normal, test, example, backfilled.
Privateprivatetrue/false
Make the incident private. It cannot be made public again.
Servicesservice_idslist
The services affected. Choose any number of them.
Environmentsenvironment_idslist
The environments affected, such as production. Choose any number.
Incident typesincident_type_idslist
The types to tag the incident with. Choose any number of them.
Teamsteam_idslist
The teams involved. Choose any number of them.
Labelslabelsobject
Your own keys and values, such as platform and version.
How it was mitigatedmitigation_messagetext
Shown when the incident is mitigated.
How it was resolvedresolution_messagetext
Shown when the incident is resolved.
Why it was cancelledcancellation_messagetext
Shown when the incident is cancelled.

Outputs

incidentobject
The incident
Example output
{
  "incident": {
    "acknowledged_at": "",
    "cancellation_message": "",
    "cancelled_at": "",
    "closed_at": "",
    "created_at": "2026-10-15T09:00:00.000Z",
    "detected_at": "",
    "environments": [],
    "functionalities": [],
    "groups": [],
    "id": "0d9f4f0c-6c1e-4b5e-8f0a-1f3f4a2b9c10",
    "incident_types": [],
    "kind": "normal",
    "labels": {},
    "mitigated_at": "",
    "mitigation_message": "",
    "private": false,
    "public_title": "",
    "resolution_message": "",
    "resolved_at": "",
    "sequential_id": 42,
    "services": [],
    "severity": {},
    "short_url": "https://rootly.com/i/abc123",
    "slack_channel_id": "",
    "slack_channel_name": "",
    "slack_channel_url": "",
    "slug": "checkout-is-returning-500-errors",
    "source": "",
    "started_at": "2026-10-15T09:00:00.000Z",
    "status": "started",
    "summary": "Customers cannot pay.",
    "title": "Updated title",
    "updated_at": "2026-10-15T09:00:00.000Z",
    "url": "https://rootly.com/account/incidents/42",
    "user": {}
  }
}

Update service

Change a service's name, description, color, environments or owner teams. Only the fields you fill in are changed.

Inputs

Serviceservice_idtextRequired
The service. Pick one, or give its id from an earlier step.
Namenametext
A new name. Leave empty to keep it.
Descriptiondescriptiontext
What the service does.
Colorcolortext
A hex color for the service, like #1F8A70.
Environmentsenvironment_idslist
The environments the service runs in. Choose any number.
Owner teamsowner_team_idslist
The teams that own the service. Choose any number of them.
External IDexternal_idtext
The service's id in another system, such as a service catalog.

Outputs

serviceobject
The service
Example output
{
  "service": {
    "color": "#1F8A70",
    "created_at": "2026-10-15T09:00:00.000Z",
    "description": "Takes payments.",
    "environment_ids": [],
    "external_id": "",
    "id": "6f5e4d3c-2b1a-4f0e-9d8c-7b6a5f4e3d2c",
    "name": "Checkout API v2",
    "owner_group_ids": [],
    "slug": "checkout-api",
    "updated_at": "2026-10-15T09:00:00.000Z"
  }
}

On this page