Skip to main content
POST
/
v1
/
incidents
Creates an incident
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>",
      "public_title": "<string>",
      "alert_ids": [
        "<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>",
      "slack_channel_id": "<string>",
      "slack_channel_url": "<string>",
      "slack_channel_archived": true,
      "google_drive_parent_id": "<string>",
      "google_drive_url": "<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>",
      "closed_at": "<string>",
      "cancelled_at": "<string>"
    }
  }
}
'
{
  "data": {
    "id": "<string>",
    "type": "incidents",
    "attributes": {
      "title": "<string>",
      "slug": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "id": "<string>",
      "sequential_id": 123,
      "kind": "<string>",
      "parent_incident_id": "<string>",
      "duplicate_incident_id": "<string>",
      "summary": "<string>",
      "private": false,
      "source": "<string>",
      "status": "<string>",
      "url": "<string>",
      "short_url": "<string>",
      "public_title": "<string>",
      "user": {},
      "severity": {
        "data": {
          "id": "<string>",
          "type": "severities",
          "attributes": {
            "name": "<string>",
            "created_at": "<string>",
            "updated_at": "<string>",
            "slug": "<string>",
            "description": "<string>",
            "severity": "critical",
            "color": "<string>",
            "position": 123,
            "notify_emails": [
              "<string>"
            ],
            "slack_channels": [
              {
                "id": "<string>",
                "name": "<string>"
              }
            ],
            "slack_aliases": [
              {
                "id": "<string>",
                "name": "<string>"
              }
            ]
          }
        }
      },
      "environments": [
        {
          "data": {
            "id": "<string>",
            "type": "environments",
            "attributes": {
              "name": "<string>",
              "created_at": "<string>",
              "updated_at": "<string>",
              "slug": "<string>",
              "description": "<string>",
              "notify_emails": [
                "<string>"
              ],
              "color": "<string>",
              "position": 123,
              "slack_channels": [
                {
                  "id": "<string>",
                  "name": "<string>"
                }
              ],
              "slack_aliases": [
                {
                  "id": "<string>",
                  "name": "<string>"
                }
              ]
            }
          }
        }
      ],
      "incident_types": [
        {
          "data": {
            "id": "<string>",
            "type": "incident_types",
            "attributes": {
              "name": "<string>",
              "created_at": "<string>",
              "updated_at": "<string>",
              "slug": "<string>",
              "description": "<string>",
              "color": "<string>",
              "position": 123,
              "notify_emails": [
                "<string>"
              ],
              "slack_channels": [
                {
                  "id": "<string>",
                  "name": "<string>"
                }
              ],
              "slack_aliases": [
                {
                  "id": "<string>",
                  "name": "<string>"
                }
              ]
            }
          }
        }
      ],
      "services": [
        {
          "data": {
            "id": "<string>",
            "type": "services",
            "attributes": {
              "name": "<string>",
              "created_at": "<string>",
              "updated_at": "<string>",
              "slug": "<string>",
              "description": "<string>",
              "public_description": "<string>",
              "notify_emails": [
                "<string>"
              ],
              "color": "<string>",
              "position": 123,
              "backstage_id": "<string>",
              "external_id": "<string>",
              "pagerduty_id": "<string>",
              "opsgenie_id": "<string>",
              "cortex_id": "<string>",
              "service_now_ci_sys_id": "<string>",
              "github_repository_name": "<string>",
              "github_repository_branch": "<string>",
              "gitlab_repository_name": "<string>",
              "gitlab_repository_branch": "<string>",
              "environment_ids": [
                "<string>"
              ],
              "service_ids": [
                "<string>"
              ],
              "owner_group_ids": [
                "<string>"
              ],
              "owner_user_ids": [
                123
              ],
              "alert_urgency_id": "<string>",
              "alerts_email_enabled": true,
              "alerts_email_address": "<string>",
              "slack_channels": [
                {
                  "id": "<string>",
                  "name": "<string>"
                }
              ],
              "slack_aliases": [
                {
                  "id": "<string>",
                  "name": "<string>"
                }
              ],
              "alert_broadcast_enabled": true,
              "alert_broadcast_channel": {
                "id": "<string>",
                "name": "<string>"
              },
              "incident_broadcast_enabled": true,
              "incident_broadcast_channel": {
                "id": "<string>",
                "name": "<string>"
              }
            }
          }
        }
      ],
      "functionalities": [
        {
          "data": {
            "id": "<string>",
            "type": "functionalities",
            "attributes": {
              "name": "<string>",
              "created_at": "<string>",
              "updated_at": "<string>",
              "slug": "<string>",
              "description": "<string>",
              "public_description": "<string>",
              "notify_emails": [
                "<string>"
              ],
              "color": "<string>",
              "backstage_id": "<string>",
              "external_id": "<string>",
              "pagerduty_id": "<string>",
              "opsgenie_id": "<string>",
              "opsgenie_team_id": "<string>",
              "cortex_id": "<string>",
              "service_now_ci_sys_id": "<string>",
              "position": 123,
              "environment_ids": [
                "<string>"
              ],
              "service_ids": [
                "<string>"
              ],
              "owner_group_ids": [
                "<string>"
              ],
              "owner_user_ids": [
                123
              ],
              "slack_channels": [
                {
                  "id": "<string>",
                  "name": "<string>"
                }
              ],
              "slack_aliases": [
                {
                  "id": "<string>",
                  "name": "<string>"
                }
              ]
            }
          }
        }
      ],
      "groups": [
        {
          "data": {
            "id": "<string>",
            "type": "groups",
            "attributes": {
              "name": "<string>",
              "created_at": "<string>",
              "updated_at": "<string>",
              "slug": "<string>",
              "description": "<string>",
              "notify_emails": [
                "<string>"
              ],
              "color": "<string>",
              "position": 123,
              "backstage_id": "<string>",
              "external_id": "<string>",
              "pagerduty_id": "<string>",
              "pagerduty_service_id": "<string>",
              "opsgenie_id": "<string>",
              "victor_ops_id": "<string>",
              "pagertree_id": "<string>",
              "cortex_id": "<string>",
              "service_now_ci_sys_id": "<string>",
              "user_ids": [
                123
              ],
              "admin_ids": [
                123
              ],
              "alerts_email_enabled": true,
              "alerts_email_address": "<string>",
              "alert_urgency_id": "<string>",
              "slack_channels": [
                {
                  "id": "<string>",
                  "name": "<string>"
                }
              ],
              "slack_aliases": [
                {
                  "id": "<string>",
                  "name": "<string>"
                }
              ],
              "alert_broadcast_enabled": true,
              "alert_broadcast_channel": {
                "id": "<string>",
                "name": "<string>"
              },
              "incident_broadcast_enabled": true,
              "incident_broadcast_channel": {
                "id": "<string>",
                "name": "<string>"
              },
              "auto_add_members_when_attached": true
            }
          }
        }
      ],
      "labels": {},
      "slack_channel_id": "<string>",
      "slack_channel_name": "<string>",
      "slack_channel_url": "<string>",
      "slack_channel_short_url": "<string>",
      "slack_channel_deep_link": "<string>",
      "slack_channel_archived": true,
      "slack_last_message_ts": "<string>",
      "zoom_meeting_id": "<string>",
      "zoom_meeting_start_url": "<string>",
      "zoom_meeting_join_url": "<string>",
      "zoom_meeting_password": "<string>",
      "zoom_meeting_pstn_password": "<string>",
      "zoom_meeting_h323_password": "<string>",
      "zoom_meeting_global_dial_in_numbers": [
        "<string>"
      ],
      "google_drive_id": "<string>",
      "google_drive_parent_id": "<string>",
      "google_drive_url": "<string>",
      "google_meeting_id": "<string>",
      "google_meeting_url": "<string>",
      "jira_issue_key": "<string>",
      "jira_issue_id": "<string>",
      "jira_issue_url": "<string>",
      "github_issue_id": "<string>",
      "github_issue_url": "<string>",
      "gitlab_issue_id": "<string>",
      "gitlab_issue_url": "<string>",
      "asana_task_id": "<string>",
      "asana_task_url": "<string>",
      "linear_issue_id": "<string>",
      "linear_issue_url": "<string>",
      "trello_card_id": "<string>",
      "trello_card_url": "<string>",
      "zendesk_ticket_id": "<string>",
      "zendesk_ticket_url": "<string>",
      "pagerduty_incident_id": "<string>",
      "pagerduty_incident_number": "<string>",
      "pagerduty_incident_url": "<string>",
      "opsgenie_incident_id": "<string>",
      "opsgenie_incident_url": "<string>",
      "opsgenie_alert_id": "<string>",
      "opsgenie_alert_url": "<string>",
      "service_now_incident_id": "<string>",
      "service_now_incident_key": "<string>",
      "service_now_incident_url": "<string>",
      "mattermost_channel_id": "<string>",
      "mattermost_channel_name": "<string>",
      "mattermost_channel_url": "<string>",
      "confluence_page_id": "<string>",
      "confluence_page_url": "<string>",
      "datadog_notebook_id": "<string>",
      "datadog_notebook_url": "<string>",
      "shortcut_story_id": "<string>",
      "shortcut_story_url": "<string>",
      "shortcut_task_id": "<string>",
      "shortcut_task_url": "<string>",
      "motion_task_id": "<string>",
      "motion_task_url": "<string>",
      "clickup_task_id": "<string>",
      "clickup_task_url": "<string>",
      "victor_ops_incident_id": "<string>",
      "victor_ops_incident_url": "<string>",
      "quip_page_id": "<string>",
      "quip_page_url": "<string>",
      "sharepoint_page_id": "<string>",
      "sharepoint_page_url": "<string>",
      "airtable_base_key": "<string>",
      "airtable_table_name": "<string>",
      "airtable_record_id": "<string>",
      "airtable_record_url": "<string>",
      "freshservice_ticket_id": "<string>",
      "freshservice_ticket_url": "<string>",
      "freshservice_task_id": "<string>",
      "freshservice_task_url": "<string>",
      "mitigation_message": "<string>",
      "resolution_message": "<string>",
      "cancellation_message": "<string>",
      "scheduled_for": "<string>",
      "scheduled_until": "<string>",
      "retrospective_progress_status": "not_started",
      "in_triage_by": {},
      "started_by": {},
      "mitigated_by": {},
      "resolved_by": {},
      "closed_by": {},
      "cancelled_by": {},
      "in_triage_at": "<string>",
      "started_at": "<string>",
      "detected_at": "<string>",
      "acknowledged_at": "<string>",
      "mitigated_at": "<string>",
      "resolved_at": "<string>",
      "closed_at": "<string>",
      "cancelled_at": "<string>"
    }
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/vnd.api+json
data
object
required

Response

incident created

data
object
required