POST
/
v1
/
incidents
curl --request POST \
  --url https://api.rootly.com/v1/incidents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
  "data": {
    "type": "incidents",
    "attributes": {
      "title": "<string>",
      "kind": "normal",
      "parent_incident_id": "<string>",
      "duplicate_incident_id": "<string>",
      "private": false,
      "summary": "<string>",
      "user_id": "<string>",
      "severity_id": "<string>",
      "environment_ids": [
        "<string>"
      ],
      "incident_type_ids": [
        "<string>"
      ],
      "service_ids": [
        "<string>"
      ],
      "functionality_ids": [
        "<string>"
      ],
      "group_ids": [
        "<string>"
      ],
      "cause_ids": [
        "<string>"
      ],
      "labels": {},
      "slack_channel_name": "<string>",
      "notify_emails": [
        "<string>"
      ],
      "status": "in_triage",
      "url": "<string>",
      "scheduled_for": "<string>",
      "scheduled_until": "<string>",
      "in_triage_at": "<string>",
      "started_at": "<string>",
      "detected_at": "<string>",
      "acknowledged_at": "<string>",
      "mitigated_at": "<string>",
      "resolved_at": "<string>",
      "cancelled_at": "<string>"
    }
  }
}'
{
  "data": {
    "id": "15c1d0ef-7728-4546-a600-4a04e3b57f2f",
    "type": "incidents",
    "attributes": {
      "parent_incident_id": null,
      "sequential_id": 11,
      "title": "Oh no! Something is broken",
      "slug": "oh-no-something-is-broken",
      "kind": "normal",
      "private": false,
      "summary": "this is the description and there are new lines\n\nthis is the next line\n\nthis is the 3rd line",
      "status": "started",
      "source": "api",
      "url": "http://localhost:3001/account/incidents/11-oh-no-something-is-broken",
      "short_url": null,
      "user": {
        "data": {
          "id": "289",
          "type": "users",
          "attributes": {
            "name": "Mitchell Zboncak",
            "email": "normand.hansen@roberts.example",
            "phone": null,
            "phone_2": null,
            "first_name": "Mitchell",
            "last_name": "Zboncak",
            "full_name": "Mitchell Zboncak",
            "full_name_with_team": "[White Inc] Mitchell Zboncak",
            "slack_id": null,
            "time_zone": "UTC",
            "updated_at": "2025-05-29T17:46:04.010-07:00",
            "created_at": "2025-05-29T17:45:47.374-07:00"
          },
          "relationships": {
            "email_addresses": {
              "data": [
                {
                  "id": "4317a9a0-150f-4116-888b-bccb3a3d42bf",
                  "type": "user_email_addresses"
                }
              ]
            },
            "phone_numbers": {
              "data": []
            },
            "devices": {
              "data": []
            },
            "role": {
              "data": {
                "id": "fcbcda9c-7af4-4162-a159-ecbcd32d56e5",
                "created_at": "2025-05-29T17:45:47.563-07:00",
                "updated_at": "2025-05-29T17:45:47.563-07:00",
                "display_order": 2,
                "api_keys_permissions": [
                  "create",
                  "update",
                  "read",
                  "delete"
                ],
                "billing_permissions": [],
                "environments_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "functionalities_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "groups_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incident_causes_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incident_roles_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incident_types_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incidents_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "private_incidents_permissions": [],
                "invitations_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "playbooks_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "retrospective_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "roles_permissions": [],
                "services_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "severities_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "status_pages_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "workflows_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "team_id": 235,
                "name": "user",
                "slug": "user",
                "is_editable": true,
                "is_deletable": false,
                "incident_feedbacks_permissions": [
                  "read",
                  "create",
                  "update"
                ],
                "form_fields_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "webhooks_permissions": [],
                "audits_permissions": [],
                "secrets_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "deleted_at": null,
                "incident_permission_set_id": "a7c770cb-2e69-4524-9edf-f647c779bd55",
                "pulses_permissions": [
                  "create",
                  "update",
                  "read"
                ],
                "alerts_permissions": [
                  "create",
                  "read"
                ],
                "paging_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "sub_statuses_permissions": [
                  "read"
                ],
                "catalogs_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "communication_permissions": [
                  "read"
                ],
                "incident_communication_permissions": [
                  "read"
                ],
                "integrations_permissions": []
              }
            },
            "on_call_role": {
              "data": {
                "id": "cf0ac38c-dfff-4310-8bcf-f36dcfc05259",
                "team_id": 235,
                "name": "None",
                "slug": "none",
                "system_role": "no_access",
                "deleted_at": null,
                "created_at": "2025-05-29T17:45:47.587-07:00",
                "updated_at": "2025-05-29T17:45:47.587-07:00",
                "alerts_permissions": [],
                "api_keys_permissions": [],
                "audits_permissions": [],
                "escalation_policies_permissions": [],
                "groups_permissions": [],
                "integrations_permissions": [],
                "invitations_permissions": [],
                "on_call_roles_permissions": [],
                "schedules_permissions": [],
                "services_permissions": [],
                "shift_overrides_permissions": [],
                "workflows_permissions": [],
                "contacts_permissions": [],
                "live_call_routing_permissions": [],
                "heartbeats_permissions": [],
                "alert_urgency_permissions": [],
                "schedule_override_permissions": [],
                "webhooks_permissions": [],
                "alert_sources_permissions": [],
                "on_call_readiness_report_permissions": [],
                "alert_routing_rules_permissions": []
              }
            }
          }
        }
      },
      "severity": {
        "data": {
          "id": "ccc47392-4548-480c-909e-f0f1903e3181",
          "type": "severities",
          "attributes": {
            "name": "oj6x4",
            "slug": "oj6x4",
            "description": "Et est alias amet.",
            "severity": "medium",
            "color": "#E58A1F",
            "position": 1,
            "notify_emails": [],
            "slack_channels": [],
            "slack_aliases": [],
            "created_at": "2025-05-29T17:45:55.338-07:00",
            "updated_at": "2025-05-29T17:45:55.338-07:00"
          }
        }
      },
      "in_triage_by": null,
      "started_by": {
        "data": {
          "id": "289",
          "type": "users",
          "attributes": {
            "name": "Mitchell Zboncak",
            "email": "normand.hansen@roberts.example",
            "phone": null,
            "phone_2": null,
            "first_name": "Mitchell",
            "last_name": "Zboncak",
            "full_name": "Mitchell Zboncak",
            "full_name_with_team": "[White Inc] Mitchell Zboncak",
            "slack_id": null,
            "time_zone": "UTC",
            "updated_at": "2025-05-29T17:46:04.010-07:00",
            "created_at": "2025-05-29T17:45:47.374-07:00"
          },
          "relationships": {
            "email_addresses": {
              "data": [
                {
                  "id": "4317a9a0-150f-4116-888b-bccb3a3d42bf",
                  "type": "user_email_addresses"
                }
              ]
            },
            "phone_numbers": {
              "data": []
            },
            "devices": {
              "data": []
            },
            "role": {
              "data": {
                "id": "fcbcda9c-7af4-4162-a159-ecbcd32d56e5",
                "created_at": "2025-05-29T17:45:47.563-07:00",
                "updated_at": "2025-05-29T17:45:47.563-07:00",
                "display_order": 2,
                "api_keys_permissions": [
                  "create",
                  "update",
                  "read",
                  "delete"
                ],
                "billing_permissions": [],
                "environments_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "functionalities_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "groups_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incident_causes_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incident_roles_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incident_types_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incidents_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "private_incidents_permissions": [],
                "invitations_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "playbooks_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "retrospective_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "roles_permissions": [],
                "services_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "severities_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "status_pages_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "workflows_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "team_id": 235,
                "name": "user",
                "slug": "user",
                "is_editable": true,
                "is_deletable": false,
                "incident_feedbacks_permissions": [
                  "read",
                  "create",
                  "update"
                ],
                "form_fields_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "webhooks_permissions": [],
                "audits_permissions": [],
                "secrets_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "deleted_at": null,
                "incident_permission_set_id": "a7c770cb-2e69-4524-9edf-f647c779bd55",
                "pulses_permissions": [
                  "create",
                  "update",
                  "read"
                ],
                "alerts_permissions": [
                  "create",
                  "read"
                ],
                "paging_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "sub_statuses_permissions": [
                  "read"
                ],
                "catalogs_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "communication_permissions": [
                  "read"
                ],
                "incident_communication_permissions": [
                  "read"
                ],
                "integrations_permissions": []
              }
            },
            "on_call_role": {
              "data": {
                "id": "cf0ac38c-dfff-4310-8bcf-f36dcfc05259",
                "team_id": 235,
                "name": "None",
                "slug": "none",
                "system_role": "no_access",
                "deleted_at": null,
                "created_at": "2025-05-29T17:45:47.587-07:00",
                "updated_at": "2025-05-29T17:45:47.587-07:00",
                "alerts_permissions": [],
                "api_keys_permissions": [],
                "audits_permissions": [],
                "escalation_policies_permissions": [],
                "groups_permissions": [],
                "integrations_permissions": [],
                "invitations_permissions": [],
                "on_call_roles_permissions": [],
                "schedules_permissions": [],
                "services_permissions": [],
                "shift_overrides_permissions": [],
                "workflows_permissions": [],
                "contacts_permissions": [],
                "live_call_routing_permissions": [],
                "heartbeats_permissions": [],
                "alert_urgency_permissions": [],
                "schedule_override_permissions": [],
                "webhooks_permissions": [],
                "alert_sources_permissions": [],
                "on_call_readiness_report_permissions": [],
                "alert_routing_rules_permissions": []
              }
            }
          }
        }
      },
      "mitigated_by": null,
      "resolved_by": null,
      "closed_by": null,
      "cancelled_by": null,
      "mitigation_message": null,
      "resolution_message": null,
      "cancellation_message": null,
      "public_title": null,
      "duplicate_incident_id": null,
      "retrospective_progress_status": "not_started",
      "zoom_meeting_id": null,
      "zoom_meeting_start_url": null,
      "zoom_meeting_join_url": null,
      "zoom_meeting_password": null,
      "zoom_meeting_pstn_password": null,
      "zoom_meeting_h323_password": null,
      "zoom_meeting_global_dial_in_numbers": [],
      "shortcut_story_id": null,
      "shortcut_story_url": null,
      "shortcut_task_id": null,
      "shortcut_task_url": null,
      "asana_task_id": null,
      "asana_task_url": null,
      "github_issue_id": null,
      "github_issue_url": null,
      "gitlab_issue_id": null,
      "gitlab_issue_url": null,
      "jira_issue_key": null,
      "jira_issue_id": null,
      "jira_issue_url": null,
      "google_meeting_id": null,
      "google_meeting_url": null,
      "trello_card_id": null,
      "trello_card_url": null,
      "linear_issue_id": null,
      "linear_issue_url": null,
      "zendesk_ticket_id": null,
      "zendesk_ticket_url": null,
      "motion_task_id": null,
      "motion_task_url": null,
      "clickup_task_id": null,
      "clickup_task_url": null,
      "slack_channel_name": null,
      "slack_channel_id": null,
      "slack_channel_url": null,
      "slack_channel_short_url": null,
      "slack_channel_deep_link": null,
      "slack_channel_archived": false,
      "slack_last_message_ts": null,
      "service_now_incident_id": null,
      "service_now_incident_key": null,
      "service_now_incident_url": null,
      "opsgenie_incident_id": null,
      "opsgenie_incident_url": null,
      "opsgenie_alert_id": null,
      "opsgenie_alert_url": null,
      "victor_ops_incident_id": null,
      "victor_ops_incident_url": null,
      "pagerduty_incident_id": null,
      "pagerduty_incident_number": null,
      "pagerduty_incident_url": null,
      "mattermost_channel_id": null,
      "mattermost_channel_name": null,
      "mattermost_channel_url": null,
      "confluence_page_id": null,
      "confluence_page_url": null,
      "quip_page_id": null,
      "quip_page_url": null,
      "airtable_base_key": null,
      "airtable_table_name": null,
      "airtable_record_id": null,
      "airtable_record_url": null,
      "google_drive_id": null,
      "google_drive_parent_id": null,
      "google_drive_url": null,
      "sharepoint_page_id": null,
      "sharepoint_page_url": null,
      "datadog_notebook_id": null,
      "datadog_notebook_url": null,
      "freshservice_ticket_id": null,
      "freshservice_ticket_url": null,
      "freshservice_task_id": null,
      "freshservice_task_url": null,
      "scheduled_for": null,
      "scheduled_until": null,
      "in_triage_at": null,
      "started_at": "2025-05-29T17:46:04.189-07:00",
      "detected_at": null,
      "acknowledged_at": null,
      "mitigated_at": null,
      "resolved_at": null,
      "closed_at": null,
      "cancelled_at": null,
      "created_at": "2025-05-29T17:46:04.254-07:00",
      "updated_at": "2025-05-29T17:46:04.411-07:00",
      "labels": {
        "platform": "windows",
        "version": "1.12",
        "CaseSensitive": "preserve"
      }
    },
    "relationships": {
      "causes": {
        "data": [
          {
            "id": "85e06fff-b7d2-4da8-8a4e-b9f050cafa15",
            "type": "causes"
          },
          {
            "id": "43b45e7e-2981-4d46-afbf-f8ad6bf49a48",
            "type": "causes"
          }
        ]
      },
      "subscribers": {
        "data": []
      },
      "roles": {
        "data": [
          {
            "id": "27de7286-8731-4d6e-a33d-85cab306bab8",
            "type": "incident_role_assignments"
          }
        ]
      },
      "environments": {
        "data": [
          {
            "id": "bab92b48-5bb1-4a82-a5c8-6167a482961a",
            "type": "environments"
          },
          {
            "id": "05cd9b23-2a44-4a32-acf0-d6612e612d40",
            "type": "environments"
          }
        ]
      },
      "incident_types": {
        "data": [
          {
            "id": "de53949a-43ad-4f97-8f19-bc844f23c06b",
            "type": "incident_types"
          },
          {
            "id": "072a5f9d-5ec8-4dc6-a6a9-53607b8961ba",
            "type": "incident_types"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "5933512f-84ee-4de1-9c74-55e93a2f7ef4",
            "type": "services"
          },
          {
            "id": "61d7798f-4251-4f6a-aa0c-badfef5f24ed",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "2742f552-bc09-4685-a226-dfe9b234bcc8",
            "type": "functionalities"
          },
          {
            "id": "f7b83309-8a3c-4ceb-9151-3b4d12f3e39b",
            "type": "functionalities"
          }
        ]
      },
      "groups": {
        "data": [
          {
            "id": "fd932f88-5052-405e-b02e-25d8f7e3bfba",
            "type": "groups"
          },
          {
            "id": "0784fccd-908c-4807-b842-88f0a8fd4dc3",
            "type": "groups"
          }
        ]
      },
      "events": {
        "data": [
          {
            "id": "8c8f4317-cf61-484b-a0a7-311cd856acb9",
            "type": "incident_events"
          },
          {
            "id": "2cf791de-af54-444a-9972-752c2644f823",
            "type": "incident_events"
          },
          {
            "id": "035c04a0-43ad-4b45-bb80-9aabc61fad56",
            "type": "incident_events"
          },
          {
            "id": "49c079d0-3190-4d9d-8fc0-06d3057649de",
            "type": "incident_events"
          }
        ]
      },
      "action_items": {
        "data": []
      },
      "custom_field_selections": {
        "data": []
      },
      "feedbacks": {
        "data": []
      },
      "attachments": {
        "data": []
      },
      "slack_messages": {
        "data": []
      }
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/vnd.api+json

Response

201
application/vnd.api+json

incident created

The response is of type object.