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": "870ab1b6-3219-4286-ac78-eca973951c35",
    "type": "incidents",
    "attributes": {
      "parent_incident_id": null,
      "sequential_id": 4,
      "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/4-oh-no-something-is-broken",
      "short_url": null,
      "user": {
        "data": {
          "id": "318",
          "type": "users",
          "attributes": {
            "name": "Trinh West",
            "email": "herbert.klein@von.example",
            "phone": null,
            "phone_2": null,
            "full_name": "Trinh West",
            "full_name_with_team": "[Sipes, Bosco and Rodriguez] Trinh West",
            "slack_id": null,
            "time_zone": "UTC",
            "updated_at": "2025-03-28T23:02:54.253-07:00",
            "created_at": "2025-03-28T23:02:45.499-07:00"
          },
          "relationships": {
            "email_addresses": {
              "data": [
                {
                  "id": "e0aed56f-7d53-4411-9ecd-6a284984c6e3",
                  "type": "user_email_addresses"
                }
              ]
            },
            "phone_numbers": {
              "data": []
            },
            "devices": {
              "data": []
            }
          }
        }
      },
      "severity": {
        "data": {
          "id": "a2fe7631-bc2f-4067-beef-0c30cd5ebb0a",
          "type": "severities",
          "attributes": {
            "name": "8o6js",
            "slug": "8o6js",
            "description": "Ut iure adipisci ipsam.",
            "severity": "medium",
            "color": "#E58A1F",
            "position": 1,
            "notify_emails": [],
            "slack_channels": [],
            "slack_aliases": [],
            "created_at": "2025-03-28T23:02:48.753-07:00",
            "updated_at": "2025-03-28T23:02:48.753-07:00"
          }
        }
      },
      "in_triage_by": null,
      "started_by": {
        "data": {
          "id": "318",
          "type": "users",
          "attributes": {
            "name": "Trinh West",
            "email": "herbert.klein@von.example",
            "phone": null,
            "phone_2": null,
            "full_name": "Trinh West",
            "full_name_with_team": "[Sipes, Bosco and Rodriguez] Trinh West",
            "slack_id": null,
            "time_zone": "UTC",
            "updated_at": "2025-03-28T23:02:54.253-07:00",
            "created_at": "2025-03-28T23:02:45.499-07:00"
          },
          "relationships": {
            "email_addresses": {
              "data": [
                {
                  "id": "e0aed56f-7d53-4411-9ecd-6a284984c6e3",
                  "type": "user_email_addresses"
                }
              ]
            },
            "phone_numbers": {
              "data": []
            },
            "devices": {
              "data": []
            }
          }
        }
      },
      "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-03-28T23:02:54.431-07:00",
      "detected_at": null,
      "acknowledged_at": null,
      "mitigated_at": null,
      "resolved_at": null,
      "closed_at": null,
      "cancelled_at": null,
      "created_at": "2025-03-28T23:02:54.493-07:00",
      "updated_at": "2025-03-28T23:02:54.638-07:00",
      "labels": {
        "platform": "windows",
        "version": "1.12",
        "CaseSensitive": "preserve"
      }
    },
    "relationships": {
      "causes": {
        "data": [
          {
            "id": "2b9614d3-d885-4e57-b305-115ed739319f",
            "type": "causes"
          },
          {
            "id": "19bca2fa-6d18-46ce-a7e8-f38c3ed7098a",
            "type": "causes"
          }
        ]
      },
      "subscribers": {
        "data": []
      },
      "roles": {
        "data": [
          {
            "id": "5d94934a-9f4f-43de-962f-407cfa93e964",
            "type": "incident_role_assignments"
          }
        ]
      },
      "environments": {
        "data": [
          {
            "id": "071ed1ce-ca95-4aef-8b2d-1ffaf56c7631",
            "type": "environments"
          },
          {
            "id": "c1bd5b6d-9223-4e9c-a3eb-84b90196311b",
            "type": "environments"
          }
        ]
      },
      "incident_types": {
        "data": [
          {
            "id": "6870e327-1cff-4cb9-a2ad-c770ea766be4",
            "type": "incident_types"
          },
          {
            "id": "960fccf5-c00e-4da3-aad8-dc2a8b4cd012",
            "type": "incident_types"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "a9ab381a-7fce-47fa-a716-fb4c0dedd046",
            "type": "services"
          },
          {
            "id": "bde45b62-f335-418a-8bf7-9861a4666145",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "9426bf27-02ad-4860-a8bf-d8877e65faa7",
            "type": "functionalities"
          },
          {
            "id": "7195a5da-025c-4ebd-a23b-f5cd5cbb6a90",
            "type": "functionalities"
          }
        ]
      },
      "groups": {
        "data": [
          {
            "id": "81d7fea1-b3d4-4908-b6c6-4f58e9efe15d",
            "type": "groups"
          },
          {
            "id": "3c987b6e-500d-44b7-9b67-d48fe8b5e927",
            "type": "groups"
          }
        ]
      },
      "events": {
        "data": [
          {
            "id": "1e254fd3-24d7-4798-8bd1-0713361c5404",
            "type": "incident_events"
          },
          {
            "id": "e2a7a0ac-fb11-4f39-9193-d1cd55d80558",
            "type": "incident_events"
          },
          {
            "id": "081d2084-0cac-4ebc-9c15-c370d3cb201a",
            "type": "incident_events"
          },
          {
            "id": "58acd7f1-80bb-4ba1-990b-2a4a92de796e",
            "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
​
data
object
required

Response

201
application/vnd.api+json
incident created
​
data
object
required

Was this page helpful?