# Rootly

> 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.

App · 29 actions. Web page: https://docs.lodol.com/docs/integrations/rootly

## Actions

### Add action item

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

**Inputs**

- Incident ID (`incident_id`, text, required): The incident's id, from 'List incidents' or 'Declare incident'.
- Summary (`summary`, text, required): What needs doing, in a line.
- Description (`description`, text): More detail on what needs doing.
- Kind (`item_kind`, text): A task, or a follow-up for after the incident. One of: `task`, `follow_up` (Follow-up).
- Priority (`priority`, text): How urgent it is. One of: `high`, `medium`, `low`.
- Status (`status`, text): Where it stands. Rootly starts new ones as open. One of: `open`, `in_progress` (In progress), `done`, `cancelled`.
- Assign to (`assignee_id`, text): The person responsible. Pick one, or give their user id.
- Due date (`due_date`, date): When it should be done.

**Outputs**

- `action_item` (object): The action item

**Example output**

```json
{
  "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 ID (`incident_id`, text, required): The incident's id, from 'List incidents' or 'Declare incident'.
- Note (`event`, text, required): What happened.
- Who can see it (`visibility`, text): Defaults to responders only. One of: `internal` (Internal (responders only)), `external` (External (shown on status pages)).

**Outputs**

- `event` (object): The timeline note

**Example output**

```json
{
  "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**

- Name (`name`, text, required): The service's name.
- Description (`description`, text): What the service does.
- Color (`color`, text): A hex color for the service, like #1F8A70.
- Environments (`environment_ids`, list): The environments the service runs in. Choose any number.
- Owner teams (`owner_team_ids`, list): The teams that own the service. Choose any number of them.
- External ID (`external_id`, text): The service's id in another system, such as a service catalog.

**Outputs**

- `service` (object): The service

**Example output**

```json
{
  "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**

- Title (`title`, text, required): What happened, in a line.
- Summary (`summary`, text): More detail for the responders.
- Public title (`public_title`, text): The title shown on status pages, if different from the title.
- Severity (`severity_id`, text): How serious the incident is. Pick one, or give its id.
- Status (`status`, text): 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)).
- Kind (`incident_kind`, text): Use Test or Example to keep it out of your real incident reports. One of: `normal`, `test`, `example`, `backfilled`.
- Private (`private`, true/false): Hide the incident from people who are not responders. It cannot be made public again.
- Services (`service_ids`, list): The services affected. Choose any number of them.
- Environments (`environment_ids`, list): The environments affected, such as production. Choose any number.
- Incident types (`incident_type_ids`, list): The types to tag the incident with. Choose any number of them.
- Teams (`team_ids`, list): The teams involved. Choose any number of them.
- Labels (`labels`, object): Your own keys and values, such as platform and version.
- Started at (`started_at`, date and time): When the incident began. Defaults to now.

**Outputs**

- `incident` (object): The incident

**Example output**

```json
{
  "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 ID (`action_item_id`, text, required): The action item's id, from 'List action items' or 'Add action item'.

**Outputs**

- `action_item` (object): The action item, as it was when deleted
- `action_item_id` (text): The action item deleted
- `deleted` (true/false): Always true once deleted

**Example output**

```json
{
  "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 ID (`incident_id`, text, required): The incident's id, from 'List incidents' or 'Declare incident'.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `incident` (object): The incident, as it was when deleted
- `incident_id` (text): The incident deleted

**Example output**

```json
{
  "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**

- Service (`service_id`, text, required): The service. Pick one, or give its id from an earlier step.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `service` (object): The service, as it was when deleted
- `service_id` (text): The service deleted

**Example output**

```json
{
  "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 ID (`alert_id`, text, required): The alert's id, from 'List alerts' or 'Raise alert'.

**Outputs**

- `alert` (object): The alert

**Example output**

```json
{
  "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**

- `user` (object): The connected user

**Example output**

```json
{
  "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 ID (`incident_id`, text, required): The incident's id, from 'List incidents' or 'Declare incident'.

**Outputs**

- `incident` (object): The incident

**Example output**

```json
{
  "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**

- Service (`service_id`, text, required): The service. Pick one, or give its id from an earlier step.

**Outputs**

- `service` (object): The service

**Example output**

```json
{
  "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 ID (`incident_id`, text, required): The incident's id, from 'List incidents' or 'Declare incident'.
- Page (`page`, number): Which page to return, starting at 1. 'next_page' says the next one. At least 1.
- Page size (`page_size`, number): How many to return per page, 1 to 100. From 1 to 100.

**Outputs**

- `action_items` (list): The action items
- `count` (number): How many on this page
- `next_page` (number): Pass as 'page' for the next page; 0 on the last one
- `page` (number): The page number this is
- `total_count` (number): How many there are in all
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "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**

- Status (`status`, text): Only alerts in this status. One of: `open`, `triggered`, `acknowledged`, `resolved`, `deferred`.
- Source (`source`, text): Only alerts from this source, such as datadog.
- Page (`page`, number): Which page to return, starting at 1. 'next_page' says the next one. At least 1.
- Page size (`page_size`, number): How many to return per page, 1 to 100. From 1 to 100.

**Outputs**

- `alerts` (list): The alerts
- `count` (number): How many on this page
- `next_page` (number): Pass as 'page' for the next page; 0 on the last one
- `page` (number): The page number this is
- `total_count` (number): How many there are in all
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "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**

- Search (`search`, text): Only those whose name contains this text.
- Page (`page`, number): Which page to return, starting at 1. 'next_page' says the next one. At least 1.
- Page size (`page_size`, number): How many to return per page, 1 to 100. From 1 to 100.

**Outputs**

- `count` (number): How many on this page
- `environments` (list): The environments
- `next_page` (number): Pass as 'page' for the next page; 0 on the last one
- `page` (number): The page number this is
- `total_count` (number): How many there are in all
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "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**

- Search (`search`, text): Only those whose name contains this text.
- Page (`page`, number): Which page to return, starting at 1. 'next_page' says the next one. At least 1.
- Page size (`page_size`, number): How many to return per page, 1 to 100. From 1 to 100.

**Outputs**

- `count` (number): How many on this page
- `functionalities` (list): The functionalities
- `next_page` (number): Pass as 'page' for the next page; 0 on the last one
- `page` (number): The page number this is
- `total_count` (number): How many there are in all
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "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**

- Page (`page`, number): Which page to return, starting at 1. 'next_page' says the next one. At least 1.
- Page size (`page_size`, number): How many to return per page, 1 to 100. From 1 to 100.

**Outputs**

- `count` (number): How many on this page
- `incident_types` (list): The incident types
- `next_page` (number): Pass as 'page' for the next page; 0 on the last one
- `page` (number): The page number this is
- `total_count` (number): How many there are in all
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "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**

- Search (`search`, text): Only incidents whose title or summary contains this text.
- Status (`status`, text): 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)).
- Kind (`incident_kind`, text): 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)).
- Severity (`severity_id`, text): Only incidents with this severity.
- Service (`service_id`, text): Only incidents that affect this service.
- Team (`group_id`, text): Only incidents this team is involved in.
- Environment (`environment_id`, text): Only incidents in this environment.
- Incident type (`incident_type_id`, text): Only incidents of this type.
- Created on or after (`created_after`, date): Only incidents created on or after this date (UTC).
- Created on or before (`created_before`, date): Only incidents created on or before this date (UTC).
- Order (`sort`, text): 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).
- Page (`page`, number): Which page to return, starting at 1. 'next_page' says the next one. At least 1.
- Page size (`page_size`, number): How many to return per page, 1 to 100. From 1 to 100.

**Outputs**

- `count` (number): How many on this page
- `incidents` (list): The incidents
- `next_page` (number): Pass as 'page' for the next page; 0 on the last one
- `page` (number): The page number this is
- `total_count` (number): How many there are in all
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "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**

- Search (`search`, text): Only those whose name contains this text.
- Page (`page`, number): Which page to return, starting at 1. 'next_page' says the next one. At least 1.
- Page size (`page_size`, number): How many to return per page, 1 to 100. From 1 to 100.

**Outputs**

- `count` (number): How many on this page
- `next_page` (number): Pass as 'page' for the next page; 0 on the last one
- `page` (number): The page number this is
- `services` (list): The services
- `total_count` (number): How many there are in all
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "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**

- Search (`search`, text): Only those whose name contains this text.
- Page (`page`, number): Which page to return, starting at 1. 'next_page' says the next one. At least 1.
- Page size (`page_size`, number): How many to return per page, 1 to 100. From 1 to 100.

**Outputs**

- `count` (number): How many on this page
- `next_page` (number): Pass as 'page' for the next page; 0 on the last one
- `page` (number): The page number this is
- `severities` (list): The severities
- `total_count` (number): How many there are in all
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "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**

- Search (`search`, text): Only those whose name contains this text.
- Page (`page`, number): Which page to return, starting at 1. 'next_page' says the next one. At least 1.
- Page size (`page_size`, number): How many to return per page, 1 to 100. From 1 to 100.

**Outputs**

- `count` (number): How many on this page
- `next_page` (number): Pass as 'page' for the next page; 0 on the last one
- `page` (number): The page number this is
- `teams` (list): The teams
- `total_count` (number): How many there are in all
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "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 ID (`incident_id`, text, required): The incident's id, from 'List incidents' or 'Declare incident'.
- Page (`page`, number): Which page to return, starting at 1. 'next_page' says the next one. At least 1.
- Page size (`page_size`, number): How many to return per page, 1 to 100. From 1 to 100.

**Outputs**

- `count` (number): How many on this page
- `events` (list): The timeline notes
- `next_page` (number): Pass as 'page' for the next page; 0 on the last one
- `page` (number): The page number this is
- `total_count` (number): How many there are in all
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "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**

- Search (`search`, text): Only those whose name contains this text.
- Email (`email`, text): Only the user with this email address.
- Page (`page`, number): Which page to return, starting at 1. 'next_page' says the next one. At least 1.
- Page size (`page_size`, number): How many to return per page, 1 to 100. From 1 to 100.

**Outputs**

- `count` (number): How many on this page
- `next_page` (number): Pass as 'page' for the next page; 0 on the last one
- `page` (number): The page number this is
- `total_count` (number): How many there are in all
- `total_pages` (number): How many pages there are
- `users` (list): The users

**Example output**

```json
{
  "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 ID (`incident_id`, text, required): The incident's id, from 'List incidents' or 'Declare incident'.
- How it was mitigated (`message`, text): A line on what was done, shown on the incident.

**Outputs**

- `incident` (object): The incident

**Example output**

```json
{
  "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**

- Summary (`summary`, text, required): What the alert says, in a line.
- Description (`description`, text): More detail about the alert.
- Noise (`noise`, text): Mark the alert as noise, or as a real alert. One of: `noise`, `not_noise` (Not noise).
- Services (`service_ids`, list): The services affected. Choose any number of them.
- Environments (`environment_ids`, list): The environments affected, such as production. Choose any number.
- Teams (`team_ids`, list): The teams involved. Choose any number of them.
- Deduplication key (`deduplication_key`, text): Alerts that share this key are grouped as one.
- External ID (`external_id`, text): The alert's id in the system it came from.
- External link (`external_url`, text): A link to the alert in the system it came from.
- Labels (`labels`, object): Your own keys and values, such as platform and version.
- Started at (`started_at`, date and time): When the problem began. Defaults to now.

**Outputs**

- `alert` (object): The alert

**Example output**

```json
{
  "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 ID (`incident_id`, text, required): The incident's id, from 'List incidents' or 'Declare incident'.
- How it was resolved (`message`, text): A line on the fix, shown on the incident.

**Outputs**

- `incident` (object): The incident

**Example output**

```json
{
  "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 ID (`action_item_id`, text, required): The action item's id, from 'List action items' or 'Add action item'.
- Summary (`summary`, text): A new summary. Leave empty to keep it.
- Description (`description`, text): More detail on what needs doing.
- Kind (`item_kind`, text): A task, or a follow-up for after the incident. One of: `task`, `follow_up` (Follow-up).
- Priority (`priority`, text): How urgent it is. One of: `high`, `medium`, `low`.
- Status (`status`, text): Where it stands. Rootly starts new ones as open. One of: `open`, `in_progress` (In progress), `done`, `cancelled`.
- Assign to (`assignee_id`, text): The person responsible. Pick one, or give their user id.
- Due date (`due_date`, date): When it should be done.

**Outputs**

- `action_item` (object): The action item

**Example output**

```json
{
  "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 ID (`alert_id`, text, required): The alert's id, from 'List alerts' or 'Raise alert'.
- Summary (`summary`, text): A new summary. Leave empty to keep it.
- Description (`description`, text): More detail about the alert.
- Noise (`noise`, text): Mark the alert as noise, or as a real alert. One of: `noise`, `not_noise` (Not noise).
- Services (`service_ids`, list): The services affected. Choose any number of them.
- Environments (`environment_ids`, list): The environments affected, such as production. Choose any number.
- Teams (`team_ids`, list): The teams involved. Choose any number of them.
- Deduplication key (`deduplication_key`, text): Alerts that share this key are grouped as one.
- External ID (`external_id`, text): The alert's id in the system it came from.
- External link (`external_url`, text): A link to the alert in the system it came from.
- Labels (`labels`, object): Your own keys and values, such as platform and version.

**Outputs**

- `alert` (object): The alert

**Example output**

```json
{
  "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 ID (`incident_id`, text, required): The incident's id, from 'List incidents' or 'Declare incident'.
- Title (`title`, text): A new title. Leave empty to keep it.
- Summary (`summary`, text): A new summary. Leave empty to keep it.
- Public title (`public_title`, text): A new status page title. Leave empty to keep it.
- Severity (`severity_id`, text): How serious the incident is. Pick one, or give its id.
- Status (`status`, text): 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)).
- Kind (`incident_kind`, text): Change the kind. Leave empty to keep it. One of: `normal`, `test`, `example`, `backfilled`.
- Private (`private`, true/false): Make the incident private. It cannot be made public again.
- Services (`service_ids`, list): The services affected. Choose any number of them.
- Environments (`environment_ids`, list): The environments affected, such as production. Choose any number.
- Incident types (`incident_type_ids`, list): The types to tag the incident with. Choose any number of them.
- Teams (`team_ids`, list): The teams involved. Choose any number of them.
- Labels (`labels`, object): Your own keys and values, such as platform and version.
- How it was mitigated (`mitigation_message`, text): Shown when the incident is mitigated.
- How it was resolved (`resolution_message`, text): Shown when the incident is resolved.
- Why it was cancelled (`cancellation_message`, text): Shown when the incident is cancelled.

**Outputs**

- `incident` (object): The incident

**Example output**

```json
{
  "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**

- Service (`service_id`, text, required): The service. Pick one, or give its id from an earlier step.
- Name (`name`, text): A new name. Leave empty to keep it.
- Description (`description`, text): What the service does.
- Color (`color`, text): A hex color for the service, like #1F8A70.
- Environments (`environment_ids`, list): The environments the service runs in. Choose any number.
- Owner teams (`owner_team_ids`, list): The teams that own the service. Choose any number of them.
- External ID (`external_id`, text): The service's id in another system, such as a service catalog.

**Outputs**

- `service` (object): The service

**Example output**

```json
{
  "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"
  }
}
```
