rootly_openapi.json•3.25 MB
{
"openapi": "3.0.1",
"info": {
"title": "Rootly API v1",
"version": "v1",
"description": "# How to generate an API Key?\n- **Organization dropdown** > **Organization Settings** > **API Keys**\n\n# JSON:API Specification\nRootly is using **JSON:API** (https://jsonapi.org) specification:\n- JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests.\n- JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability.\n- JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data.\n\n# Authentication and Requests\nWe use standard HTTP Authentication over HTTPS to authorize your requests.\n```\n curl --request GET \\\n--header 'Content-Type: application/vnd.api+json' \\\n--header 'Authorization: Bearer YOUR-TOKEN' \\\n--url https://api.rootly.com/v1/incidents\n```\n\n<br/>\n\n# Rate limiting\n- There is a default limit of approximately **3000** **GET** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments.\n- There is a default limit of approximately **3000** **PUT**, **POST**, **PATCH** or **DELETE** calls **per API key** every **60 seconds**. The limit is calculated over a **60-second sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments.\n- The response to the API call will return 429 HTTP status code - Request Limit Exceeded and Rootly will not ingest the event.\n- Additional headers will be returned giving you information about the limit:\n - **RateLimit-Limit** - The maximum number of requests that the consumer is permitted to make.\n - **RateLimit-Remaining** - The number of requests remaining in the current rate limit window.\n - **RateLimit-Reset** - The time at which the current rate limit window resets in UTC epoch seconds.\n\n# Pagination\n- Pagination is supported for all endpoints that return a collection of items.\n- Pagination is controlled by the **page** query parameter\n\n## Example\n```\n curl --request GET \\\n--header 'Content-Type: application/vnd.api+json' \\\n--header 'Authorization: Bearer YOUR-TOKEN' \\\n--url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10\n```\n\n",
"x-logo": {
"url": "https://rootly-heroku.s3.us-east-1.amazonaws.com/swagger/v1/logo.png",
"alt": "Rootly"
}
},
"paths": {
"/v1/alerts/{alert_id}/events": {
"parameters": [
{
"name": "alert_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "List alert events",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertEvents"
],
"description": "List alert_events",
"operationId": "listAlertEvents",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[action]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_event_list"
}
}
}
}
}
},
"post": {
"summary": "Create alert event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertEvents"
],
"description": "Creates a new alert event",
"operationId": "createAlertEvent",
"parameters": [],
"responses": {
"201": {
"description": "alert event created with Rootly bot user",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "b23e4075-54fd-4b33-b058-724a03f74ff7",
"type": "alert_events",
"attributes": {
"kind": "note",
"source": "api",
"action": "created",
"details": "This is a test note",
"user": {
"id": 6,
"email": "bot@rootly.com",
"deleted_at": null,
"created_at": "2025-07-12T00:11:35.764-07:00",
"updated_at": "2025-07-12T00:11:35.764-07:00",
"current_team_id": 2,
"first_name": "Rootly",
"last_name": null,
"time_zone": "America/Los_Angeles",
"last_seen_at": null,
"profile_photo_id": null,
"ability_cache": null,
"last_notification_email_sent_at": null,
"accept_terms": true,
"onboarding_completed": true,
"service_user": true,
"accept_marketing": true,
"teams_count": 1,
"created_through_sso": false,
"scim_uid": null,
"session_token": null,
"incidents_example_count": 0,
"incidents_test_count": 0,
"incidents_normal_count": 0,
"incidents_scheduled_count": 0,
"incidents_backfilled_count": 0,
"incidents_count": 0,
"theme": "light_v2",
"skip_tutorial": false,
"external_id": null,
"jti": "f1b95afe-f75b-4389-ba97-26d2d232cf09",
"is_super_admin": false,
"has_impersonate_write_permission": false,
"view_multiple_schedules": true,
"push_notification_new_alert_sound": "default",
"push_notification_shift_starts_sound": "soft_bloob",
"push_notification_shift_ends_sound": "soft_bloob",
"how_did_you_hear_about_us": null,
"push_notification_new_alert_volume": 1.0,
"opsgenie_id": null,
"victor_ops_id": null,
"pagerduty_id": null,
"locale": "en"
},
"user_id": 6,
"incident": null,
"schedule": null,
"escalation_level": null,
"escalation_target_type": null,
"escalation_target": null,
"slack_channel": null,
"incident_ids": [],
"created_at": "2025-07-12T00:11:36.934-07:00",
"updated_at": "2025-07-12T00:11:36.934-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/alert_event_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Details can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_alert_event"
}
}
}
}
}
},
"/v1/alert_events/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieve alert event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertEvents"
],
"description": "Retrieves a specific alert_event by id",
"operationId": "getAlertEvent",
"responses": {
"200": {
"description": "alert_event found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "cb71754c-8510-483b-a43e-e75fe713198e",
"type": "alert_events",
"attributes": {
"kind": "note",
"source": "api",
"action": "created",
"details": "test note",
"user": {
"id": 1,
"email": "delbert.oconnell@greenfelder.example",
"deleted_at": null,
"created_at": "2025-07-12T00:11:34.071-07:00",
"updated_at": "2025-07-12T00:11:37.222-07:00",
"current_team_id": 1,
"first_name": "Elana",
"last_name": "King",
"time_zone": "UTC",
"last_seen_at": null,
"profile_photo_id": null,
"ability_cache": null,
"last_notification_email_sent_at": null,
"accept_terms": true,
"onboarding_completed": true,
"service_user": false,
"accept_marketing": true,
"teams_count": 1,
"created_through_sso": false,
"scim_uid": null,
"session_token": null,
"incidents_example_count": 0,
"incidents_test_count": 0,
"incidents_normal_count": 0,
"incidents_scheduled_count": 0,
"incidents_backfilled_count": 0,
"incidents_count": 0,
"theme": "light_v2",
"skip_tutorial": false,
"external_id": null,
"jti": "f9bffc83-949d-49db-b783-900b186b36ef",
"is_super_admin": false,
"has_impersonate_write_permission": false,
"view_multiple_schedules": true,
"push_notification_new_alert_sound": "default",
"push_notification_shift_starts_sound": "soft_bloob",
"push_notification_shift_ends_sound": "soft_bloob",
"how_did_you_hear_about_us": null,
"push_notification_new_alert_volume": 1.0,
"opsgenie_id": null,
"victor_ops_id": null,
"pagerduty_id": null,
"locale": "en"
},
"user_id": 1,
"incident": null,
"schedule": null,
"escalation_level": null,
"escalation_target_type": null,
"escalation_target": null,
"slack_channel": null,
"incident_ids": [],
"created_at": "2025-07-12T00:11:35.906-07:00",
"updated_at": "2025-07-12T00:11:35.906-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/alert_event_response"
}
}
}
},
"404": {
"description": "alert_event not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"patch": {
"summary": "Update alert event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertEvents"
],
"description": "Updates a specific alert event",
"operationId": "updateAlertEvent",
"parameters": [],
"responses": {
"200": {
"description": "alert event updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "cb71754c-8510-483b-a43e-e75fe713198e",
"type": "alert_events",
"attributes": {
"kind": "note",
"source": "api",
"action": "created",
"details": "Updated details",
"user": {
"id": 1,
"email": "delbert.oconnell@greenfelder.example",
"deleted_at": null,
"created_at": "2025-07-12T00:11:34.071-07:00",
"updated_at": "2025-07-12T00:11:37.522-07:00",
"current_team_id": 1,
"first_name": "Elana",
"last_name": "King",
"time_zone": "UTC",
"last_seen_at": null,
"profile_photo_id": null,
"ability_cache": null,
"last_notification_email_sent_at": null,
"accept_terms": true,
"onboarding_completed": true,
"service_user": false,
"accept_marketing": true,
"teams_count": 1,
"created_through_sso": false,
"scim_uid": null,
"session_token": null,
"incidents_example_count": 0,
"incidents_test_count": 0,
"incidents_normal_count": 0,
"incidents_scheduled_count": 0,
"incidents_backfilled_count": 0,
"incidents_count": 0,
"theme": "light_v2",
"skip_tutorial": false,
"external_id": null,
"jti": "f9bffc83-949d-49db-b783-900b186b36ef",
"is_super_admin": false,
"has_impersonate_write_permission": false,
"view_multiple_schedules": true,
"push_notification_new_alert_sound": "default",
"push_notification_shift_starts_sound": "soft_bloob",
"push_notification_shift_ends_sound": "soft_bloob",
"how_did_you_hear_about_us": null,
"push_notification_new_alert_volume": 1.0,
"opsgenie_id": null,
"victor_ops_id": null,
"pagerduty_id": null,
"locale": "en"
},
"user_id": 1,
"incident": null,
"schedule": null,
"escalation_level": null,
"escalation_target_type": null,
"escalation_target": null,
"slack_channel": null,
"incident_ids": [],
"created_at": "2025-07-12T00:11:35.906-07:00",
"updated_at": "2025-07-12T00:11:37.549-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/alert_event_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Details can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_alert_event"
}
}
}
}
},
"delete": {
"summary": "Delete alert event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertEvents"
],
"description": "Deletes a specific alert event",
"operationId": "deleteAlertEvent",
"responses": {
"200": {
"description": "alert event deleted"
},
"404": {
"description": "alert event not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/alert_groups": {
"post": {
"summary": "Creates an alert group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertGroups"
],
"description": "Creates a new alert group",
"operationId": "createAlertGroup",
"parameters": [],
"responses": {
"201": {
"description": "alert group created with conditions",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "5c89014f-67d3-4241-8e04-b8aa4ae7a3a7",
"type": "alert_groups",
"attributes": {
"name": "Test alert group",
"slug": "test-alert-group",
"description": null,
"time_window": 10,
"condition_type": "any",
"deleted_at": null,
"created_at": "2025-07-12T00:11:44.975-07:00",
"updated_at": "2025-07-12T00:11:44.975-07:00",
"group_by_alert_title": false,
"group_by_alert_urgency": false,
"targets": [
{
"id": "7bcbc1b6-fc33-452e-9c7f-1e51815523a1",
"target_type": "Service",
"target_id": "c5d8897f-cae8-4851-bccd-868bbfa3ee4e",
"alert_group_id": "5c89014f-67d3-4241-8e04-b8aa4ae7a3a7",
"deleted_at": null,
"created_at": "2025-07-12T00:11:44.976-07:00",
"updated_at": "2025-07-12T00:11:44.976-07:00"
}
],
"attributes": [],
"conditions": [
{
"id": "d6525398-f5ee-4340-bcb5-04e53a8679cc",
"property_field_condition_type": "is_one_of",
"property_field_name": "description",
"property_field_type": "attribute",
"property_field_value": null,
"property_field_values": [
"Test description"
],
"created_at": "2025-07-12T00:11:44.977-07:00",
"updated_at": "2025-07-12T00:11:44.977-07:00",
"conditionable_type": null,
"conditionable_id": null
},
{
"id": "89396f84-ca33-47b0-ba35-0e34620f1a87",
"property_field_condition_type": "is_one_of",
"property_field_name": "alert_urgency",
"property_field_type": "attribute",
"property_field_value": null,
"property_field_values": [],
"created_at": "2025-07-12T00:11:44.978-07:00",
"updated_at": "2025-07-12T00:11:44.978-07:00",
"conditionable_type": null,
"conditionable_id": null,
"values": [
{
"record_id": "85f9980c-87a7-481b-b4a0-b61b5de053ab",
"record_type": "AlertUrgency"
}
]
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/alert_group_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
},
{
"title": "Destinations can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_alert_group"
}
}
},
"required": true
}
},
"get": {
"summary": "List alert groups",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertGroups"
],
"description": "List alert groups",
"operationId": "listAlertGroups",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_group_list"
}
}
}
}
}
}
},
"/v1/alert_groups/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an alert group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertGroups"
],
"description": "Retrieves a specific alert group by id",
"operationId": "getAlertGroup",
"responses": {
"200": {
"description": "alert group found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "a488c709-1862-4c02-8bdd-1336978fa898",
"type": "alert_groups",
"attributes": {
"name": "123 test group",
"slug": "123-test-group",
"description": null,
"time_window": 10,
"condition_type": "any",
"deleted_at": null,
"created_at": "2025-07-12T00:11:44.506-07:00",
"updated_at": "2025-07-12T00:11:44.506-07:00",
"group_by_alert_title": false,
"group_by_alert_urgency": false,
"targets": [
{
"id": "79fb8374-7e57-4c24-8e75-676be0c78556",
"target_type": "Service",
"target_id": "c5d8897f-cae8-4851-bccd-868bbfa3ee4e",
"alert_group_id": "a488c709-1862-4c02-8bdd-1336978fa898",
"deleted_at": null,
"created_at": "2025-07-12T00:11:44.508-07:00",
"updated_at": "2025-07-12T00:11:44.508-07:00"
}
],
"attributes": []
}
}
},
"schema": {
"$ref": "#/components/schemas/alert_group_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"patch": {
"summary": "Update an alert group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertGroups"
],
"description": "Update a specific alert group by id",
"operationId": "updateAlertGroup",
"parameters": [],
"responses": {
"200": {
"description": "alert group updated with conditions",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "a488c709-1862-4c02-8bdd-1336978fa898",
"type": "alert_groups",
"attributes": {
"name": "Group name updated",
"slug": "123-test-group",
"description": null,
"time_window": 10,
"condition_type": "any",
"deleted_at": null,
"created_at": "2025-07-12T00:11:44.506-07:00",
"updated_at": "2025-07-12T00:11:46.331-07:00",
"group_by_alert_title": false,
"group_by_alert_urgency": false,
"targets": [
{
"id": "79fb8374-7e57-4c24-8e75-676be0c78556",
"target_type": "Service",
"target_id": "c5d8897f-cae8-4851-bccd-868bbfa3ee4e",
"alert_group_id": "a488c709-1862-4c02-8bdd-1336978fa898",
"deleted_at": null,
"created_at": "2025-07-12T00:11:44.508-07:00",
"updated_at": "2025-07-12T00:11:44.508-07:00"
}
],
"attributes": [],
"conditions": [
{
"id": "ac227de9-062b-4469-9636-0cb08a5db066",
"property_field_condition_type": "is_one_of",
"property_field_name": "description",
"property_field_type": "attribute",
"property_field_value": null,
"property_field_values": [
"Test description"
],
"created_at": "2025-07-12T00:11:46.332-07:00",
"updated_at": "2025-07-12T00:11:46.332-07:00",
"conditionable_type": null,
"conditionable_id": null
},
{
"id": "94598492-194b-4ae8-a60c-efd52583b32b",
"property_field_condition_type": "is_one_of",
"property_field_name": "alert_urgency",
"property_field_type": "attribute",
"property_field_value": null,
"property_field_values": [],
"created_at": "2025-07-12T00:11:46.333-07:00",
"updated_at": "2025-07-12T00:11:46.333-07:00",
"conditionable_type": null,
"conditionable_id": null,
"values": [
{
"record_id": "85f9980c-87a7-481b-b4a0-b61b5de053ab",
"record_type": "AlertUrgency"
}
]
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/alert_group_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_alert_group"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an alert group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertGroups"
],
"description": "Delete a specific alert group by id",
"operationId": "deleteAlertGroup",
"responses": {
"200": {
"description": "alert group deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "a488c709-1862-4c02-8bdd-1336978fa898",
"type": "alert_groups",
"attributes": {
"name": "123 test group",
"slug": "123-test-group",
"description": null,
"time_window": 10,
"condition_type": "any",
"deleted_at": "2025-07-12T00:11:46.732-07:00",
"created_at": "2025-07-12T00:11:44.506-07:00",
"updated_at": "2025-07-12T00:11:46.732-07:00",
"group_by_alert_title": false,
"group_by_alert_urgency": false,
"targets": [],
"attributes": []
}
}
},
"schema": {
"$ref": "#/components/schemas/alert_group_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/alert_routing_rules": {
"post": {
"summary": "Creates an alert routing rule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertRoutingRules"
],
"description": "Creates a new alert routing rule from provided data",
"operationId": "createAlertRoutingRule",
"parameters": [],
"responses": {
"201": {
"description": "alert routing rule created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "c6e75aae-8616-4f7c-9557-da95b2fa9c43",
"type": "alert_routing_rules",
"attributes": {
"name": "Test Alert Routing Rule 1",
"alerts_source_id": "5d61120d-9407-4a69-8b12-c150f511441b",
"condition_type": "all",
"enabled": false,
"position": 2,
"created_at": "2025-07-12T00:11:50.431-07:00",
"updated_at": "2025-07-12T00:11:50.431-07:00",
"destinations": [
{
"id": "fc8baace-78fa-42db-8de4-5c52d7947454",
"target_type": "Group",
"target_id": "e8554c20-8060-4b52-a4f2-9104172b3e35",
"created_at": "2025-07-12T00:11:50.434-07:00",
"updated_at": "2025-07-12T00:11:50.434-07:00"
}
],
"conditions": [
{
"id": "83c2292d-7699-44b2-8109-018ea8a92990",
"property_field_condition_type": "is_one_of",
"property_field_name": "description",
"property_field_type": "attribute",
"property_field_value": null,
"property_field_values": [
"Open"
],
"created_at": "2025-07-12T00:11:50.442-07:00",
"updated_at": "2025-07-12T00:11:50.442-07:00"
}
]
},
"relationships": {
"owning_teams": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/alert_routing_rule_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_alert_routing_rule"
}
}
},
"required": true
}
},
"get": {
"summary": "List alert routing rules",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertRoutingRules"
],
"description": "List alert routing rules",
"operationId": "listAlertRoutingRules",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_routing_rule_list"
}
}
}
}
}
}
},
"/v1/alert_routing_rules/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an alert routing rule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertRoutingRules"
],
"description": "Retrieves a specific alert routing rule by id",
"operationId": "getAlertRoutingRule",
"responses": {
"200": {
"description": "alert routing rule found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "18082f5c-d261-48b0-b7c5-9d9ef4d323a0",
"type": "alert_routing_rules",
"attributes": {
"name": "Alert Routing Rule 1",
"alerts_source_id": "5d61120d-9407-4a69-8b12-c150f511441b",
"condition_type": "all",
"enabled": false,
"position": 1,
"created_at": "2025-07-12T00:11:48.525-07:00",
"updated_at": "2025-07-12T00:11:48.525-07:00",
"destinations": [
{
"id": "a91b9ae7-104a-4939-852e-2ecbdc1f32f0",
"target_type": "EscalationPolicy",
"target_id": "7410af8a-7f4c-4210-8441-5105e2d68d85",
"created_at": "2025-07-12T00:11:48.610-07:00",
"updated_at": "2025-07-12T00:11:48.610-07:00"
}
],
"conditions": []
},
"relationships": {
"owning_teams": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/alert_routing_rule_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an alert routing rule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertRoutingRules"
],
"description": "Update a specific alert routing rule by id",
"operationId": "updateAlertRoutingRule",
"parameters": [],
"responses": {
"200": {
"description": "alert routing rule updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "18082f5c-d261-48b0-b7c5-9d9ef4d323a0",
"type": "alert_routing_rules",
"attributes": {
"name": "Test Alert Routing Rule 1 (Updated)",
"alerts_source_id": "5d61120d-9407-4a69-8b12-c150f511441b",
"condition_type": "all",
"enabled": false,
"position": 1,
"created_at": "2025-07-12T00:11:48.525-07:00",
"updated_at": "2025-07-12T00:11:52.609-07:00",
"destinations": [
{
"id": "a91b9ae7-104a-4939-852e-2ecbdc1f32f0",
"target_type": "EscalationPolicy",
"target_id": "7410af8a-7f4c-4210-8441-5105e2d68d85",
"created_at": "2025-07-12T00:11:48.610-07:00",
"updated_at": "2025-07-12T00:11:48.610-07:00"
}
],
"conditions": []
},
"relationships": {
"owning_teams": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/alert_routing_rule_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_alert_routing_rule"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an alert routing rule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertRoutingRules"
],
"description": "Delete a specific alert routing rule by id",
"operationId": "deleteAlertRoutingRule",
"responses": {
"200": {
"description": "alert routing rule deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "18082f5c-d261-48b0-b7c5-9d9ef4d323a0",
"type": "alert_routing_rules",
"attributes": {
"name": "Alert Routing Rule 1",
"alerts_source_id": "5d61120d-9407-4a69-8b12-c150f511441b",
"condition_type": "all",
"enabled": false,
"position": 1,
"created_at": "2025-07-12T00:11:48.525-07:00",
"updated_at": "2025-07-12T00:11:53.924-07:00",
"destinations": [],
"conditions": []
},
"relationships": {
"owning_teams": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/alert_routing_rule_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/alert_urgencies": {
"post": {
"summary": "Creates an alert urgency",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertUrgencies"
],
"description": "Creates a new alert urgency from provided data",
"operationId": "createAlertUrgency",
"parameters": [],
"responses": {
"201": {
"description": "alert urgency created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "0bc47188-afcb-4df2-8439-e84c4d0bb7df",
"type": "alert_urgencies",
"attributes": {
"name": "High",
"description": "Hight alert urgency",
"position": 1,
"created_at": "2025-07-12T00:11:57.577-07:00",
"updated_at": "2025-07-12T00:11:57.577-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/alert_urgency_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
},
{
"title": "Description can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_alert_urgency"
}
}
},
"required": true
}
},
"get": {
"summary": "List alert urgencies",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertUrgencies"
],
"description": "List alert urgencies",
"operationId": "listAlertUrgencies",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_urgency_list"
}
}
}
}
}
}
},
"/v1/alert_urgencies/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an alert urgency",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertUrgencies"
],
"description": "Retrieves a specific alert urgency by id",
"operationId": "getAlertUrgency",
"responses": {
"200": {
"description": "alert urgency found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "d899a303-6b6e-4ea4-97a7-0b26c5d58ca0",
"type": "alert_urgencies",
"attributes": {
"name": "13qfp",
"description": "Corrupti excepturi officiis consectetur.",
"position": 1,
"created_at": "2025-07-12T00:11:55.126-07:00",
"updated_at": "2025-07-12T00:11:55.130-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/alert_urgency_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an alert urgency",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertUrgencies"
],
"description": "Update a specific alert urgency by id",
"operationId": "updateAlertUrgency",
"parameters": [],
"responses": {
"200": {
"description": "alert urgency updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "d899a303-6b6e-4ea4-97a7-0b26c5d58ca0",
"type": "alert_urgencies",
"attributes": {
"name": "High (Updated)",
"description": "Corrupti excepturi officiis consectetur.",
"position": 2,
"created_at": "2025-07-12T00:11:55.126-07:00",
"updated_at": "2025-07-12T00:11:58.638-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/alert_urgency_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_alert_urgency"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an alert urgency",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertUrgencies"
],
"description": "Delete a specific alert urgency by id",
"operationId": "deleteAlertUrgency",
"responses": {
"200": {
"description": "alert urgency deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "d899a303-6b6e-4ea4-97a7-0b26c5d58ca0",
"type": "alert_urgencies",
"attributes": {
"name": "13qfp",
"description": "Corrupti excepturi officiis consectetur.",
"position": 1,
"created_at": "2025-07-12T00:11:55.126-07:00",
"updated_at": "2025-07-12T00:11:59.119-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/alert_urgency_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/alert_sources": {
"post": {
"summary": "Creates an alert source",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertSources"
],
"description": "Creates a new alert source from provided data",
"operationId": "createAlertsSource",
"parameters": [],
"responses": {
"201": {
"description": "alert source created with resolution rule",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "5d8f6acf-7010-4336-b836-a9991745ebfc",
"type": "alert_sources",
"attributes": {
"name": "Email Source 1",
"source_type": "email",
"status": "setup_incomplete",
"secret": "e3d34558c0b6ac6391d9ec2f00eee4d72d7f1b28113d93b18e8c446be0354c46",
"alert_urgency_id": "0a22b7cd-04d0-4150-bb3d-fc1960cad7bd",
"created_at": "2025-07-12T00:12:04.061-07:00",
"updated_at": "2025-07-12T00:12:04.064-07:00",
"webhook_endpoint": "http://localhost:3001/webhooks/incoming/generic_webhooks/notify/<TYPE>/<ID>",
"owner_group_ids": [],
"alert_source_urgency_rules_attributes": [],
"alert_source_fields_attributes": [
{
"template_body": null,
"created_at": "2025-07-12T00:12:04.070-07:00",
"updated_at": "2025-07-12T00:12:04.070-07:00",
"alert_field_id": "75dacb6e-ab8b-4c68-a363-52677a57004f",
"alert_field": {
"id": "75dacb6e-ab8b-4c68-a363-52677a57004f",
"slug": "description-field",
"name": "Description Field",
"kind": "description",
"created_at": "2025-07-12T00:12:00.534-07:00",
"updated_at": "2025-07-12T00:12:00.534-07:00"
}
},
{
"template_body": null,
"created_at": "2025-07-12T00:12:04.074-07:00",
"updated_at": "2025-07-12T00:12:04.074-07:00",
"alert_field_id": "f9335b26-05db-4c5a-8676-38d7b9774096",
"alert_field": {
"id": "f9335b26-05db-4c5a-8676-38d7b9774096",
"slug": "title-field",
"name": "Title Field",
"kind": "title",
"created_at": "2025-07-12T00:12:00.530-07:00",
"updated_at": "2025-07-12T00:12:00.530-07:00"
}
}
],
"sourceable_attributes": null,
"alert_template_attributes": null,
"resolution_rule_attributes": {
"id": "c91cf9fc-1cbe-4143-a934-946f3afb0d5c",
"enabled": true,
"condition_type": "all",
"identifier_json_path": "$.email.subject",
"identifier_value_regex": "",
"identifier_matchable_type": null,
"identifier_matchable_id": null,
"identifier_reference_kind": "payload",
"conditions_attributes": [
{
"id": "47410a96-9ce6-4071-acf4-23f9f5dc6314",
"field": "$.email.subject",
"operator": "is",
"value": "Resolved",
"conditionable_type": null,
"conditionable_id": null,
"kind": "payload"
}
]
},
"email": "email-source-de4931db1f8447a208253048a95fde55@test.email.rootly.com",
"accept_threaded_emails": false
},
"relationships": {
"alert_source_urgency_rules": {
"data": []
},
"alert_source_fields": {
"data": [
{
"id": "07a358db-8dc5-480c-b442-0f1fcb049f09",
"template_body": null,
"alerts_source_id": "5d8f6acf-7010-4336-b836-a9991745ebfc",
"alert_field_id": "75dacb6e-ab8b-4c68-a363-52677a57004f",
"deleted_at": null,
"created_at": "2025-07-12T00:12:04.070-07:00",
"updated_at": "2025-07-12T00:12:04.070-07:00",
"position": 1
},
{
"id": "76bc7dd0-29e3-4c99-ae00-d276c97e0b24",
"template_body": null,
"alerts_source_id": "5d8f6acf-7010-4336-b836-a9991745ebfc",
"alert_field_id": "f9335b26-05db-4c5a-8676-38d7b9774096",
"deleted_at": null,
"created_at": "2025-07-12T00:12:04.074-07:00",
"updated_at": "2025-07-12T00:12:04.074-07:00",
"position": 2
}
]
}
}
}
},
"schema": {
"$ref": "#/components/schemas/alerts_source_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_alerts_source"
}
}
},
"required": true
}
},
"get": {
"summary": "List alert sources",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertSources"
],
"description": "List alert sources",
"operationId": "listAlertsSources",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[statuses]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[source_types]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alerts_source_list"
}
}
}
}
}
}
},
"/v1/alert_sources/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an alert source",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertSources"
],
"description": "Retrieves a specific alert source by id",
"operationId": "getAlertsSource",
"responses": {
"200": {
"description": "alert source found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "6b542202-673b-45e7-92a1-f41558f0cad9",
"type": "alert_sources",
"attributes": {
"name": "Alert Source 4",
"source_type": "datadog",
"status": "setup_incomplete",
"secret": "aa124ead1b95214857c935b75a1dc438e25604c07fb6822f978061b2b36dbb7f",
"alert_urgency_id": "0a22b7cd-04d0-4150-bb3d-fc1960cad7bd",
"created_at": "2025-07-12T00:12:00.368-07:00",
"updated_at": "2025-07-12T00:12:00.368-07:00",
"webhook_endpoint": "http://localhost:3001/webhooks/incoming/datadog_webhooks/notify/<TYPE>/<ID>",
"owner_group_ids": [],
"alert_source_urgency_rules_attributes": [],
"alert_source_fields_attributes": [],
"sourceable_attributes": null,
"alert_template_attributes": null,
"resolution_rule_attributes": null
},
"relationships": {
"alert_source_urgency_rules": {
"data": []
},
"alert_source_fields": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/alerts_source_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an alert source",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertSources"
],
"description": "Update a specific alert source by id",
"operationId": "updateAlertsSource",
"parameters": [],
"responses": {
"200": {
"description": "alert source updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "2ab7f4f2-a1d9-41f7-8db9-bb25a7412f56",
"type": "alert_sources",
"attributes": {
"name": "GW 2",
"source_type": "generic_webhook",
"status": "setup_incomplete",
"secret": "176c574711f2ab642450663d9e51d416ad923fe7fc33ee19d0e8f777bc6a0c78",
"alert_urgency_id": "0a22b7cd-04d0-4150-bb3d-fc1960cad7bd",
"created_at": "2025-07-12T00:12:06.039-07:00",
"updated_at": "2025-07-12T00:12:06.188-07:00",
"webhook_endpoint": "http://localhost:3001/webhooks/incoming/generic_webhooks/notify/<TYPE>/<ID>",
"owner_group_ids": [],
"alert_source_urgency_rules_attributes": [
{
"id": "7866a48e-90ac-4444-83a4-2062c0736936",
"json_path": "$.alert.status",
"operator": "is",
"value": "Critical",
"alert_urgency_id": "11324922-3398-473c-b81c-c5bc059e2354",
"alerts_source_id": "2ab7f4f2-a1d9-41f7-8db9-bb25a7412f56",
"created_at": "2025-07-12T00:12:06.189-07:00",
"updated_at": "2025-07-12T00:12:06.189-07:00",
"conditionable_type": null,
"conditionable_id": null,
"kind": "payload"
}
],
"alert_source_fields_attributes": [
{
"template_body": null,
"created_at": "2025-07-12T00:12:06.044-07:00",
"updated_at": "2025-07-12T00:12:06.044-07:00",
"alert_field_id": "75dacb6e-ab8b-4c68-a363-52677a57004f",
"alert_field": {
"id": "75dacb6e-ab8b-4c68-a363-52677a57004f",
"slug": "description-field",
"name": "Description Field",
"kind": "description",
"created_at": "2025-07-12T00:12:00.534-07:00",
"updated_at": "2025-07-12T00:12:00.534-07:00"
}
},
{
"template_body": null,
"created_at": "2025-07-12T00:12:06.047-07:00",
"updated_at": "2025-07-12T00:12:06.047-07:00",
"alert_field_id": "f9335b26-05db-4c5a-8676-38d7b9774096",
"alert_field": {
"id": "f9335b26-05db-4c5a-8676-38d7b9774096",
"slug": "title-field",
"name": "Title Field",
"kind": "title",
"created_at": "2025-07-12T00:12:00.530-07:00",
"updated_at": "2025-07-12T00:12:00.530-07:00"
}
}
],
"sourceable_attributes": {
"id": "3eaaebb2-c056-4929-8609-1a98f325ca81",
"auto_resolve": false,
"resolve_state": null,
"created_at": "2025-07-12T00:12:06.022-07:00",
"updated_at": "2025-07-12T00:12:06.022-07:00",
"field_mappings_attributes": [],
"field_mappings": []
},
"alert_template_attributes": null,
"resolution_rule_attributes": null
},
"relationships": {
"alert_source_urgency_rules": {
"data": [
{
"id": "7866a48e-90ac-4444-83a4-2062c0736936",
"alerts_source_id": "2ab7f4f2-a1d9-41f7-8db9-bb25a7412f56",
"alert_urgency_id": "11324922-3398-473c-b81c-c5bc059e2354",
"json_path": "$.alert.status",
"operator": "is",
"value": "Critical",
"deleted_at": null,
"created_at": "2025-07-12T00:12:06.189-07:00",
"updated_at": "2025-07-12T00:12:06.189-07:00",
"conditionable_type": null,
"conditionable_id": null,
"kind": "payload",
"position": 1
}
]
},
"alert_source_fields": {
"data": [
{
"id": "12ccebf1-65b7-4307-a8b0-57de610dac34",
"template_body": null,
"alerts_source_id": "2ab7f4f2-a1d9-41f7-8db9-bb25a7412f56",
"alert_field_id": "75dacb6e-ab8b-4c68-a363-52677a57004f",
"deleted_at": null,
"created_at": "2025-07-12T00:12:06.044-07:00",
"updated_at": "2025-07-12T00:12:06.044-07:00",
"position": 1
},
{
"id": "ff3d86c6-eb9d-44cc-9c2f-19cbba68c40d",
"template_body": null,
"alerts_source_id": "2ab7f4f2-a1d9-41f7-8db9-bb25a7412f56",
"alert_field_id": "f9335b26-05db-4c5a-8676-38d7b9774096",
"deleted_at": null,
"created_at": "2025-07-12T00:12:06.047-07:00",
"updated_at": "2025-07-12T00:12:06.047-07:00",
"position": 2
}
]
}
}
}
},
"schema": {
"$ref": "#/components/schemas/alerts_source_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_alerts_source"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an alert source",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertSources"
],
"description": "Delete a specific alert source by id",
"operationId": "deleteAlertsSource",
"responses": {
"200": {
"description": "alert source deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "6b542202-673b-45e7-92a1-f41558f0cad9",
"type": "alert_sources",
"attributes": {
"name": "Alert Source 4",
"source_type": "datadog",
"status": "setup_incomplete",
"secret": "aa124ead1b95214857c935b75a1dc438e25604c07fb6822f978061b2b36dbb7f",
"alert_urgency_id": "0a22b7cd-04d0-4150-bb3d-fc1960cad7bd",
"created_at": "2025-07-12T00:12:00.368-07:00",
"updated_at": "2025-07-12T00:12:06.736-07:00",
"webhook_endpoint": "http://localhost:3001/webhooks/incoming/datadog_webhooks/notify/<TYPE>/<ID>",
"owner_group_ids": [],
"alert_source_urgency_rules_attributes": [],
"alert_source_fields_attributes": [],
"sourceable_attributes": null,
"alert_template_attributes": null,
"resolution_rule_attributes": null
},
"relationships": {
"alert_source_urgency_rules": {
"data": []
},
"alert_source_fields": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/alerts_source_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incidents/{incident_id}/alerts": {
"parameters": [
{
"name": "incident_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Attach alerts to an incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Alerts"
],
"description": "Attach alerts to an incident from provided data",
"operationId": "attachAlert",
"parameters": [],
"responses": {
"200": {
"description": "alert created",
"content": {
"application/vnd.api+json": {
"example": {
"data": [
{
"id": "32e5e11d-5c13-47c7-ae88-65aa16179cf8",
"type": "alerts",
"attributes": {
"short_id": "5za6y4",
"source": "pagerduty",
"status": "open",
"summary": "Voluptas nostrum ullam maxime.",
"description": "Cum qui eveniet. Voluptatibus voluptatum velit. A non illum.",
"labels": [],
"services": [],
"service_ids": [],
"groups": [],
"group_ids": [],
"environments": [],
"environment_ids": [],
"responders": [],
"incidents": [
{
"id": "8fc01637-ca0a-4a5d-a165-cc1e71bcd173",
"user_id": 29,
"team_id": 16,
"title": "Facere et dolor et.",
"slug": "facere-et-dolor-et",
"summary": "Consequatur ducimus qui. Architecto eligendi sunt. Optio dicta molestiae.",
"status": "started",
"slack_channel_id": null,
"started_at": "2025-07-12T00:12:08.349-07:00",
"mitigated_at": null,
"resolved_at": null,
"deleted_at": null,
"created_at": "2025-07-12T00:12:08.349-07:00",
"updated_at": "2025-07-12T00:12:13.721-07:00",
"severity_id": "ae1e4e5b-623a-466b-9995-3cfe59138dc9",
"public_title": null,
"zoom_meeting_id": null,
"zoom_meeting_start_url": null,
"zoom_meeting_join_url": null,
"shortcut_story_id": null,
"shortcut_story_url": null,
"asana_task_id": null,
"asana_task_url": null,
"jira_issue_id": null,
"jira_issue_url": null,
"email_message_id": 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,
"slack_channel_name": null,
"service_now_incident_id": null,
"service_now_incident_url": null,
"opsgenie_incident_id": null,
"opsgenie_incident_url": null,
"opsgenie_incident_responder_ids": [],
"labels": {},
"incidents_action_items_count": 0,
"incidents_tasks_count": 0,
"mitigation_message": null,
"resolution_message": null,
"pagerduty_incident_responder_ids": {},
"victor_ops_incident_id": null,
"victor_ops_incident_url": null,
"victor_ops_incident_responder_ids": {},
"pagerduty_incident_id": null,
"pagerduty_incident_url": null,
"status_pages_count": 0,
"mattermost_channel_id": null,
"slack_summary_timestamp": null,
"mattermost_channel_name": null,
"mattermost_channel_url": null,
"slack_channel_url": null,
"mattermost_summary_timestamp": null,
"confluence_page_id": null,
"confluence_page_url": null,
"kind": "normal",
"scheduled_for": null,
"scheduled_until": null,
"scheduled_remind_prior": false,
"scheduled_auto_in_progress": true,
"scheduled_auto_completed": true,
"detected_at": null,
"acknowledged_at": null,
"private": false,
"airtable_record_id": null,
"airtable_record_url": null,
"google_drive_id": null,
"google_drive_url": null,
"summary_updated_at": null,
"sequential_id": 1,
"slack_channels": [],
"airtable_base_key": null,
"airtable_table_name": null,
"shortcut_task_id": null,
"shortcut_task_url": null,
"title_autogenerated": false,
"view_source": null,
"source": "web",
"microsoft_teams_meeting_url": null,
"microsoft_teams_meeting_id": null,
"dropbox_paper_id": null,
"dropbox_paper_url": null,
"subscribers_count": 0,
"status_page_io": {},
"webex_meeting_id": null,
"webex_meeting_url": null,
"github_issue_id": null,
"github_issue_url": null,
"cancelled_at": null,
"cancellation_message": null,
"notion_page_id": null,
"notion_page_url": null,
"datadog_notebook_id": null,
"datadog_notebook_url": null,
"notify_channels": {},
"freshservice_ticket_id": null,
"freshservice_ticket_url": null,
"freshservice_task_id": null,
"freshservice_task_url": null,
"started_by_user_id": 29,
"mitigated_by_user_id": null,
"resolved_by_user_id": null,
"cancelled_by_user_id": null,
"slack_aliases": [],
"slack_channel_workspace_id": null,
"google_calendar_event_url": null,
"google_calendar_event_id": null,
"short_url": null,
"slack_channel_short_url": null,
"go_to_meeting_id": null,
"go_to_meeting_url": null,
"jira_issue_key": null,
"linear_issue_key": null,
"opsgenie_alert_id": null,
"opsgenie_alert_url": null,
"triggered_from_slack_channel_id": null,
"service_now_incident_key": null,
"quip_page_id": null,
"quip_page_url": null,
"pagertree_alert_id": null,
"pagertree_alert_url": null,
"duplicate_incident_id": null,
"parent_incident_id": null,
"ability_cache": null,
"previous_attributes": {
"updated_at": "2025-07-12T00:12:11.932-07:00",
"incident_events": [
"Alerts has been attached: <a class=\"badge badge-warning \" target=\"_blank\" data-toggle=\"tooltip\" data-placement=\"top\" data-title=\"[Pagerduty] Voluptas Nostrum Ullam Maxime.\" href=\"http://kassulke.example/colby.abernathy\">[Pagerduty] Voluptas Nostrum Ullam Maxime.</a><a class=\"badge badge-warning \" target=\"_blank\" data-toggle=\"tooltip\" data-placement=\"top\" data-title=\"[Pagerduty] Quae Et Similique Nostrum.\" href=\"http://hagenes.test/jeanine\">[Pagerduty] Quae Et Similique Nostrum.</a><a class=\"badge badge-warning \" target=\"_blank\" data-toggle=\"tooltip\" data-placement=\"top\" data-title=\"[Pagerduty] Rerum Error Sed Amet.\" href=\"http://romaguera-tromp.test/louetta.dooley\">[Pagerduty] Rerum Error Sed Amet.</a>",
"Started date has been set to <span class=\"badge badge-info-inverted\">July 12 12:12 AM PDT</span>",
"Bob Schinner created this incident"
],
"user_avatar_url": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KICAgICAg\nPHN2ZyB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8y\nMDAwL3N2ZyIgd2lkdGg9IjIwMCIgaGVpZ2h0PSIyMDAiIHZpZXdCb3g9IjAg\nMCAyMDAgMjAwIj4KICAgICAgICA8bGluZWFyR3JhZGllbnQgaWQ9ImdyYWRp\nZW50XzE3NTIzMDQzMzNfMjUyNDQzIiBncmFkaWVudFRyYW5zZm9ybT0icm90\nYXRlKDEyMCkiPgogICAgICAgICAgPHN0b3Agc3RvcC1jb2xvcj0iI2ViMzM0\nOSIgb2Zmc2V0PSIwJSIgLz4KICAgICAgICAgIDxzdG9wIHN0b3AtY29sb3I9\nIiNlYjMzNDkiIG9mZnNldD0iMTAwJSIgLz4KICAgICAgICA8L2xpbmVhckdy\nYWRpZW50PgogICAgICAgIDxyZWN0IHdpZHRoPSIxMDAlIiBoZWlnaHQ9IjEw\nMCUiIGZpbGw9InVybCgjZ3JhZGllbnRfMTc1MjMwNDMzM18yNTI0NDMpIiAv\nPgogICAgICAgIDx0ZXh0IGZpbGw9IiNGRkYiIGZvbnQtZmFtaWx5PSJPcGVu\nIFNhbnMsSGVsdmV0aWNhLEFyaWFsLHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0i\nMTAxIiBmb250LXdlaWdodD0iNTAwIiB4PSI1MCUiIHk9IjU1JSIgZG9taW5h\nbnQtYmFzZWxpbmU9Im1pZGRsZSIgdGV4dC1hbmNob3I9Im1pZGRsZSI+CiAg\nICAgICAgICBCUwogICAgICAgIDwvdGV4dD4KICAgICAgPC9zdmc+CiAgICA=\n"
},
"genius_workflow_runs_count": 0,
"slack_channel_archived": false,
"google_drive_parent_id": null,
"in_triage_at": null,
"in_triage_by_user_id": null,
"external_id": null,
"slack_channel_deep_link": null,
"retrospective_progress_status": "not_started",
"users_assigned_count": 0,
"retrospective_completed_at": null,
"retrospective_started_at": null,
"pagerduty_incident_number": null,
"current_tutorial_step": "not_started",
"clickup_task_id": null,
"clickup_task_url": null,
"slack_notify_ready_for_retrospective_timestamp": null,
"notify_emails": [],
"status_page_io_components": [],
"retrospective_auto_skipped": false,
"retrospective_mandatory": false,
"embedding": null,
"zoom_meeting_transcript": {},
"google_meeting_transcript": {},
"webex_meeting_transcript": {},
"microsoft_teams_meeting_transcript": {},
"zoom_meeting_bot_id": null,
"google_meeting_bot_id": null,
"webex_meeting_bot_id": null,
"microsoft_teams_meeting_bot_id": null,
"zoom_meeting_transcript_summary": null,
"google_meeting_transcript_summary": null,
"webex_meeting_transcript_summary": null,
"microsoft_teams_meeting_transcript_summary": null,
"gitlab_issue_id": null,
"gitlab_issue_url": null,
"outlook_event_id": null,
"outlook_event_url": null,
"sharepoint_page_id": null,
"sharepoint_page_url": null,
"created_from_slack_identifier": null,
"zoom_meeting_pstn_password": null,
"zoom_meeting_h323_password": null,
"zoom_meeting_global_dial_in_numbers": [],
"left_slack_channel_slack_user_ids": [],
"using_redesigned_slack_announcement": true,
"using_redesigned_slack_updates": true,
"motion_task_id": null,
"motion_task_url": null,
"sub_status_id": "dabb589c-8d20-4e85-a016-0ddf0b99baf4",
"closed_at": null,
"closed_by_user_id": null,
"microsoft_teams_channel_id": null,
"microsoft_teams_channel_name": null,
"microsoft_teams_channel_url": null,
"microsoft_teams_channel_short_url": null,
"microsoft_teams_team_id": null,
"triggered_from_microsoft_teams_channel_id": null,
"microsoft_teams_summary_message_id": null,
"slack_last_message_ts": null,
"zoom_meeting_password": null,
"microsoft_teams_channel_service_url": null,
"microsoft_teams_team_internal_id": null,
"triggered_from_slack_message_ts": null,
"triggered_from_slack_thread_ts": null,
"sub_incidents_count": 0,
"coda_doc_id": null,
"coda_doc_url": null,
"coda_page_id": null,
"raw_labels": null,
"tutorial_steps": null
}
],
"data": {},
"started_at": "2025-07-12T00:12:10.888-07:00",
"ended_at": null,
"external_id": null,
"external_url": "http://kassulke.example/colby.abernathy",
"url": "https://test.rootly.com/account/alerts/32e5e11d-5c13-47c7-ae88-65aa16179cf8",
"noise": "not_noise",
"notification_target_type": null,
"notification_target_id": null,
"alert_urgency_id": "f9236d15-ece2-480a-b9ac-a6172e95ecb5",
"notified_users": [],
"created_at": "2025-07-12T00:12:10.888-07:00",
"updated_at": "2025-07-12T00:12:10.888-07:00"
}
}
],
"links": {
"self": "http://www.example.com/v1/incidents/8fc01637-ca0a-4a5d-a165-cc1e71bcd173/alerts?page%5Bnumber%5D=1&page%5Bsize%5D=10",
"first": "http://www.example.com/v1/incidents/8fc01637-ca0a-4a5d-a165-cc1e71bcd173/alerts?page%5Bnumber%5D=1&page%5Bsize%5D=10",
"prev": null,
"next": null,
"last": "http://www.example.com/v1/incidents/8fc01637-ca0a-4a5d-a165-cc1e71bcd173/alerts?page%5Bnumber%5D=1&page%5Bsize%5D=10"
}
},
"schema": {
"$ref": "#/components/schemas/alert_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/attach_alert"
}
}
},
"required": true
}
},
"get": {
"summary": "List Incident alerts",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Alerts"
],
"description": "List incident alerts",
"operationId": "listIncidentAlerts",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[source]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[services]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environments]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[groups]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[labels]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[ended_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[ended_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[ended_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[ended_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_list"
}
}
}
}
}
}
},
"/v1/alerts": {
"post": {
"summary": "Creates an alert",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Alerts"
],
"description": "Creates a new alert from provided data",
"operationId": "createAlert",
"parameters": [],
"responses": {
"201": {
"description": "alert created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "94af95e6-21fb-4a25-a00f-0fae2801cabf",
"type": "alerts",
"attributes": {
"short_id": null,
"source": "asana",
"status": "open",
"summary": "Asana ticket created",
"description": null,
"labels": [
{
"key": "status",
"value": "succeeded"
}
],
"services": [
{
"id": "13ebbd5d-5bb7-4219-8eef-e10b59486290",
"team_id": 16,
"name": "Quas excepturi totam delectus.",
"slug": "quas-excepturi-totam-delectus",
"description": "Numquam modi et consequuntur.",
"deleted_at": null,
"created_at": "2025-07-12T00:12:12.890-07:00",
"updated_at": "2025-07-12T00:12:12.890-07:00",
"opsgenie_id": null,
"pagerduty_id": null,
"public_description": null,
"github_repository_branch": "master",
"github_repository_name": null,
"color": "#D7E7F5",
"heroku_app_name": null,
"gitlab_repository_name": null,
"gitlab_repository_branch": "master",
"kubernetes_deployment_name": null,
"incidents_count": 0,
"position": 1,
"slack_channels": [],
"slack_aliases": [],
"backstage_id": null,
"show_uptime": true,
"show_uptime_last_days": 60,
"status": "operational",
"external_id": null,
"notify_emails": [],
"cortex_id": null,
"alerts_email_enabled": false,
"alerts_email_address": "service-a53c6a5b2d0a161cf1d22b1f57338b70@email.rootly.com",
"opsgenie_team_id": null,
"service_now_ci_sys_id": null,
"alert_urgency_id": null,
"opslevel_id": null,
"datadog_id": null
}
],
"service_ids": [
"13ebbd5d-5bb7-4219-8eef-e10b59486290"
],
"groups": [],
"group_ids": [],
"environments": [
{
"id": "cf890616-9489-41ca-ac2b-58d30aa4dc9b",
"team_id": 16,
"name": "Sed minima et sed.",
"slug": "sed-minima-et-sed",
"description": "Officia nam commodi eos.",
"color": "#172121",
"deleted_at": null,
"created_at": "2025-07-12T00:12:12.914-07:00",
"updated_at": "2025-07-12T00:12:12.914-07:00",
"incidents_count": 0,
"position": 1,
"slack_channels": [],
"slack_aliases": [],
"external_id": null,
"notify_emails": []
}
],
"environment_ids": [
"cf890616-9489-41ca-ac2b-58d30aa4dc9b"
],
"responders": [],
"incidents": [],
"data": {
"url": "https://asana.com/issues/1"
},
"started_at": "2025-07-12T00:09:32.000-07:00",
"ended_at": "2025-07-12T00:11:32.000-07:00",
"external_id": null,
"external_url": null,
"url": "https://test.rootly.com/account/alerts/94af95e6-21fb-4a25-a00f-0fae2801cabf",
"noise": "not_noise",
"notification_target_type": null,
"notification_target_id": null,
"alert_urgency_id": "8aad6c41-e6b2-4ca7-a180-b8e950327d3a",
"notified_users": [],
"created_at": "2025-07-12T00:12:14.875-07:00",
"updated_at": "2025-07-12T00:12:14.875-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/alert_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Summary can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_alert"
}
}
},
"required": true
}
},
"get": {
"summary": "List alerts",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Alerts"
],
"description": "List alerts",
"operationId": "listAlerts",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[status]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "filter by status",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_list"
}
}
}
}
}
}
},
"/v1/alerts/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an alert",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Alerts"
],
"description": "Retrieves a specific alert by id",
"operationId": "getAlert",
"responses": {
"200": {
"description": "alert found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "32e5e11d-5c13-47c7-ae88-65aa16179cf8",
"type": "alerts",
"attributes": {
"short_id": "5za6y4",
"source": "pagerduty",
"status": "open",
"summary": "Voluptas nostrum ullam maxime.",
"description": "Cum qui eveniet. Voluptatibus voluptatum velit. A non illum.",
"labels": [],
"services": [],
"service_ids": [],
"groups": [],
"group_ids": [],
"environments": [],
"environment_ids": [],
"responders": [],
"incidents": [
{
"id": "8fc01637-ca0a-4a5d-a165-cc1e71bcd173",
"user_id": 29,
"team_id": 16,
"title": "Facere et dolor et.",
"slug": "facere-et-dolor-et",
"summary": "Consequatur ducimus qui. Architecto eligendi sunt. Optio dicta molestiae.",
"status": "started",
"slack_channel_id": null,
"started_at": "2025-07-12T00:12:08.349-07:00",
"mitigated_at": null,
"resolved_at": null,
"deleted_at": null,
"created_at": "2025-07-12T00:12:08.349-07:00",
"updated_at": "2025-07-12T00:12:11.932-07:00",
"severity_id": "ae1e4e5b-623a-466b-9995-3cfe59138dc9",
"public_title": null,
"zoom_meeting_id": null,
"zoom_meeting_start_url": null,
"zoom_meeting_join_url": null,
"shortcut_story_id": null,
"shortcut_story_url": null,
"asana_task_id": null,
"asana_task_url": null,
"jira_issue_id": null,
"jira_issue_url": null,
"email_message_id": 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,
"slack_channel_name": null,
"service_now_incident_id": null,
"service_now_incident_url": null,
"opsgenie_incident_id": null,
"opsgenie_incident_url": null,
"opsgenie_incident_responder_ids": [],
"labels": {},
"incidents_action_items_count": 0,
"incidents_tasks_count": 0,
"mitigation_message": null,
"resolution_message": null,
"pagerduty_incident_responder_ids": {},
"victor_ops_incident_id": null,
"victor_ops_incident_url": null,
"victor_ops_incident_responder_ids": {},
"pagerduty_incident_id": null,
"pagerduty_incident_url": null,
"status_pages_count": 0,
"mattermost_channel_id": null,
"slack_summary_timestamp": null,
"mattermost_channel_name": null,
"mattermost_channel_url": null,
"slack_channel_url": null,
"mattermost_summary_timestamp": null,
"confluence_page_id": null,
"confluence_page_url": null,
"kind": "normal",
"scheduled_for": null,
"scheduled_until": null,
"scheduled_remind_prior": false,
"scheduled_auto_in_progress": true,
"scheduled_auto_completed": true,
"detected_at": null,
"acknowledged_at": null,
"private": false,
"airtable_record_id": null,
"airtable_record_url": null,
"google_drive_id": null,
"google_drive_url": null,
"summary_updated_at": null,
"sequential_id": 1,
"slack_channels": [],
"airtable_base_key": null,
"airtable_table_name": null,
"shortcut_task_id": null,
"shortcut_task_url": null,
"title_autogenerated": false,
"view_source": null,
"source": "web",
"microsoft_teams_meeting_url": null,
"microsoft_teams_meeting_id": null,
"dropbox_paper_id": null,
"dropbox_paper_url": null,
"subscribers_count": 0,
"status_page_io": {},
"webex_meeting_id": null,
"webex_meeting_url": null,
"github_issue_id": null,
"github_issue_url": null,
"cancelled_at": null,
"cancellation_message": null,
"notion_page_id": null,
"notion_page_url": null,
"datadog_notebook_id": null,
"datadog_notebook_url": null,
"notify_channels": {},
"freshservice_ticket_id": null,
"freshservice_ticket_url": null,
"freshservice_task_id": null,
"freshservice_task_url": null,
"started_by_user_id": 29,
"mitigated_by_user_id": null,
"resolved_by_user_id": null,
"cancelled_by_user_id": null,
"slack_aliases": [],
"slack_channel_workspace_id": null,
"google_calendar_event_url": null,
"google_calendar_event_id": null,
"short_url": null,
"slack_channel_short_url": null,
"go_to_meeting_id": null,
"go_to_meeting_url": null,
"jira_issue_key": null,
"linear_issue_key": null,
"opsgenie_alert_id": null,
"opsgenie_alert_url": null,
"triggered_from_slack_channel_id": null,
"service_now_incident_key": null,
"quip_page_id": null,
"quip_page_url": null,
"pagertree_alert_id": null,
"pagertree_alert_url": null,
"duplicate_incident_id": null,
"parent_incident_id": null,
"ability_cache": null,
"previous_attributes": {
"updated_at": "2025-07-12T00:12:08.475-07:00",
"incident_events": [
"Started date has been set to <span class=\"badge badge-info-inverted\">July 12 12:12 AM PDT</span>",
"Bob Schinner created this incident"
],
"user_avatar_url": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KICAgICAg\nPHN2ZyB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8y\nMDAwL3N2ZyIgd2lkdGg9IjIwMCIgaGVpZ2h0PSIyMDAiIHZpZXdCb3g9IjAg\nMCAyMDAgMjAwIj4KICAgICAgICA8bGluZWFyR3JhZGllbnQgaWQ9ImdyYWRp\nZW50XzE3NTIzMDQzMzFfNDMwMTc0IiBncmFkaWVudFRyYW5zZm9ybT0icm90\nYXRlKDEyMCkiPgogICAgICAgICAgPHN0b3Agc3RvcC1jb2xvcj0iI2ViMzM0\nOSIgb2Zmc2V0PSIwJSIgLz4KICAgICAgICAgIDxzdG9wIHN0b3AtY29sb3I9\nIiNlYjMzNDkiIG9mZnNldD0iMTAwJSIgLz4KICAgICAgICA8L2xpbmVhckdy\nYWRpZW50PgogICAgICAgIDxyZWN0IHdpZHRoPSIxMDAlIiBoZWlnaHQ9IjEw\nMCUiIGZpbGw9InVybCgjZ3JhZGllbnRfMTc1MjMwNDMzMV80MzAxNzQpIiAv\nPgogICAgICAgIDx0ZXh0IGZpbGw9IiNGRkYiIGZvbnQtZmFtaWx5PSJPcGVu\nIFNhbnMsSGVsdmV0aWNhLEFyaWFsLHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0i\nMTAxIiBmb250LXdlaWdodD0iNTAwIiB4PSI1MCUiIHk9IjU1JSIgZG9taW5h\nbnQtYmFzZWxpbmU9Im1pZGRsZSIgdGV4dC1hbmNob3I9Im1pZGRsZSI+CiAg\nICAgICAgICBCUwogICAgICAgIDwvdGV4dD4KICAgICAgPC9zdmc+CiAgICA=\n"
},
"genius_workflow_runs_count": 0,
"slack_channel_archived": false,
"google_drive_parent_id": null,
"in_triage_at": null,
"in_triage_by_user_id": null,
"external_id": null,
"slack_channel_deep_link": null,
"retrospective_progress_status": "not_started",
"users_assigned_count": 0,
"retrospective_completed_at": null,
"retrospective_started_at": null,
"pagerduty_incident_number": null,
"current_tutorial_step": "not_started",
"clickup_task_id": null,
"clickup_task_url": null,
"slack_notify_ready_for_retrospective_timestamp": null,
"notify_emails": [],
"status_page_io_components": [],
"retrospective_auto_skipped": false,
"retrospective_mandatory": false,
"embedding": null,
"zoom_meeting_transcript": {},
"google_meeting_transcript": {},
"webex_meeting_transcript": {},
"microsoft_teams_meeting_transcript": {},
"zoom_meeting_bot_id": null,
"google_meeting_bot_id": null,
"webex_meeting_bot_id": null,
"microsoft_teams_meeting_bot_id": null,
"zoom_meeting_transcript_summary": null,
"google_meeting_transcript_summary": null,
"webex_meeting_transcript_summary": null,
"microsoft_teams_meeting_transcript_summary": null,
"gitlab_issue_id": null,
"gitlab_issue_url": null,
"outlook_event_id": null,
"outlook_event_url": null,
"sharepoint_page_id": null,
"sharepoint_page_url": null,
"created_from_slack_identifier": null,
"zoom_meeting_pstn_password": null,
"zoom_meeting_h323_password": null,
"zoom_meeting_global_dial_in_numbers": [],
"left_slack_channel_slack_user_ids": [],
"using_redesigned_slack_announcement": true,
"using_redesigned_slack_updates": true,
"motion_task_id": null,
"motion_task_url": null,
"sub_status_id": "dabb589c-8d20-4e85-a016-0ddf0b99baf4",
"closed_at": null,
"closed_by_user_id": null,
"microsoft_teams_channel_id": null,
"microsoft_teams_channel_name": null,
"microsoft_teams_channel_url": null,
"microsoft_teams_channel_short_url": null,
"microsoft_teams_team_id": null,
"triggered_from_microsoft_teams_channel_id": null,
"microsoft_teams_summary_message_id": null,
"slack_last_message_ts": null,
"zoom_meeting_password": null,
"microsoft_teams_channel_service_url": null,
"microsoft_teams_team_internal_id": null,
"triggered_from_slack_message_ts": null,
"triggered_from_slack_thread_ts": null,
"sub_incidents_count": 0,
"coda_doc_id": null,
"coda_doc_url": null,
"coda_page_id": null,
"raw_labels": null,
"tutorial_steps": null
}
],
"data": {},
"started_at": "2025-07-12T00:12:10.888-07:00",
"ended_at": null,
"external_id": null,
"external_url": "http://kassulke.example/colby.abernathy",
"url": "https://test.rootly.com/account/alerts/32e5e11d-5c13-47c7-ae88-65aa16179cf8",
"noise": "not_noise",
"notification_target_type": null,
"notification_target_id": null,
"alert_urgency_id": "f9236d15-ece2-480a-b9ac-a6172e95ecb5",
"notified_users": [],
"created_at": "2025-07-12T00:12:10.888-07:00",
"updated_at": "2025-07-12T00:12:10.888-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/alert_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"patch": {
"summary": "Update alert",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Alerts"
],
"description": "Updates an alert",
"operationId": "updateAlert",
"parameters": [],
"responses": {
"200": {
"description": "alert updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "32e5e11d-5c13-47c7-ae88-65aa16179cf8",
"type": "alerts",
"attributes": {
"short_id": "5za6y4",
"source": "pagerduty",
"status": "open",
"summary": "test update",
"description": "test update",
"labels": [
{
"key": "foo",
"value": "bar"
},
{
"key": "bar",
"value": "baz"
}
],
"services": [
{
"id": "13ebbd5d-5bb7-4219-8eef-e10b59486290",
"team_id": 16,
"name": "Quas excepturi totam delectus.",
"slug": "quas-excepturi-totam-delectus",
"description": "Numquam modi et consequuntur.",
"deleted_at": null,
"created_at": "2025-07-12T00:12:12.890-07:00",
"updated_at": "2025-07-12T00:12:12.890-07:00",
"opsgenie_id": null,
"pagerduty_id": null,
"public_description": null,
"github_repository_branch": "master",
"github_repository_name": null,
"color": "#D7E7F5",
"heroku_app_name": null,
"gitlab_repository_name": null,
"gitlab_repository_branch": "master",
"kubernetes_deployment_name": null,
"incidents_count": 0,
"position": 1,
"slack_channels": [],
"slack_aliases": [],
"backstage_id": null,
"show_uptime": true,
"show_uptime_last_days": 60,
"status": "operational",
"external_id": null,
"notify_emails": [],
"cortex_id": null,
"alerts_email_enabled": false,
"alerts_email_address": "service-a53c6a5b2d0a161cf1d22b1f57338b70@email.rootly.com",
"opsgenie_team_id": null,
"service_now_ci_sys_id": null,
"alert_urgency_id": null,
"opslevel_id": null,
"datadog_id": null
}
],
"service_ids": [
"13ebbd5d-5bb7-4219-8eef-e10b59486290"
],
"groups": [
{
"id": "c4e7a273-90c1-4fb6-9264-50e79284a6e8",
"name": "Aut ratione non tempore.",
"slug": "aut-ratione-non-tempore",
"team_id": 16,
"deleted_at": null,
"created_at": "2025-07-12T00:12:12.901-07:00",
"updated_at": "2025-07-12T00:12:12.901-07:00",
"description": null,
"opsgenie_id": null,
"users_count": 0,
"incidents_count": 0,
"pagerduty_id": null,
"color": "#F4CFD1",
"victor_ops_id": null,
"position": 1,
"slack_channels": [],
"slack_aliases": [],
"pagertree_id": null,
"external_id": null,
"notify_emails": [],
"cortex_id": null,
"backstage_id": null,
"alerts_email_enabled": false,
"alerts_email_address": "group-3f87af80b32f9be30cbb7920f1f26cb0@email.rootly.com",
"pagerduty_service_id": null,
"service_now_ci_sys_id": null,
"alert_urgency_id": null,
"opslevel_id": null,
"admins_count": 0
}
],
"group_ids": [
"c4e7a273-90c1-4fb6-9264-50e79284a6e8"
],
"environments": [
{
"id": "cf890616-9489-41ca-ac2b-58d30aa4dc9b",
"team_id": 16,
"name": "Sed minima et sed.",
"slug": "sed-minima-et-sed",
"description": "Officia nam commodi eos.",
"color": "#172121",
"deleted_at": null,
"created_at": "2025-07-12T00:12:12.914-07:00",
"updated_at": "2025-07-12T00:12:12.914-07:00",
"incidents_count": 0,
"position": 1,
"slack_channels": [],
"slack_aliases": [],
"external_id": null,
"notify_emails": []
}
],
"environment_ids": [
"cf890616-9489-41ca-ac2b-58d30aa4dc9b"
],
"responders": [],
"incidents": [
{
"id": "8fc01637-ca0a-4a5d-a165-cc1e71bcd173",
"user_id": 29,
"team_id": 16,
"title": "Facere et dolor et.",
"slug": "facere-et-dolor-et",
"summary": "Consequatur ducimus qui. Architecto eligendi sunt. Optio dicta molestiae.",
"status": "started",
"slack_channel_id": null,
"started_at": "2025-07-12T00:12:08.349-07:00",
"mitigated_at": null,
"resolved_at": null,
"deleted_at": null,
"created_at": "2025-07-12T00:12:08.349-07:00",
"updated_at": "2025-07-12T00:12:11.932-07:00",
"severity_id": "ae1e4e5b-623a-466b-9995-3cfe59138dc9",
"public_title": null,
"zoom_meeting_id": null,
"zoom_meeting_start_url": null,
"zoom_meeting_join_url": null,
"shortcut_story_id": null,
"shortcut_story_url": null,
"asana_task_id": null,
"asana_task_url": null,
"jira_issue_id": null,
"jira_issue_url": null,
"email_message_id": 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,
"slack_channel_name": null,
"service_now_incident_id": null,
"service_now_incident_url": null,
"opsgenie_incident_id": null,
"opsgenie_incident_url": null,
"opsgenie_incident_responder_ids": [],
"labels": {},
"incidents_action_items_count": 0,
"incidents_tasks_count": 0,
"mitigation_message": null,
"resolution_message": null,
"pagerduty_incident_responder_ids": {},
"victor_ops_incident_id": null,
"victor_ops_incident_url": null,
"victor_ops_incident_responder_ids": {},
"pagerduty_incident_id": null,
"pagerduty_incident_url": null,
"status_pages_count": 0,
"mattermost_channel_id": null,
"slack_summary_timestamp": null,
"mattermost_channel_name": null,
"mattermost_channel_url": null,
"slack_channel_url": null,
"mattermost_summary_timestamp": null,
"confluence_page_id": null,
"confluence_page_url": null,
"kind": "normal",
"scheduled_for": null,
"scheduled_until": null,
"scheduled_remind_prior": false,
"scheduled_auto_in_progress": true,
"scheduled_auto_completed": true,
"detected_at": null,
"acknowledged_at": null,
"private": false,
"airtable_record_id": null,
"airtable_record_url": null,
"google_drive_id": null,
"google_drive_url": null,
"summary_updated_at": null,
"sequential_id": 1,
"slack_channels": [],
"airtable_base_key": null,
"airtable_table_name": null,
"shortcut_task_id": null,
"shortcut_task_url": null,
"title_autogenerated": false,
"view_source": null,
"source": "web",
"microsoft_teams_meeting_url": null,
"microsoft_teams_meeting_id": null,
"dropbox_paper_id": null,
"dropbox_paper_url": null,
"subscribers_count": 0,
"status_page_io": {},
"webex_meeting_id": null,
"webex_meeting_url": null,
"github_issue_id": null,
"github_issue_url": null,
"cancelled_at": null,
"cancellation_message": null,
"notion_page_id": null,
"notion_page_url": null,
"datadog_notebook_id": null,
"datadog_notebook_url": null,
"notify_channels": {},
"freshservice_ticket_id": null,
"freshservice_ticket_url": null,
"freshservice_task_id": null,
"freshservice_task_url": null,
"started_by_user_id": 29,
"mitigated_by_user_id": null,
"resolved_by_user_id": null,
"cancelled_by_user_id": null,
"slack_aliases": [],
"slack_channel_workspace_id": null,
"google_calendar_event_url": null,
"google_calendar_event_id": null,
"short_url": null,
"slack_channel_short_url": null,
"go_to_meeting_id": null,
"go_to_meeting_url": null,
"jira_issue_key": null,
"linear_issue_key": null,
"opsgenie_alert_id": null,
"opsgenie_alert_url": null,
"triggered_from_slack_channel_id": null,
"service_now_incident_key": null,
"quip_page_id": null,
"quip_page_url": null,
"pagertree_alert_id": null,
"pagertree_alert_url": null,
"duplicate_incident_id": null,
"parent_incident_id": null,
"ability_cache": null,
"previous_attributes": {
"updated_at": "2025-07-12T00:12:08.475-07:00",
"incident_events": [
"Started date has been set to <span class=\"badge badge-info-inverted\">July 12 12:12 AM PDT</span>",
"Bob Schinner created this incident"
],
"user_avatar_url": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KICAgICAg\nPHN2ZyB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8y\nMDAwL3N2ZyIgd2lkdGg9IjIwMCIgaGVpZ2h0PSIyMDAiIHZpZXdCb3g9IjAg\nMCAyMDAgMjAwIj4KICAgICAgICA8bGluZWFyR3JhZGllbnQgaWQ9ImdyYWRp\nZW50XzE3NTIzMDQzMzFfNDMwMTc0IiBncmFkaWVudFRyYW5zZm9ybT0icm90\nYXRlKDEyMCkiPgogICAgICAgICAgPHN0b3Agc3RvcC1jb2xvcj0iI2ViMzM0\nOSIgb2Zmc2V0PSIwJSIgLz4KICAgICAgICAgIDxzdG9wIHN0b3AtY29sb3I9\nIiNlYjMzNDkiIG9mZnNldD0iMTAwJSIgLz4KICAgICAgICA8L2xpbmVhckdy\nYWRpZW50PgogICAgICAgIDxyZWN0IHdpZHRoPSIxMDAlIiBoZWlnaHQ9IjEw\nMCUiIGZpbGw9InVybCgjZ3JhZGllbnRfMTc1MjMwNDMzMV80MzAxNzQpIiAv\nPgogICAgICAgIDx0ZXh0IGZpbGw9IiNGRkYiIGZvbnQtZmFtaWx5PSJPcGVu\nIFNhbnMsSGVsdmV0aWNhLEFyaWFsLHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0i\nMTAxIiBmb250LXdlaWdodD0iNTAwIiB4PSI1MCUiIHk9IjU1JSIgZG9taW5h\nbnQtYmFzZWxpbmU9Im1pZGRsZSIgdGV4dC1hbmNob3I9Im1pZGRsZSI+CiAg\nICAgICAgICBCUwogICAgICAgIDwvdGV4dD4KICAgICAgPC9zdmc+CiAgICA=\n"
},
"genius_workflow_runs_count": 0,
"slack_channel_archived": false,
"google_drive_parent_id": null,
"in_triage_at": null,
"in_triage_by_user_id": null,
"external_id": null,
"slack_channel_deep_link": null,
"retrospective_progress_status": "not_started",
"users_assigned_count": 0,
"retrospective_completed_at": null,
"retrospective_started_at": null,
"pagerduty_incident_number": null,
"current_tutorial_step": "not_started",
"clickup_task_id": null,
"clickup_task_url": null,
"slack_notify_ready_for_retrospective_timestamp": null,
"notify_emails": [],
"status_page_io_components": [],
"retrospective_auto_skipped": false,
"retrospective_mandatory": false,
"embedding": null,
"zoom_meeting_transcript": {},
"google_meeting_transcript": {},
"webex_meeting_transcript": {},
"microsoft_teams_meeting_transcript": {},
"zoom_meeting_bot_id": null,
"google_meeting_bot_id": null,
"webex_meeting_bot_id": null,
"microsoft_teams_meeting_bot_id": null,
"zoom_meeting_transcript_summary": null,
"google_meeting_transcript_summary": null,
"webex_meeting_transcript_summary": null,
"microsoft_teams_meeting_transcript_summary": null,
"gitlab_issue_id": null,
"gitlab_issue_url": null,
"outlook_event_id": null,
"outlook_event_url": null,
"sharepoint_page_id": null,
"sharepoint_page_url": null,
"created_from_slack_identifier": null,
"zoom_meeting_pstn_password": null,
"zoom_meeting_h323_password": null,
"zoom_meeting_global_dial_in_numbers": [],
"left_slack_channel_slack_user_ids": [],
"using_redesigned_slack_announcement": true,
"using_redesigned_slack_updates": true,
"motion_task_id": null,
"motion_task_url": null,
"sub_status_id": "dabb589c-8d20-4e85-a016-0ddf0b99baf4",
"closed_at": null,
"closed_by_user_id": null,
"microsoft_teams_channel_id": null,
"microsoft_teams_channel_name": null,
"microsoft_teams_channel_url": null,
"microsoft_teams_channel_short_url": null,
"microsoft_teams_team_id": null,
"triggered_from_microsoft_teams_channel_id": null,
"microsoft_teams_summary_message_id": null,
"slack_last_message_ts": null,
"zoom_meeting_password": null,
"microsoft_teams_channel_service_url": null,
"microsoft_teams_team_internal_id": null,
"triggered_from_slack_message_ts": null,
"triggered_from_slack_thread_ts": null,
"sub_incidents_count": 0,
"coda_doc_id": null,
"coda_doc_url": null,
"coda_page_id": null,
"raw_labels": null,
"tutorial_steps": null
}
],
"data": {},
"started_at": "2025-07-12T00:12:10.888-07:00",
"ended_at": null,
"external_id": null,
"external_url": "http://kassulke.example/colby.abernathy",
"url": "https://test.rootly.com/account/alerts/32e5e11d-5c13-47c7-ae88-65aa16179cf8",
"noise": "not_noise",
"notification_target_type": null,
"notification_target_id": null,
"alert_urgency_id": "f9236d15-ece2-480a-b9ac-a6172e95ecb5",
"notified_users": [],
"created_at": "2025-07-12T00:12:10.888-07:00",
"updated_at": "2025-07-12T00:12:17.291-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/alert_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Summary can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_alert"
}
}
}
}
}
},
"/v1/alerts/{id}/acknowledge": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Acknowledges an alert",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Alerts"
],
"description": "Acknowledges a specific alert by id",
"operationId": "acknowledgeAlert",
"responses": {
"200": {
"description": "alert acknowledged",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "32e5e11d-5c13-47c7-ae88-65aa16179cf8",
"type": "alerts",
"attributes": {
"short_id": "5za6y4",
"source": "pagerduty",
"status": "acknowledged",
"summary": "Voluptas nostrum ullam maxime.",
"description": "Cum qui eveniet. Voluptatibus voluptatum velit. A non illum.",
"labels": [],
"services": [],
"service_ids": [],
"groups": [],
"group_ids": [],
"environments": [],
"environment_ids": [],
"responders": [
{
"id": 27,
"email": "antonetta@howell.example",
"deleted_at": null,
"created_at": "2025-07-12T00:12:07.090-07:00",
"updated_at": "2025-07-12T00:12:17.574-07:00",
"current_team_id": 16,
"first_name": "Ray",
"last_name": "Rohan",
"time_zone": "UTC",
"last_seen_at": null,
"profile_photo_id": null,
"ability_cache": null,
"last_notification_email_sent_at": null,
"accept_terms": true,
"onboarding_completed": true,
"service_user": false,
"accept_marketing": true,
"teams_count": 1,
"created_through_sso": false,
"scim_uid": null,
"session_token": null,
"incidents_example_count": 0,
"incidents_test_count": 0,
"incidents_normal_count": 0,
"incidents_scheduled_count": 0,
"incidents_backfilled_count": 0,
"incidents_count": 0,
"theme": "light_v2",
"skip_tutorial": false,
"external_id": null,
"jti": "36b8a269-49fe-4df7-817b-e09d4f37130b",
"is_super_admin": false,
"has_impersonate_write_permission": false,
"view_multiple_schedules": true,
"push_notification_new_alert_sound": "default",
"push_notification_shift_starts_sound": "soft_bloob",
"push_notification_shift_ends_sound": "soft_bloob",
"how_did_you_hear_about_us": null,
"push_notification_new_alert_volume": 1.0,
"opsgenie_id": null,
"victor_ops_id": null,
"pagerduty_id": null,
"locale": "en"
}
],
"incidents": [
{
"id": "8fc01637-ca0a-4a5d-a165-cc1e71bcd173",
"user_id": 29,
"team_id": 16,
"title": "Facere et dolor et.",
"slug": "facere-et-dolor-et",
"summary": "Consequatur ducimus qui. Architecto eligendi sunt. Optio dicta molestiae.",
"status": "started",
"slack_channel_id": null,
"started_at": "2025-07-12T00:12:08.349-07:00",
"mitigated_at": null,
"resolved_at": null,
"deleted_at": null,
"created_at": "2025-07-12T00:12:08.349-07:00",
"updated_at": "2025-07-12T00:12:11.932-07:00",
"severity_id": "ae1e4e5b-623a-466b-9995-3cfe59138dc9",
"public_title": null,
"zoom_meeting_id": null,
"zoom_meeting_start_url": null,
"zoom_meeting_join_url": null,
"shortcut_story_id": null,
"shortcut_story_url": null,
"asana_task_id": null,
"asana_task_url": null,
"jira_issue_id": null,
"jira_issue_url": null,
"email_message_id": 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,
"slack_channel_name": null,
"service_now_incident_id": null,
"service_now_incident_url": null,
"opsgenie_incident_id": null,
"opsgenie_incident_url": null,
"opsgenie_incident_responder_ids": [],
"labels": {},
"incidents_action_items_count": 0,
"incidents_tasks_count": 0,
"mitigation_message": null,
"resolution_message": null,
"pagerduty_incident_responder_ids": {},
"victor_ops_incident_id": null,
"victor_ops_incident_url": null,
"victor_ops_incident_responder_ids": {},
"pagerduty_incident_id": null,
"pagerduty_incident_url": null,
"status_pages_count": 0,
"mattermost_channel_id": null,
"slack_summary_timestamp": null,
"mattermost_channel_name": null,
"mattermost_channel_url": null,
"slack_channel_url": null,
"mattermost_summary_timestamp": null,
"confluence_page_id": null,
"confluence_page_url": null,
"kind": "normal",
"scheduled_for": null,
"scheduled_until": null,
"scheduled_remind_prior": false,
"scheduled_auto_in_progress": true,
"scheduled_auto_completed": true,
"detected_at": null,
"acknowledged_at": null,
"private": false,
"airtable_record_id": null,
"airtable_record_url": null,
"google_drive_id": null,
"google_drive_url": null,
"summary_updated_at": null,
"sequential_id": 1,
"slack_channels": [],
"airtable_base_key": null,
"airtable_table_name": null,
"shortcut_task_id": null,
"shortcut_task_url": null,
"title_autogenerated": false,
"view_source": null,
"source": "web",
"microsoft_teams_meeting_url": null,
"microsoft_teams_meeting_id": null,
"dropbox_paper_id": null,
"dropbox_paper_url": null,
"subscribers_count": 0,
"status_page_io": {},
"webex_meeting_id": null,
"webex_meeting_url": null,
"github_issue_id": null,
"github_issue_url": null,
"cancelled_at": null,
"cancellation_message": null,
"notion_page_id": null,
"notion_page_url": null,
"datadog_notebook_id": null,
"datadog_notebook_url": null,
"notify_channels": {},
"freshservice_ticket_id": null,
"freshservice_ticket_url": null,
"freshservice_task_id": null,
"freshservice_task_url": null,
"started_by_user_id": 29,
"mitigated_by_user_id": null,
"resolved_by_user_id": null,
"cancelled_by_user_id": null,
"slack_aliases": [],
"slack_channel_workspace_id": null,
"google_calendar_event_url": null,
"google_calendar_event_id": null,
"short_url": null,
"slack_channel_short_url": null,
"go_to_meeting_id": null,
"go_to_meeting_url": null,
"jira_issue_key": null,
"linear_issue_key": null,
"opsgenie_alert_id": null,
"opsgenie_alert_url": null,
"triggered_from_slack_channel_id": null,
"service_now_incident_key": null,
"quip_page_id": null,
"quip_page_url": null,
"pagertree_alert_id": null,
"pagertree_alert_url": null,
"duplicate_incident_id": null,
"parent_incident_id": null,
"ability_cache": null,
"previous_attributes": {
"updated_at": "2025-07-12T00:12:08.475-07:00",
"incident_events": [
"Started date has been set to <span class=\"badge badge-info-inverted\">July 12 12:12 AM PDT</span>",
"Bob Schinner created this incident"
],
"user_avatar_url": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KICAgICAg\nPHN2ZyB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8y\nMDAwL3N2ZyIgd2lkdGg9IjIwMCIgaGVpZ2h0PSIyMDAiIHZpZXdCb3g9IjAg\nMCAyMDAgMjAwIj4KICAgICAgICA8bGluZWFyR3JhZGllbnQgaWQ9ImdyYWRp\nZW50XzE3NTIzMDQzMzFfNDMwMTc0IiBncmFkaWVudFRyYW5zZm9ybT0icm90\nYXRlKDEyMCkiPgogICAgICAgICAgPHN0b3Agc3RvcC1jb2xvcj0iI2ViMzM0\nOSIgb2Zmc2V0PSIwJSIgLz4KICAgICAgICAgIDxzdG9wIHN0b3AtY29sb3I9\nIiNlYjMzNDkiIG9mZnNldD0iMTAwJSIgLz4KICAgICAgICA8L2xpbmVhckdy\nYWRpZW50PgogICAgICAgIDxyZWN0IHdpZHRoPSIxMDAlIiBoZWlnaHQ9IjEw\nMCUiIGZpbGw9InVybCgjZ3JhZGllbnRfMTc1MjMwNDMzMV80MzAxNzQpIiAv\nPgogICAgICAgIDx0ZXh0IGZpbGw9IiNGRkYiIGZvbnQtZmFtaWx5PSJPcGVu\nIFNhbnMsSGVsdmV0aWNhLEFyaWFsLHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0i\nMTAxIiBmb250LXdlaWdodD0iNTAwIiB4PSI1MCUiIHk9IjU1JSIgZG9taW5h\nbnQtYmFzZWxpbmU9Im1pZGRsZSIgdGV4dC1hbmNob3I9Im1pZGRsZSI+CiAg\nICAgICAgICBCUwogICAgICAgIDwvdGV4dD4KICAgICAgPC9zdmc+CiAgICA=\n"
},
"genius_workflow_runs_count": 0,
"slack_channel_archived": false,
"google_drive_parent_id": null,
"in_triage_at": null,
"in_triage_by_user_id": null,
"external_id": null,
"slack_channel_deep_link": null,
"retrospective_progress_status": "not_started",
"users_assigned_count": 0,
"retrospective_completed_at": null,
"retrospective_started_at": null,
"pagerduty_incident_number": null,
"current_tutorial_step": "not_started",
"clickup_task_id": null,
"clickup_task_url": null,
"slack_notify_ready_for_retrospective_timestamp": null,
"notify_emails": [],
"status_page_io_components": [],
"retrospective_auto_skipped": false,
"retrospective_mandatory": false,
"embedding": null,
"zoom_meeting_transcript": {},
"google_meeting_transcript": {},
"webex_meeting_transcript": {},
"microsoft_teams_meeting_transcript": {},
"zoom_meeting_bot_id": null,
"google_meeting_bot_id": null,
"webex_meeting_bot_id": null,
"microsoft_teams_meeting_bot_id": null,
"zoom_meeting_transcript_summary": null,
"google_meeting_transcript_summary": null,
"webex_meeting_transcript_summary": null,
"microsoft_teams_meeting_transcript_summary": null,
"gitlab_issue_id": null,
"gitlab_issue_url": null,
"outlook_event_id": null,
"outlook_event_url": null,
"sharepoint_page_id": null,
"sharepoint_page_url": null,
"created_from_slack_identifier": null,
"zoom_meeting_pstn_password": null,
"zoom_meeting_h323_password": null,
"zoom_meeting_global_dial_in_numbers": [],
"left_slack_channel_slack_user_ids": [],
"using_redesigned_slack_announcement": true,
"using_redesigned_slack_updates": true,
"motion_task_id": null,
"motion_task_url": null,
"sub_status_id": "dabb589c-8d20-4e85-a016-0ddf0b99baf4",
"closed_at": null,
"closed_by_user_id": null,
"microsoft_teams_channel_id": null,
"microsoft_teams_channel_name": null,
"microsoft_teams_channel_url": null,
"microsoft_teams_channel_short_url": null,
"microsoft_teams_team_id": null,
"triggered_from_microsoft_teams_channel_id": null,
"microsoft_teams_summary_message_id": null,
"slack_last_message_ts": null,
"zoom_meeting_password": null,
"microsoft_teams_channel_service_url": null,
"microsoft_teams_team_internal_id": null,
"triggered_from_slack_message_ts": null,
"triggered_from_slack_thread_ts": null,
"sub_incidents_count": 0,
"coda_doc_id": null,
"coda_doc_url": null,
"coda_page_id": null,
"raw_labels": null,
"tutorial_steps": null
}
],
"data": {},
"started_at": "2025-07-12T00:12:10.888-07:00",
"ended_at": null,
"external_id": null,
"external_url": "http://kassulke.example/colby.abernathy",
"url": "https://test.rootly.com/account/alerts/32e5e11d-5c13-47c7-ae88-65aa16179cf8",
"noise": "not_noise",
"notification_target_type": null,
"notification_target_id": null,
"alert_urgency_id": "f9236d15-ece2-480a-b9ac-a6172e95ecb5",
"notified_users": [],
"created_at": "2025-07-12T00:12:10.888-07:00",
"updated_at": "2025-07-12T00:12:17.622-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/alert_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/alerts/{id}/resolve": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Resolves an alert",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Alerts"
],
"description": "Resolves a specific alert by id",
"operationId": "resolveAlert",
"parameters": [],
"responses": {
"200": {
"description": "resolve acknowledged",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "32e5e11d-5c13-47c7-ae88-65aa16179cf8",
"type": "alerts",
"attributes": {
"short_id": "5za6y4",
"source": "pagerduty",
"status": "resolved",
"summary": "Voluptas nostrum ullam maxime.",
"description": "Cum qui eveniet. Voluptatibus voluptatum velit. A non illum.",
"labels": [],
"services": [],
"service_ids": [],
"groups": [],
"group_ids": [],
"environments": [],
"environment_ids": [],
"responders": [
{
"id": 27,
"email": "antonetta@howell.example",
"deleted_at": null,
"created_at": "2025-07-12T00:12:07.090-07:00",
"updated_at": "2025-07-12T00:12:18.121-07:00",
"current_team_id": 16,
"first_name": "Ray",
"last_name": "Rohan",
"time_zone": "UTC",
"last_seen_at": null,
"profile_photo_id": null,
"ability_cache": null,
"last_notification_email_sent_at": null,
"accept_terms": true,
"onboarding_completed": true,
"service_user": false,
"accept_marketing": true,
"teams_count": 1,
"created_through_sso": false,
"scim_uid": null,
"session_token": null,
"incidents_example_count": 0,
"incidents_test_count": 0,
"incidents_normal_count": 0,
"incidents_scheduled_count": 0,
"incidents_backfilled_count": 0,
"incidents_count": 0,
"theme": "light_v2",
"skip_tutorial": false,
"external_id": null,
"jti": "36b8a269-49fe-4df7-817b-e09d4f37130b",
"is_super_admin": false,
"has_impersonate_write_permission": false,
"view_multiple_schedules": true,
"push_notification_new_alert_sound": "default",
"push_notification_shift_starts_sound": "soft_bloob",
"push_notification_shift_ends_sound": "soft_bloob",
"how_did_you_hear_about_us": null,
"push_notification_new_alert_volume": 1.0,
"opsgenie_id": null,
"victor_ops_id": null,
"pagerduty_id": null,
"locale": "en"
}
],
"incidents": [
{
"id": "8fc01637-ca0a-4a5d-a165-cc1e71bcd173",
"user_id": 29,
"team_id": 16,
"title": "Facere et dolor et.",
"slug": "facere-et-dolor-et",
"summary": "Consequatur ducimus qui. Architecto eligendi sunt. Optio dicta molestiae.",
"status": "started",
"slack_channel_id": null,
"started_at": "2025-07-12T00:12:08.349-07:00",
"mitigated_at": null,
"resolved_at": null,
"deleted_at": null,
"created_at": "2025-07-12T00:12:08.349-07:00",
"updated_at": "2025-07-12T00:12:11.932-07:00",
"severity_id": "ae1e4e5b-623a-466b-9995-3cfe59138dc9",
"public_title": null,
"zoom_meeting_id": null,
"zoom_meeting_start_url": null,
"zoom_meeting_join_url": null,
"shortcut_story_id": null,
"shortcut_story_url": null,
"asana_task_id": null,
"asana_task_url": null,
"jira_issue_id": null,
"jira_issue_url": null,
"email_message_id": 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,
"slack_channel_name": null,
"service_now_incident_id": null,
"service_now_incident_url": null,
"opsgenie_incident_id": null,
"opsgenie_incident_url": null,
"opsgenie_incident_responder_ids": [],
"labels": {},
"incidents_action_items_count": 0,
"incidents_tasks_count": 0,
"mitigation_message": null,
"resolution_message": null,
"pagerduty_incident_responder_ids": {},
"victor_ops_incident_id": null,
"victor_ops_incident_url": null,
"victor_ops_incident_responder_ids": {},
"pagerduty_incident_id": null,
"pagerduty_incident_url": null,
"status_pages_count": 0,
"mattermost_channel_id": null,
"slack_summary_timestamp": null,
"mattermost_channel_name": null,
"mattermost_channel_url": null,
"slack_channel_url": null,
"mattermost_summary_timestamp": null,
"confluence_page_id": null,
"confluence_page_url": null,
"kind": "normal",
"scheduled_for": null,
"scheduled_until": null,
"scheduled_remind_prior": false,
"scheduled_auto_in_progress": true,
"scheduled_auto_completed": true,
"detected_at": null,
"acknowledged_at": null,
"private": false,
"airtable_record_id": null,
"airtable_record_url": null,
"google_drive_id": null,
"google_drive_url": null,
"summary_updated_at": null,
"sequential_id": 1,
"slack_channels": [],
"airtable_base_key": null,
"airtable_table_name": null,
"shortcut_task_id": null,
"shortcut_task_url": null,
"title_autogenerated": false,
"view_source": null,
"source": "web",
"microsoft_teams_meeting_url": null,
"microsoft_teams_meeting_id": null,
"dropbox_paper_id": null,
"dropbox_paper_url": null,
"subscribers_count": 0,
"status_page_io": {},
"webex_meeting_id": null,
"webex_meeting_url": null,
"github_issue_id": null,
"github_issue_url": null,
"cancelled_at": null,
"cancellation_message": null,
"notion_page_id": null,
"notion_page_url": null,
"datadog_notebook_id": null,
"datadog_notebook_url": null,
"notify_channels": {},
"freshservice_ticket_id": null,
"freshservice_ticket_url": null,
"freshservice_task_id": null,
"freshservice_task_url": null,
"started_by_user_id": 29,
"mitigated_by_user_id": null,
"resolved_by_user_id": null,
"cancelled_by_user_id": null,
"slack_aliases": [],
"slack_channel_workspace_id": null,
"google_calendar_event_url": null,
"google_calendar_event_id": null,
"short_url": null,
"slack_channel_short_url": null,
"go_to_meeting_id": null,
"go_to_meeting_url": null,
"jira_issue_key": null,
"linear_issue_key": null,
"opsgenie_alert_id": null,
"opsgenie_alert_url": null,
"triggered_from_slack_channel_id": null,
"service_now_incident_key": null,
"quip_page_id": null,
"quip_page_url": null,
"pagertree_alert_id": null,
"pagertree_alert_url": null,
"duplicate_incident_id": null,
"parent_incident_id": null,
"ability_cache": null,
"previous_attributes": {
"updated_at": "2025-07-12T00:12:08.475-07:00",
"incident_events": [
"Started date has been set to <span class=\"badge badge-info-inverted\">July 12 12:12 AM PDT</span>",
"Bob Schinner created this incident"
],
"user_avatar_url": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KICAgICAg\nPHN2ZyB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8y\nMDAwL3N2ZyIgd2lkdGg9IjIwMCIgaGVpZ2h0PSIyMDAiIHZpZXdCb3g9IjAg\nMCAyMDAgMjAwIj4KICAgICAgICA8bGluZWFyR3JhZGllbnQgaWQ9ImdyYWRp\nZW50XzE3NTIzMDQzMzFfNDMwMTc0IiBncmFkaWVudFRyYW5zZm9ybT0icm90\nYXRlKDEyMCkiPgogICAgICAgICAgPHN0b3Agc3RvcC1jb2xvcj0iI2ViMzM0\nOSIgb2Zmc2V0PSIwJSIgLz4KICAgICAgICAgIDxzdG9wIHN0b3AtY29sb3I9\nIiNlYjMzNDkiIG9mZnNldD0iMTAwJSIgLz4KICAgICAgICA8L2xpbmVhckdy\nYWRpZW50PgogICAgICAgIDxyZWN0IHdpZHRoPSIxMDAlIiBoZWlnaHQ9IjEw\nMCUiIGZpbGw9InVybCgjZ3JhZGllbnRfMTc1MjMwNDMzMV80MzAxNzQpIiAv\nPgogICAgICAgIDx0ZXh0IGZpbGw9IiNGRkYiIGZvbnQtZmFtaWx5PSJPcGVu\nIFNhbnMsSGVsdmV0aWNhLEFyaWFsLHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0i\nMTAxIiBmb250LXdlaWdodD0iNTAwIiB4PSI1MCUiIHk9IjU1JSIgZG9taW5h\nbnQtYmFzZWxpbmU9Im1pZGRsZSIgdGV4dC1hbmNob3I9Im1pZGRsZSI+CiAg\nICAgICAgICBCUwogICAgICAgIDwvdGV4dD4KICAgICAgPC9zdmc+CiAgICA=\n"
},
"genius_workflow_runs_count": 0,
"slack_channel_archived": false,
"google_drive_parent_id": null,
"in_triage_at": null,
"in_triage_by_user_id": null,
"external_id": null,
"slack_channel_deep_link": null,
"retrospective_progress_status": "not_started",
"users_assigned_count": 0,
"retrospective_completed_at": null,
"retrospective_started_at": null,
"pagerduty_incident_number": null,
"current_tutorial_step": "not_started",
"clickup_task_id": null,
"clickup_task_url": null,
"slack_notify_ready_for_retrospective_timestamp": null,
"notify_emails": [],
"status_page_io_components": [],
"retrospective_auto_skipped": false,
"retrospective_mandatory": false,
"embedding": null,
"zoom_meeting_transcript": {},
"google_meeting_transcript": {},
"webex_meeting_transcript": {},
"microsoft_teams_meeting_transcript": {},
"zoom_meeting_bot_id": null,
"google_meeting_bot_id": null,
"webex_meeting_bot_id": null,
"microsoft_teams_meeting_bot_id": null,
"zoom_meeting_transcript_summary": null,
"google_meeting_transcript_summary": null,
"webex_meeting_transcript_summary": null,
"microsoft_teams_meeting_transcript_summary": null,
"gitlab_issue_id": null,
"gitlab_issue_url": null,
"outlook_event_id": null,
"outlook_event_url": null,
"sharepoint_page_id": null,
"sharepoint_page_url": null,
"created_from_slack_identifier": null,
"zoom_meeting_pstn_password": null,
"zoom_meeting_h323_password": null,
"zoom_meeting_global_dial_in_numbers": [],
"left_slack_channel_slack_user_ids": [],
"using_redesigned_slack_announcement": true,
"using_redesigned_slack_updates": true,
"motion_task_id": null,
"motion_task_url": null,
"sub_status_id": "dabb589c-8d20-4e85-a016-0ddf0b99baf4",
"closed_at": null,
"closed_by_user_id": null,
"microsoft_teams_channel_id": null,
"microsoft_teams_channel_name": null,
"microsoft_teams_channel_url": null,
"microsoft_teams_channel_short_url": null,
"microsoft_teams_team_id": null,
"triggered_from_microsoft_teams_channel_id": null,
"microsoft_teams_summary_message_id": null,
"slack_last_message_ts": null,
"zoom_meeting_password": null,
"microsoft_teams_channel_service_url": null,
"microsoft_teams_team_internal_id": null,
"triggered_from_slack_message_ts": null,
"triggered_from_slack_thread_ts": null,
"sub_incidents_count": 0,
"coda_doc_id": null,
"coda_doc_url": null,
"coda_page_id": null,
"raw_labels": null,
"tutorial_steps": null
}
],
"data": {},
"started_at": "2025-07-12T00:12:10.888-07:00",
"ended_at": "2025-07-12T00:12:18.181-07:00",
"external_id": null,
"external_url": "http://kassulke.example/colby.abernathy",
"url": "https://test.rootly.com/account/alerts/32e5e11d-5c13-47c7-ae88-65aa16179cf8",
"noise": "not_noise",
"notification_target_type": null,
"notification_target_id": null,
"alert_urgency_id": "f9236d15-ece2-480a-b9ac-a6172e95ecb5",
"notified_users": [],
"created_at": "2025-07-12T00:12:10.888-07:00",
"updated_at": "2025-07-12T00:12:18.182-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/alert_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/resolve_alert"
}
}
}
}
}
},
"/v1/audits": {
"get": {
"summary": "List audits",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Audits"
],
"description": "List audits",
"operationId": "listAudits",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[user_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[api_key_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[source]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[item_type]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/audits_list"
}
}
}
}
}
}
},
"/v1/authorizations": {
"post": {
"summary": "Creates an authorization",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Authorizations"
],
"description": "Creates a new authorization from provided data",
"operationId": "createAuthorization",
"parameters": [],
"responses": {
"201": {
"description": "authorization created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "6ae9131a-5908-4d79-8f62-15b4f9f37408",
"type": "authorizations",
"attributes": {
"authorizable_id": "02434478-d950-471e-876f-eac77f3205ce",
"authorizable_type": "Dashboard",
"grantee_id": "35",
"grantee_type": "User",
"permissions": [
"read"
],
"updated_at": "2025-07-12T00:12:22.033-07:00",
"created_at": "2025-07-12T00:12:22.033-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/authorization_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_authorization"
}
}
},
"required": true
}
},
"get": {
"summary": "List authorizations",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Authorizations"
],
"description": "List authorizations",
"operationId": "listAuthorizations",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[authorizable_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[authorizable_type]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[grantee_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[grantee_type]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/authorization_list"
}
}
}
}
}
}
},
"/v1/authorizations/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an authorization",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Authorizations"
],
"description": "Retrieves a specific authorization by id",
"operationId": "getAuthorization",
"responses": {
"200": {
"description": "authorization found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "a7aea289-e981-4d7f-a17c-ba5196a1cd7c",
"type": "authorizations",
"attributes": {
"authorizable_id": "9af6a16f-c019-43b9-96e9-286d1c1c2d4a",
"authorizable_type": "Dashboard",
"grantee_id": "39",
"grantee_type": "User",
"permissions": [
"read",
"update",
"authorize",
"destroy"
],
"updated_at": "2025-07-12T00:12:23.809-07:00",
"created_at": "2025-07-12T00:12:23.809-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/authorization_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an authorization",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Authorizations"
],
"description": "Update a specific authorization by id",
"operationId": "updateAuthorization",
"parameters": [],
"responses": {
"200": {
"description": "authorization updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "d0bda611-fff6-4cb3-9be5-9d0f48afd2db",
"type": "authorizations",
"attributes": {
"authorizable_id": "a15677d8-3b1c-4465-b7f5-e6aa76d83bfe",
"authorizable_type": "Dashboard",
"grantee_id": "43",
"grantee_type": "User",
"permissions": [
"read",
"update"
],
"updated_at": "2025-07-12T00:12:26.144-07:00",
"created_at": "2025-07-12T00:12:26.000-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/authorization_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_authorization"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an authorization",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Authorizations"
],
"description": "Delete a specific authorization by id",
"operationId": "deleteAuthorization",
"responses": {
"200": {
"description": "authorization deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "ee04cd8c-1384-49e7-a2d4-10ab67f16459",
"type": "authorizations",
"attributes": {
"authorizable_id": "c586730c-65b1-44be-bd1a-891755ed4769",
"authorizable_type": "Dashboard",
"grantee_id": "44",
"grantee_type": "Team",
"permissions": [
"read",
"update",
"authorize",
"destroy"
],
"updated_at": "2025-07-12T00:12:28.157-07:00",
"created_at": "2025-07-12T00:12:28.157-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/authorization_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/catalogs/{catalog_id}/entities": {
"parameters": [
{
"name": "catalog_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a Catalog Entity",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogEntities"
],
"description": "Creates a new Catalog Entity from provided data",
"operationId": "createCatalogEntity",
"parameters": [],
"responses": {
"201": {
"description": "catalog_entity created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "565f33f4-ae84-4404-8582-38b8d3647466",
"type": "catalog_entities",
"attributes": {
"catalog_id": "b24bf118-5bba-40ab-b96e-893e40b59baf",
"name": "Test Item",
"slug": "test-item",
"position": 2,
"deleted_at": null,
"updated_at": "2025-07-12T00:12:30.936-07:00",
"created_at": "2025-07-12T00:12:30.936-07:00"
},
"relationships": {
"catalog": {
"data": {
"id": "b24bf118-5bba-40ab-b96e-893e40b59baf",
"type": "catalogs"
}
},
"properties": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/catalog_entity_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
},
{
"title": "Name is too short (minimum is 1 character)",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_catalog_entity"
}
}
},
"required": true
}
},
"get": {
"summary": "List Catalog Entities",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogEntities"
],
"description": "List Catalog Entities",
"operationId": "listCatalogEntities",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: catalog,properties",
"schema": {
"type": "string",
"enum": [
"catalog",
"properties"
]
},
"required": false
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at",
"position",
"-position"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_entity_list"
}
}
}
}
}
}
},
"/v1/catalog_entities/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a Catalog Entity",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogEntities"
],
"description": "Retrieves a specific Catalog Entity by id",
"operationId": "getCatalogEntity",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: catalog,properties",
"schema": {
"type": "string",
"enum": [
"catalog",
"properties"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "catalog_entity found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "c6080777-e7ea-467d-8dc7-9483a6312d79",
"type": "catalog_entities",
"attributes": {
"catalog_id": "b24bf118-5bba-40ab-b96e-893e40b59baf",
"name": "Test",
"slug": "test",
"position": 1,
"deleted_at": null,
"updated_at": "2025-07-12T00:12:30.810-07:00",
"created_at": "2025-07-12T00:12:30.810-07:00"
},
"relationships": {
"catalog": {
"data": {
"id": "b24bf118-5bba-40ab-b96e-893e40b59baf",
"type": "catalogs"
}
},
"properties": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/catalog_entity_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a Catalog Entity",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogEntities"
],
"description": "Update a specific Catalog Entity by id",
"operationId": "updateCatalogEntity",
"parameters": [],
"responses": {
"200": {
"description": "catalog_entity updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "c6080777-e7ea-467d-8dc7-9483a6312d79",
"type": "catalog_entities",
"attributes": {
"catalog_id": "b24bf118-5bba-40ab-b96e-893e40b59baf",
"name": "Updated name",
"slug": "test",
"position": 1,
"deleted_at": null,
"updated_at": "2025-07-12T00:12:31.980-07:00",
"created_at": "2025-07-12T00:12:30.810-07:00"
},
"relationships": {
"catalog": {
"data": {
"id": "b24bf118-5bba-40ab-b96e-893e40b59baf",
"type": "catalogs"
}
},
"properties": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/catalog_entity_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_catalog_entity"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a Catalog Entity",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogEntities"
],
"description": "Delete a specific Catalog Entity by id",
"operationId": "deleteCatalogEntity",
"responses": {
"200": {
"description": "catalog_entity deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "c6080777-e7ea-467d-8dc7-9483a6312d79",
"type": "catalog_entities",
"attributes": {
"catalog_id": "b24bf118-5bba-40ab-b96e-893e40b59baf",
"name": "Test",
"slug": "test",
"position": 1,
"deleted_at": "2025-07-12T00:12:32.909-07:00",
"updated_at": "2025-07-12T00:12:32.909-07:00",
"created_at": "2025-07-12T00:12:30.810-07:00"
},
"relationships": {
"catalog": {
"data": {
"id": "b24bf118-5bba-40ab-b96e-893e40b59baf",
"type": "catalogs"
}
},
"properties": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/catalog_entity_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/catalog_entities/{catalog_entity_id}/properties": {
"parameters": [
{
"name": "catalog_entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a Catalog Entity Property",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogEntityProperties"
],
"description": "Creates a new Catalog Entity Property from provided data",
"operationId": "createCatalogEntityProperty",
"parameters": [],
"responses": {
"201": {
"description": "catalog_entity_property created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "cbdb325c-adff-4af1-bf9d-5a1607065977",
"type": "catalog_entity_properties",
"attributes": {
"catalog_entity_id": "f5e71d18-9bc0-4419-aaed-352a9e38b376",
"catalog_field_id": "a0ad94ae-0603-4b23-8661-bb4205d497c4",
"key": "text",
"value": "Test EntityProperty",
"deleted_at": null,
"updated_at": "2025-07-12T00:12:34.185-07:00",
"created_at": "2025-07-12T00:12:34.185-07:00"
},
"relationships": {
"catalog_entity": {
"data": {
"id": "f5e71d18-9bc0-4419-aaed-352a9e38b376",
"type": "catalog_entities"
}
},
"catalog_field": {
"data": {
"id": "a0ad94ae-0603-4b23-8661-bb4205d497c4",
"type": "catalog_fields"
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/catalog_entity_property_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Value can't be blank",
"status": "422"
},
{
"title": "Value is too short (minimum is 1 character)",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_catalog_entity_property"
}
}
},
"required": true
}
},
"get": {
"summary": "List catalog properties",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogEntityProperties"
],
"description": "List Catalog Entity Properties",
"operationId": "listCatalogEntityProperties",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: catalog_entity,catalog_field",
"schema": {
"type": "string",
"enum": [
"catalog_entity",
"catalog_field"
]
},
"required": false
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[catalog_field_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[key]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_entity_property_list"
}
}
}
}
}
}
},
"/v1/catalog_entity_properties/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a Catalog Entity Property",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogEntityProperties"
],
"description": "Retrieves a specific Catalog Entity Property by id",
"operationId": "getCatalogEntityProperty",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: catalog_entity,catalog_field",
"schema": {
"type": "string",
"enum": [
"catalog_entity",
"catalog_field"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "catalog_entity_property found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "23ee898b-756a-47b8-80b8-dcb131437ee9",
"type": "catalog_entity_properties",
"attributes": {
"catalog_entity_id": "f5e71d18-9bc0-4419-aaed-352a9e38b376",
"catalog_field_id": "a0ad94ae-0603-4b23-8661-bb4205d497c4",
"key": "text",
"value": "Test",
"deleted_at": null,
"updated_at": "2025-07-12T00:12:34.064-07:00",
"created_at": "2025-07-12T00:12:34.064-07:00"
},
"relationships": {
"catalog_entity": {
"data": {
"id": "f5e71d18-9bc0-4419-aaed-352a9e38b376",
"type": "catalog_entities"
}
},
"catalog_field": {
"data": {
"id": "a0ad94ae-0603-4b23-8661-bb4205d497c4",
"type": "catalog_fields"
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/catalog_entity_property_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a Catalog Entity Property",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogEntityProperties"
],
"description": "Update a specific Catalog Entity Property by id",
"operationId": "updateCatalogEntityProperty",
"parameters": [],
"responses": {
"200": {
"description": "catalog_entity_property updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "23ee898b-756a-47b8-80b8-dcb131437ee9",
"type": "catalog_entity_properties",
"attributes": {
"catalog_entity_id": "f5e71d18-9bc0-4419-aaed-352a9e38b376",
"catalog_field_id": "a0ad94ae-0603-4b23-8661-bb4205d497c4",
"key": "text",
"value": "Updated value",
"deleted_at": null,
"updated_at": "2025-07-12T00:12:35.272-07:00",
"created_at": "2025-07-12T00:12:34.064-07:00"
},
"relationships": {
"catalog_entity": {
"data": {
"id": "f5e71d18-9bc0-4419-aaed-352a9e38b376",
"type": "catalog_entities"
}
},
"catalog_field": {
"data": {
"id": "a0ad94ae-0603-4b23-8661-bb4205d497c4",
"type": "catalog_fields"
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/catalog_entity_property_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_catalog_entity_property"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a Catalog Entity Property",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogEntityProperties"
],
"description": "Delete a specific Catalog Entity Property by id",
"operationId": "deleteCatalogEntityProperty",
"responses": {
"200": {
"description": "catalog_entity_property deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "23ee898b-756a-47b8-80b8-dcb131437ee9",
"type": "catalog_entity_properties",
"attributes": {
"catalog_entity_id": "f5e71d18-9bc0-4419-aaed-352a9e38b376",
"catalog_field_id": "a0ad94ae-0603-4b23-8661-bb4205d497c4",
"key": "text",
"value": "Test",
"deleted_at": "2025-07-12T00:12:35.732-07:00",
"updated_at": "2025-07-12T00:12:35.732-07:00",
"created_at": "2025-07-12T00:12:34.064-07:00"
},
"relationships": {
"catalog_entity": {
"data": {
"id": "f5e71d18-9bc0-4419-aaed-352a9e38b376",
"type": "catalog_entities"
}
},
"catalog_field": {
"data": {
"id": "a0ad94ae-0603-4b23-8661-bb4205d497c4",
"type": "catalog_fields"
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/catalog_entity_property_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/catalogs/{catalog_id}/fields": {
"parameters": [
{
"name": "catalog_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a Catalog Field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogFields"
],
"description": "Creates a new Catalog Field from provided data",
"operationId": "createCatalogField",
"parameters": [],
"responses": {
"201": {
"description": "catalog_field created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "885e9c62-3413-4f84-8d4c-f1da03c8a1b2",
"type": "catalog_fields",
"attributes": {
"catalog_id": "c5d56144-9277-48a9-8d17-d9af4f6eb539",
"name": "Test Attribute",
"slug": "test-attribute",
"kind": "reference",
"kind_catalog_id": null,
"multiple": false,
"position": 2,
"deleted_at": null,
"updated_at": "2025-07-12T00:12:37.027-07:00",
"created_at": "2025-07-12T00:12:37.027-07:00"
},
"relationships": {
"catalog": {
"data": {
"id": "c5d56144-9277-48a9-8d17-d9af4f6eb539",
"type": "catalogs"
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/catalog_field_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
},
{
"title": "Name is too short (minimum is 1 character)",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_catalog_field"
}
}
},
"required": true
}
},
"get": {
"summary": "List Catalog Fields",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogFields"
],
"description": "List Catalog Fields",
"operationId": "listCatalogFields",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: catalog",
"schema": {
"type": "string",
"enum": [
"catalog"
]
},
"required": false
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at",
"position",
"-position"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_field_list"
}
}
}
}
}
}
},
"/v1/catalog_fields/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a Catalog Field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogFields"
],
"description": "Retrieves a specific Catalog Field by id",
"operationId": "getCatalogField",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: catalog",
"schema": {
"type": "string",
"enum": [
"catalog"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "catalog_field found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "140930ba-a8ac-4579-b06e-f1d8ac487592",
"type": "catalog_fields",
"attributes": {
"catalog_id": "c5d56144-9277-48a9-8d17-d9af4f6eb539",
"name": "Test",
"slug": "test",
"kind": "reference",
"kind_catalog_id": "c5d56144-9277-48a9-8d17-d9af4f6eb539",
"multiple": false,
"position": 1,
"deleted_at": null,
"updated_at": "2025-07-12T00:12:36.898-07:00",
"created_at": "2025-07-12T00:12:36.898-07:00"
},
"relationships": {
"catalog": {
"data": {
"id": "c5d56144-9277-48a9-8d17-d9af4f6eb539",
"type": "catalogs"
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/catalog_field_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a catalog_field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogFields"
],
"description": "Update a specific catalog_field by id",
"operationId": "updateCatalogField",
"parameters": [],
"responses": {
"200": {
"description": "catalog_field updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "140930ba-a8ac-4579-b06e-f1d8ac487592",
"type": "catalog_fields",
"attributes": {
"catalog_id": "c5d56144-9277-48a9-8d17-d9af4f6eb539",
"name": "Updated name",
"slug": "test",
"kind": "reference",
"kind_catalog_id": "c5d56144-9277-48a9-8d17-d9af4f6eb539",
"multiple": false,
"position": 1,
"deleted_at": null,
"updated_at": "2025-07-12T00:12:38.061-07:00",
"created_at": "2025-07-12T00:12:36.898-07:00"
},
"relationships": {
"catalog": {
"data": {
"id": "c5d56144-9277-48a9-8d17-d9af4f6eb539",
"type": "catalogs"
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/catalog_field_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_catalog_field"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a catalog_field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogFields"
],
"description": "Delete a specific catalog_field by id",
"operationId": "deleteCatalogField",
"responses": {
"200": {
"description": "catalog_field deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "140930ba-a8ac-4579-b06e-f1d8ac487592",
"type": "catalog_fields",
"attributes": {
"catalog_id": "c5d56144-9277-48a9-8d17-d9af4f6eb539",
"name": "Test",
"slug": "test",
"kind": "reference",
"kind_catalog_id": "c5d56144-9277-48a9-8d17-d9af4f6eb539",
"multiple": false,
"position": 1,
"deleted_at": "2025-07-12T00:12:38.516-07:00",
"updated_at": "2025-07-12T00:12:38.516-07:00",
"created_at": "2025-07-12T00:12:36.898-07:00"
},
"relationships": {
"catalog": {
"data": {
"id": "c5d56144-9277-48a9-8d17-d9af4f6eb539",
"type": "catalogs"
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/catalog_field_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/catalogs": {
"post": {
"summary": "Creates a catalog",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Catalogs"
],
"description": "Creates a new catalog from provided data",
"operationId": "createCatalog",
"parameters": [],
"responses": {
"201": {
"description": "catalog created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "290fd8f5-f7cb-478d-b804-2da093a21fb5",
"type": "catalogs",
"attributes": {
"name": "Test",
"slug": "test",
"icon": "shapes",
"description": null,
"position": 2,
"deleted_at": null,
"updated_at": "2025-07-12T00:12:39.779-07:00",
"created_at": "2025-07-12T00:12:39.779-07:00"
},
"relationships": {
"fields": {
"data": []
},
"entities": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/catalog_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
},
{
"title": "Name is too short (minimum is 1 character)",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_catalog"
}
}
},
"required": true
}
},
"get": {
"summary": "List catalogs",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Catalogs"
],
"description": "List catalogs",
"operationId": "listCatalogs",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: fields,entities",
"schema": {
"type": "string",
"enum": [
"fields",
"entities"
]
},
"required": false
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at",
"position",
"-position"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_list"
}
}
}
}
}
}
},
"/v1/catalogs/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a catalog",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Catalogs"
],
"description": "Retrieves a specific catalog by id",
"operationId": "getCatalog",
"responses": {
"200": {
"description": "catalog found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "39a1a624-f55a-4832-a6b7-59776ea8ad0d",
"type": "catalogs",
"attributes": {
"name": "Services",
"slug": "services",
"icon": "globe-alt",
"description": null,
"position": 1,
"deleted_at": null,
"updated_at": "2025-07-12T00:12:39.655-07:00",
"created_at": "2025-07-12T00:12:39.655-07:00"
},
"relationships": {
"fields": {
"data": []
},
"entities": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/catalog_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a catalog",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Catalogs"
],
"description": "Update a specific catalog by id",
"operationId": "updateCatalog",
"parameters": [],
"responses": {
"200": {
"description": "catalog updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "39a1a624-f55a-4832-a6b7-59776ea8ad0d",
"type": "catalogs",
"attributes": {
"name": "Services",
"slug": "services",
"icon": "globe-alt",
"description": "Updated description",
"position": 1,
"deleted_at": null,
"updated_at": "2025-07-12T00:12:41.311-07:00",
"created_at": "2025-07-12T00:12:39.655-07:00"
},
"relationships": {
"fields": {
"data": []
},
"entities": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/catalog_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_catalog"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a catalog",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Catalogs"
],
"description": "Delete a specific catalog by id",
"operationId": "deleteCatalog",
"responses": {
"200": {
"description": "catalog deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "39a1a624-f55a-4832-a6b7-59776ea8ad0d",
"type": "catalogs",
"attributes": {
"name": "Services",
"slug": "services",
"icon": "globe-alt",
"description": null,
"position": 1,
"deleted_at": "2025-07-12T00:12:41.756-07:00",
"updated_at": "2025-07-12T00:12:41.756-07:00",
"created_at": "2025-07-12T00:12:39.655-07:00"
},
"relationships": {
"fields": {
"data": []
},
"entities": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/catalog_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/causes": {
"post": {
"summary": "Creates a cause",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Causes"
],
"description": "Creates a new cause from provided data",
"operationId": "createCause",
"parameters": [],
"responses": {
"201": {
"description": "cause created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "66d920f3-2ca0-4a10-ab39-7414679de3fe",
"type": "causes",
"attributes": {
"slug": "how-to-handle-customer-facing-incident",
"name": "How to handle customer-facing incident?",
"description": "This is a description",
"position": 1,
"created_at": "2025-07-12T00:12:45.085-07:00",
"updated_at": "2025-07-12T00:12:45.085-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/cause_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_cause"
}
}
},
"required": true
}
},
"get": {
"summary": "List causes",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Causes"
],
"description": "List causes",
"operationId": "listCauses",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/cause_list"
}
}
}
}
}
}
},
"/v1/causes/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a cause",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Causes"
],
"description": "Retrieves a specific cause by id",
"operationId": "getCause",
"responses": {
"200": {
"description": "cause found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "d5a502cb-c46f-454e-93c7-94cae49de7ea",
"type": "causes",
"attributes": {
"slug": "omnis-et-esse-quod",
"name": "Omnis et esse quod.",
"description": "Distinctio omnis maiores corporis.",
"position": 1,
"created_at": "2025-07-12T00:12:43.075-07:00",
"updated_at": "2025-07-12T00:12:43.075-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/cause_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a cause",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Causes"
],
"description": "Update a specific cause by id",
"operationId": "updateCause",
"parameters": [],
"responses": {
"200": {
"description": "cause updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "d5a502cb-c46f-454e-93c7-94cae49de7ea",
"type": "causes",
"attributes": {
"slug": "how-to-handle-security-incident",
"name": "How to handle security incident?",
"description": "This is a description",
"position": 2,
"created_at": "2025-07-12T00:12:43.075-07:00",
"updated_at": "2025-07-12T00:12:46.115-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/cause_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_cause"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a cause",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Causes"
],
"description": "Delete a specific cause by id",
"operationId": "deleteCause",
"responses": {
"200": {
"description": "cause deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "d5a502cb-c46f-454e-93c7-94cae49de7ea",
"type": "causes",
"attributes": {
"slug": "omnis-et-esse-quod",
"name": "Omnis et esse quod.",
"description": "Distinctio omnis maiores corporis.",
"position": 1,
"created_at": "2025-07-12T00:12:43.075-07:00",
"updated_at": "2025-07-12T00:12:46.631-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/cause_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/communications/groups": {
"post": {
"summary": "Creates a communications group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Groups"
],
"description": "Creates a new communications group from provided data",
"operationId": "createCommunicationsGroup",
"parameters": [],
"responses": {
"201": {
"description": "communications group created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "ae6acd39-376c-4065-8f54-a2f0ad6d5477",
"type": "communications-groups",
"attributes": {
"name": "Engineering Team",
"slug": "engineering-team",
"description": "Engineering team communications group",
"is_private": false,
"condition_type": "any",
"email_channel": true,
"sms_channel": false,
"communication_type_id": "47974938-1fc2-452a-b253-2997156f0384",
"slack_channel_ids": [
"b94899c6-9bc5-58fd-b83d-873c4c73318c"
],
"created_at": "2025-07-12T00:13:05.740-07:00",
"updated_at": "2025-07-12T00:13:05.740-07:00",
"team_id": 58,
"communication_group_members": [
{
"id": "4cc91fe3-4145-493b-8f95-09de4b65d887",
"user_id": 63,
"name": "Keila Stracke",
"email": "mike@corkery-emard.test"
}
],
"communication_external_group_members": [
{
"id": "9124dba9-0ef5-4b14-b868-c9cf38f632e1",
"name": "External member",
"email": "external@example.com",
"phone_number": "+911234567890"
}
],
"communication_group_conditions": [
{
"id": "c31a8a9a-6795-4641-9e79-aaf3c95bced1",
"condition": "is",
"property_type": "service",
"properties": [
{
"id": "2a60ae38-5f51-40c6-bab7-8cf9490f42c1",
"name": "Dolorem praesentium enim ut."
}
]
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/communications_group_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_communications_group"
}
}
},
"required": true
}
},
"get": {
"summary": "Lists communications groups",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Groups"
],
"description": "Lists communications groups",
"operationId": "listCommunicationsGroups",
"parameters": [
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[is_private]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[communication_type_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[condition_type]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "communications groups found",
"content": {
"application/vnd.api+json": {
"example": {
"data": [
{
"id": "261b8eb0-5f05-4635-8a8f-e589746d8a79",
"type": "communications-groups",
"attributes": {
"name": "Communication Group 10",
"slug": "communication-group-10",
"description": null,
"is_private": false,
"condition_type": "any",
"email_channel": true,
"sms_channel": false,
"communication_type_id": "47974938-1fc2-452a-b253-2997156f0384",
"slack_channel_ids": [],
"created_at": "2025-07-12T00:12:59.934-07:00",
"updated_at": "2025-07-12T00:12:59.934-07:00",
"team_id": 58,
"communication_group_members": [],
"communication_external_group_members": [],
"communication_group_conditions": []
}
},
{
"id": "a0bfc3ad-8aa5-4190-9d8a-b87c757c184a",
"type": "communications-groups",
"attributes": {
"name": "Communication Group 9",
"slug": "communication-group-9",
"description": null,
"is_private": false,
"condition_type": "any",
"email_channel": true,
"sms_channel": false,
"communication_type_id": "47974938-1fc2-452a-b253-2997156f0384",
"slack_channel_ids": [],
"created_at": "2025-07-12T00:12:58.866-07:00",
"updated_at": "2025-07-12T00:12:58.866-07:00",
"team_id": 58,
"communication_group_members": [],
"communication_external_group_members": [],
"communication_group_conditions": []
}
},
{
"id": "45695e60-e312-4e94-aba6-be35a2c624e3",
"type": "communications-groups",
"attributes": {
"name": "Communication Group 8",
"slug": "communication-group-8",
"description": null,
"is_private": false,
"condition_type": "any",
"email_channel": true,
"sms_channel": false,
"communication_type_id": "47974938-1fc2-452a-b253-2997156f0384",
"slack_channel_ids": [],
"created_at": "2025-07-12T00:12:57.756-07:00",
"updated_at": "2025-07-12T00:12:57.756-07:00",
"team_id": 58,
"communication_group_members": [],
"communication_external_group_members": [],
"communication_group_conditions": []
}
},
{
"id": "9c67bf57-573e-47a2-b116-bd5cd53dd548",
"type": "communications-groups",
"attributes": {
"name": "Communication Group 7",
"slug": "communication-group-7",
"description": null,
"is_private": false,
"condition_type": "any",
"email_channel": true,
"sms_channel": false,
"communication_type_id": "47974938-1fc2-452a-b253-2997156f0384",
"slack_channel_ids": [],
"created_at": "2025-07-12T00:12:56.636-07:00",
"updated_at": "2025-07-12T00:12:56.636-07:00",
"team_id": 58,
"communication_group_members": [],
"communication_external_group_members": [],
"communication_group_conditions": []
}
},
{
"id": "7d8978fb-e03e-4940-ad57-027fb3a0edaf",
"type": "communications-groups",
"attributes": {
"name": "Communication Group 6",
"slug": "communication-group-6",
"description": null,
"is_private": false,
"condition_type": "any",
"email_channel": true,
"sms_channel": false,
"communication_type_id": "47974938-1fc2-452a-b253-2997156f0384",
"slack_channel_ids": [],
"created_at": "2025-07-12T00:12:55.602-07:00",
"updated_at": "2025-07-12T00:12:55.602-07:00",
"team_id": 58,
"communication_group_members": [],
"communication_external_group_members": [],
"communication_group_conditions": []
}
},
{
"id": "a03d163e-4f14-4cbb-9378-052850e557b8",
"type": "communications-groups",
"attributes": {
"name": "Communication Group 5",
"slug": "communication-group-5",
"description": null,
"is_private": false,
"condition_type": "any",
"email_channel": true,
"sms_channel": false,
"communication_type_id": "47974938-1fc2-452a-b253-2997156f0384",
"slack_channel_ids": [],
"created_at": "2025-07-12T00:12:54.006-07:00",
"updated_at": "2025-07-12T00:12:54.006-07:00",
"team_id": 58,
"communication_group_members": [],
"communication_external_group_members": [],
"communication_group_conditions": []
}
},
{
"id": "154be4b4-8b16-4dcc-8818-72d8c71da824",
"type": "communications-groups",
"attributes": {
"name": "Communication Group 4",
"slug": "communication-group-4",
"description": null,
"is_private": false,
"condition_type": "any",
"email_channel": true,
"sms_channel": false,
"communication_type_id": "47974938-1fc2-452a-b253-2997156f0384",
"slack_channel_ids": [],
"created_at": "2025-07-12T00:12:52.766-07:00",
"updated_at": "2025-07-12T00:12:52.766-07:00",
"team_id": 58,
"communication_group_members": [],
"communication_external_group_members": [],
"communication_group_conditions": []
}
},
{
"id": "cb53f31a-dc39-443c-ad26-2922d0590944",
"type": "communications-groups",
"attributes": {
"name": "Communication Group 3",
"slug": "communication-group-3",
"description": null,
"is_private": false,
"condition_type": "any",
"email_channel": true,
"sms_channel": false,
"communication_type_id": "47974938-1fc2-452a-b253-2997156f0384",
"slack_channel_ids": [],
"created_at": "2025-07-12T00:12:51.657-07:00",
"updated_at": "2025-07-12T00:12:51.657-07:00",
"team_id": 58,
"communication_group_members": [],
"communication_external_group_members": [],
"communication_group_conditions": []
}
},
{
"id": "770fff15-c7d4-4a30-a3af-3465ca2de89c",
"type": "communications-groups",
"attributes": {
"name": "Communication Group 2",
"slug": "communication-group-2",
"description": null,
"is_private": false,
"condition_type": "any",
"email_channel": true,
"sms_channel": false,
"communication_type_id": "47974938-1fc2-452a-b253-2997156f0384",
"slack_channel_ids": [],
"created_at": "2025-07-12T00:12:50.582-07:00",
"updated_at": "2025-07-12T00:12:50.582-07:00",
"team_id": 58,
"communication_group_members": [],
"communication_external_group_members": [],
"communication_group_conditions": []
}
},
{
"id": "c3273d30-3f63-49b5-9e3a-fa55490974a9",
"type": "communications-groups",
"attributes": {
"name": "Communication Group 1",
"slug": "communication-group-1",
"description": null,
"is_private": false,
"condition_type": "any",
"email_channel": true,
"sms_channel": false,
"communication_type_id": "47974938-1fc2-452a-b253-2997156f0384",
"slack_channel_ids": [
"b94899c6-9bc5-58fd-b83d-873c4c73318c"
],
"created_at": "2025-07-12T00:12:49.488-07:00",
"updated_at": "2025-07-12T00:12:49.488-07:00",
"team_id": 58,
"communication_group_members": [
{
"id": "c7cd83ed-0b0b-4ff2-a984-34d3fab5abfb",
"user_id": 63,
"name": "Keila Stracke",
"email": "mike@corkery-emard.test"
}
],
"communication_external_group_members": [
{
"id": "c18f3978-5b49-4b2f-808d-01216f5935f0",
"name": "External member",
"email": "external@example.com",
"phone_number": "+911234567890"
}
],
"communication_group_conditions": [
{
"id": "e7d21fd1-70bb-4fb8-b8f1-afe25d2ab63a",
"condition": "is",
"property_type": "service",
"properties": [
{
"id": "2a60ae38-5f51-40c6-bab7-8cf9490f42c1",
"name": "Dolorem praesentium enim ut."
}
]
}
]
}
}
],
"links": {
"self": "http://www.example.com/v1/communications/groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
"first": "http://www.example.com/v1/communications/groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
"prev": null,
"next": null,
"last": "http://www.example.com/v1/communications/groups?page%5Bnumber%5D=1&page%5Bsize%5D=50"
},
"meta": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_count": 10,
"total_pages": 1
}
},
"schema": {
"$ref": "#/components/schemas/communications_groups_response"
}
}
}
}
}
}
},
"/v1/communications/groups/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"description": "Communications Group ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Shows a communications group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Groups"
],
"description": "Shows details of a communications group",
"operationId": "getCommunicationsGroup",
"responses": {
"200": {
"description": "communications group found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "c3273d30-3f63-49b5-9e3a-fa55490974a9",
"type": "communications-groups",
"attributes": {
"name": "Communication Group 1",
"slug": "communication-group-1",
"description": null,
"is_private": false,
"condition_type": "any",
"email_channel": true,
"sms_channel": false,
"communication_type_id": "47974938-1fc2-452a-b253-2997156f0384",
"slack_channel_ids": [
"b94899c6-9bc5-58fd-b83d-873c4c73318c"
],
"created_at": "2025-07-12T00:12:49.488-07:00",
"updated_at": "2025-07-12T00:12:49.488-07:00",
"team_id": 58,
"communication_group_members": [
{
"id": "c7cd83ed-0b0b-4ff2-a984-34d3fab5abfb",
"user_id": 63,
"name": "Keila Stracke",
"email": "mike@corkery-emard.test"
}
],
"communication_external_group_members": [
{
"id": "c18f3978-5b49-4b2f-808d-01216f5935f0",
"name": "External member",
"email": "external@example.com",
"phone_number": "+911234567890"
}
],
"communication_group_conditions": [
{
"id": "e7d21fd1-70bb-4fb8-b8f1-afe25d2ab63a",
"condition": "is",
"property_type": "service",
"properties": [
{
"id": "2a60ae38-5f51-40c6-bab7-8cf9490f42c1",
"name": "Dolorem praesentium enim ut."
}
]
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/communications_group_response"
}
}
}
},
"404": {
"description": "communications group not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"patch": {
"summary": "Updates a communications group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Groups"
],
"description": "Updates a communications group",
"operationId": "updateCommunicationsGroup",
"parameters": [],
"responses": {
"200": {
"description": "communications group updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "c3273d30-3f63-49b5-9e3a-fa55490974a9",
"type": "communications-groups",
"attributes": {
"name": "Updated Group Name",
"slug": "communication-group-1",
"description": "Updated description",
"is_private": false,
"condition_type": "any",
"email_channel": true,
"sms_channel": false,
"communication_type_id": "47974938-1fc2-452a-b253-2997156f0384",
"slack_channel_ids": [
"b94899c6-9bc5-58fd-b83d-873c4c73318c",
"797cd91c-c5a6-5519-aba3-9e6acdae19ba"
],
"created_at": "2025-07-12T00:12:49.488-07:00",
"updated_at": "2025-07-12T00:13:06.680-07:00",
"team_id": 58,
"communication_group_members": [],
"communication_external_group_members": [
{
"id": "c18f3978-5b49-4b2f-808d-01216f5935f0",
"name": "Updated External Member",
"email": "external@example.com",
"phone_number": "+911234567890"
}
],
"communication_group_conditions": [
{
"id": "e7d21fd1-70bb-4fb8-b8f1-afe25d2ab63a",
"condition": "is",
"property_type": "service",
"properties": []
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/communications_group_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_communications_group"
}
}
},
"required": true
}
},
"delete": {
"summary": "Deletes a communications group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Groups"
],
"description": "Deletes a communications group",
"operationId": "deleteCommunicationsGroup",
"responses": {
"200": {
"description": "communications group deleted"
},
"404": {
"description": "communications group not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/communications/stages": {
"post": {
"summary": "Creates a communications stage",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Stages"
],
"description": "Creates a new communications stage from provided data",
"operationId": "createCommunicationsStage",
"parameters": [],
"responses": {
"201": {
"description": "communications stage created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "9287ed75-725e-46ce-ad5e-0445f2dd8b78",
"type": "communications_stages",
"attributes": {
"name": "Investigation Started",
"slug": "investigation-started",
"description": "Stage when investigation begins",
"position": 11,
"created_at": "2025-07-12T00:13:10.970-07:00",
"updated_at": "2025-07-12T00:13:10.970-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/communications_stage_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "unauthorized",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_communications_stage"
}
}
},
"required": true
}
},
"get": {
"summary": "Lists communications stages",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Stages"
],
"description": "Lists communications stages",
"operationId": "listCommunicationsStages",
"parameters": [
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "communications stages found",
"content": {
"application/vnd.api+json": {
"example": {
"data": [
{
"id": "9d3186a1-b123-4e5f-a29a-535d674a6c03",
"type": "communications_stages",
"attributes": {
"name": "24sft",
"slug": "24sft",
"description": "Voluptas molestias ex laudantium.",
"position": 1,
"created_at": "2025-07-12T00:13:09.131-07:00",
"updated_at": "2025-07-12T00:13:09.131-07:00"
}
},
{
"id": "4b31583e-58ef-4ae6-9fd9-93493c527969",
"type": "communications_stages",
"attributes": {
"name": "awrhe",
"slug": "awrhe",
"description": "Minus eius iusto repellat.",
"position": 2,
"created_at": "2025-07-12T00:13:09.138-07:00",
"updated_at": "2025-07-12T00:13:09.138-07:00"
}
},
{
"id": "2d9d1260-b878-43e9-91e4-4b7bccfc77c4",
"type": "communications_stages",
"attributes": {
"name": "umfxg",
"slug": "umfxg",
"description": "Nihil optio autem non.",
"position": 3,
"created_at": "2025-07-12T00:13:09.146-07:00",
"updated_at": "2025-07-12T00:13:09.146-07:00"
}
},
{
"id": "8c459a6c-d55e-4400-9335-05fd0e890a8f",
"type": "communications_stages",
"attributes": {
"name": "k2jxa",
"slug": "k2jxa",
"description": "Autem ut veniam nulla.",
"position": 4,
"created_at": "2025-07-12T00:13:09.152-07:00",
"updated_at": "2025-07-12T00:13:09.152-07:00"
}
},
{
"id": "dc55fc61-bdd0-4a46-9e3f-7b9f04e6d3f3",
"type": "communications_stages",
"attributes": {
"name": "3uk1g",
"slug": "3uk1g",
"description": "Esse voluptatem corporis quisquam.",
"position": 5,
"created_at": "2025-07-12T00:13:09.159-07:00",
"updated_at": "2025-07-12T00:13:09.159-07:00"
}
},
{
"id": "ab4b83c1-8d70-4005-87ec-91ed88f12918",
"type": "communications_stages",
"attributes": {
"name": "1ek7a",
"slug": "1ek7a",
"description": "Aliquid et voluptatem dignissimos.",
"position": 6,
"created_at": "2025-07-12T00:13:09.165-07:00",
"updated_at": "2025-07-12T00:13:09.165-07:00"
}
},
{
"id": "e3c5c03a-e74a-4c97-a135-6297641d4560",
"type": "communications_stages",
"attributes": {
"name": "3ix8b",
"slug": "3ix8b",
"description": "Pariatur assumenda omnis ipsum.",
"position": 7,
"created_at": "2025-07-12T00:13:09.172-07:00",
"updated_at": "2025-07-12T00:13:09.172-07:00"
}
},
{
"id": "678363cb-b904-4877-9d4a-0170fce0ab94",
"type": "communications_stages",
"attributes": {
"name": "4q1rm",
"slug": "4q1rm",
"description": "Voluptas aut voluptatum qui.",
"position": 8,
"created_at": "2025-07-12T00:13:09.178-07:00",
"updated_at": "2025-07-12T00:13:09.178-07:00"
}
},
{
"id": "6d108a38-46f4-47df-a256-e02333d35cf8",
"type": "communications_stages",
"attributes": {
"name": "pizdy",
"slug": "pizdy",
"description": "Corrupti ut quaerat ipsam.",
"position": 9,
"created_at": "2025-07-12T00:13:09.184-07:00",
"updated_at": "2025-07-12T00:13:09.184-07:00"
}
},
{
"id": "0b98b9d0-d12a-4c01-866f-ee1edc219937",
"type": "communications_stages",
"attributes": {
"name": "kmm14",
"slug": "kmm14",
"description": "Et nihil quia sunt.",
"position": 10,
"created_at": "2025-07-12T00:13:09.191-07:00",
"updated_at": "2025-07-12T00:13:09.191-07:00"
}
}
],
"links": {
"self": "http://www.example.com/v1/communications/stages?page%5Bnumber%5D=1&page%5Bsize%5D=50",
"first": "http://www.example.com/v1/communications/stages?page%5Bnumber%5D=1&page%5Bsize%5D=50",
"prev": null,
"next": null,
"last": "http://www.example.com/v1/communications/stages?page%5Bnumber%5D=1&page%5Bsize%5D=50"
},
"meta": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_count": 10,
"total_pages": 1
}
},
"schema": {
"$ref": "#/components/schemas/communications_stages_response"
}
}
}
}
}
}
},
"/v1/communications/stages/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"description": "Communications Stage ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Shows a communications stage",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Stages"
],
"description": "Shows details of a communications stage",
"operationId": "getCommunicationsStage",
"responses": {
"200": {
"description": "communications stage found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "9d3186a1-b123-4e5f-a29a-535d674a6c03",
"type": "communications_stages",
"attributes": {
"name": "24sft",
"slug": "24sft",
"description": "Voluptas molestias ex laudantium.",
"position": 1,
"created_at": "2025-07-12T00:13:09.131-07:00",
"updated_at": "2025-07-12T00:13:09.131-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/communications_stage_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"patch": {
"summary": "Updates a communications stage",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Stages"
],
"description": "Updates a communications stage",
"operationId": "updateCommunicationsStage",
"parameters": [],
"responses": {
"200": {
"description": "communications stage updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "9d3186a1-b123-4e5f-a29a-535d674a6c03",
"type": "communications_stages",
"attributes": {
"name": "Updated Stage Name",
"slug": "24sft",
"description": "Updated description",
"position": 1,
"created_at": "2025-07-12T00:13:09.131-07:00",
"updated_at": "2025-07-12T00:13:11.973-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/communications_stage_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_communications_stage"
}
}
},
"required": true
}
},
"delete": {
"summary": "Deletes a communications stage",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Stages"
],
"description": "Deletes a communications stage",
"operationId": "deleteCommunicationsStage",
"responses": {
"200": {
"description": "communications stage deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "9d3186a1-b123-4e5f-a29a-535d674a6c03",
"type": "communications_stages",
"attributes": {
"name": "24sft",
"slug": "24sft",
"description": "Voluptas molestias ex laudantium.",
"position": 1,
"created_at": "2025-07-12T00:13:09.131-07:00",
"updated_at": "2025-07-12T00:13:12.347-07:00"
}
}
}
}
}
},
"404": {
"description": "communications stage not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/communications/templates": {
"post": {
"summary": "Creates a communications template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Templates"
],
"description": "Creates a new communications template from provided data",
"operationId": "createCommunicationsTemplate",
"parameters": [],
"responses": {
"201": {
"description": "communications template created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "1ecf6e53-f202-438e-8444-107b797e4cce",
"type": "communications-templates",
"attributes": {
"name": "Incident Created Template",
"slug": "incident-created-template",
"description": "Template for incident creation notifications",
"position": 11,
"created_at": "2025-07-12T00:13:15.798-07:00",
"updated_at": "2025-07-12T00:13:15.798-07:00",
"communication_type_id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"communication_type": {
"data": {
"id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"type": "communications_types",
"attributes": {
"name": "82mth",
"slug": "82mth",
"description": "Iusto explicabo reiciendis aut.",
"color": "#F5D9C4",
"position": 1,
"created_at": "2025-07-12T00:13:13.289-07:00",
"updated_at": "2025-07-12T00:13:13.289-07:00",
"communication_groups": [],
"communication_templates": [
{
"id": "1eae97c7-77e9-46dd-a7d0-05cbabe07062",
"name": "5r6qs"
},
{
"id": "248b8e51-b6ba-4541-87c2-40788345d803",
"name": "1jg78"
},
{
"id": "8a88263d-21f3-4573-80b4-3ec2a04e3276",
"name": "hnlaz"
},
{
"id": "c718adce-4e9a-4276-acd6-6622ac0b3b17",
"name": "jn6fy"
},
{
"id": "23c338ed-0fad-4514-9791-cc721da82b94",
"name": "w5cby"
},
{
"id": "592376bc-7349-4fbb-bbeb-baf2028683dd",
"name": "3jm37"
},
{
"id": "dab74dad-06b4-4f11-96a0-c43920158a98",
"name": "yay4z"
},
{
"id": "30d35b81-db86-488b-9701-3276ab047ab4",
"name": "jn5fq"
},
{
"id": "5e582084-aa58-4524-b695-8e3f66f917b3",
"name": "pcco0"
},
{
"id": "e4eda618-3e43-4223-9a2a-f85929dfd7bd",
"name": "fp8y2"
},
{
"id": "1ecf6e53-f202-438e-8444-107b797e4cce",
"name": "Incident Created Template"
}
]
}
}
},
"communication_template_stages": []
}
}
},
"schema": {
"$ref": "#/components/schemas/communications_template_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_communications_template"
}
}
},
"required": true
}
},
"get": {
"summary": "Lists communications templates",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Templates"
],
"description": "Lists communications templates",
"operationId": "listCommunicationsTemplates",
"parameters": [
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[communication_type_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "communications templates found",
"content": {
"application/vnd.api+json": {
"example": {
"data": [
{
"id": "1eae97c7-77e9-46dd-a7d0-05cbabe07062",
"type": "communications-templates",
"attributes": {
"name": "5r6qs",
"slug": "5r6qs",
"description": "Omnis dolor nihil quisquam.",
"position": 1,
"created_at": "2025-07-12T00:13:13.302-07:00",
"updated_at": "2025-07-12T00:13:13.302-07:00",
"communication_type_id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"communication_type": {
"data": {
"id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"type": "communications_types",
"attributes": {
"name": "82mth",
"slug": "82mth",
"description": "Iusto explicabo reiciendis aut.",
"color": "#F5D9C4",
"position": 1,
"created_at": "2025-07-12T00:13:13.289-07:00",
"updated_at": "2025-07-12T00:13:13.289-07:00",
"communication_groups": [],
"communication_templates": [
{
"id": "1eae97c7-77e9-46dd-a7d0-05cbabe07062",
"name": "5r6qs"
},
{
"id": "248b8e51-b6ba-4541-87c2-40788345d803",
"name": "1jg78"
},
{
"id": "8a88263d-21f3-4573-80b4-3ec2a04e3276",
"name": "hnlaz"
},
{
"id": "c718adce-4e9a-4276-acd6-6622ac0b3b17",
"name": "jn6fy"
},
{
"id": "23c338ed-0fad-4514-9791-cc721da82b94",
"name": "w5cby"
},
{
"id": "592376bc-7349-4fbb-bbeb-baf2028683dd",
"name": "3jm37"
},
{
"id": "dab74dad-06b4-4f11-96a0-c43920158a98",
"name": "yay4z"
},
{
"id": "30d35b81-db86-488b-9701-3276ab047ab4",
"name": "jn5fq"
},
{
"id": "5e582084-aa58-4524-b695-8e3f66f917b3",
"name": "pcco0"
},
{
"id": "e4eda618-3e43-4223-9a2a-f85929dfd7bd",
"name": "fp8y2"
}
]
}
}
},
"communication_template_stages": [
{
"data": {
"id": "5f37b7c8-b7b1-46f0-8889-847fe4010ece",
"type": "communications-template_stages",
"attributes": {
"email_body": "Non ex consequuntur dolores.",
"email_subject": "qz3qn9ptcm",
"slack_content": "Rerum explicabo perferendis at.",
"sms_content": "Tenetur velit dicta eum.",
"created_at": "2025-07-12T00:13:13.314-07:00",
"updated_at": "2025-07-12T00:13:13.314-07:00",
"communication_stage": {
"id": "5573f726-2acc-4db4-8fc1-df2eb7364788",
"name": "b4syh"
},
"communication_template": {
"id": "1eae97c7-77e9-46dd-a7d0-05cbabe07062",
"name": "5r6qs"
}
}
}
}
]
}
},
{
"id": "248b8e51-b6ba-4541-87c2-40788345d803",
"type": "communications-templates",
"attributes": {
"name": "1jg78",
"slug": "1jg78",
"description": "Ut eaque voluptatem qui.",
"position": 2,
"created_at": "2025-07-12T00:13:13.318-07:00",
"updated_at": "2025-07-12T00:13:13.318-07:00",
"communication_type_id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"communication_type": {
"data": {
"id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"type": "communications_types",
"attributes": {
"name": "82mth",
"slug": "82mth",
"description": "Iusto explicabo reiciendis aut.",
"color": "#F5D9C4",
"position": 1,
"created_at": "2025-07-12T00:13:13.289-07:00",
"updated_at": "2025-07-12T00:13:13.289-07:00",
"communication_groups": [],
"communication_templates": [
{
"id": "1eae97c7-77e9-46dd-a7d0-05cbabe07062",
"name": "5r6qs"
},
{
"id": "248b8e51-b6ba-4541-87c2-40788345d803",
"name": "1jg78"
},
{
"id": "8a88263d-21f3-4573-80b4-3ec2a04e3276",
"name": "hnlaz"
},
{
"id": "c718adce-4e9a-4276-acd6-6622ac0b3b17",
"name": "jn6fy"
},
{
"id": "23c338ed-0fad-4514-9791-cc721da82b94",
"name": "w5cby"
},
{
"id": "592376bc-7349-4fbb-bbeb-baf2028683dd",
"name": "3jm37"
},
{
"id": "dab74dad-06b4-4f11-96a0-c43920158a98",
"name": "yay4z"
},
{
"id": "30d35b81-db86-488b-9701-3276ab047ab4",
"name": "jn5fq"
},
{
"id": "5e582084-aa58-4524-b695-8e3f66f917b3",
"name": "pcco0"
},
{
"id": "e4eda618-3e43-4223-9a2a-f85929dfd7bd",
"name": "fp8y2"
}
]
}
}
},
"communication_template_stages": [
{
"data": {
"id": "cd435309-eb08-4c85-a082-8fead4e414d7",
"type": "communications-template_stages",
"attributes": {
"email_body": "Aliquam quis deleniti facilis.",
"email_subject": "lef80tu3zi",
"slack_content": "Accusantium aperiam occaecati voluptatem.",
"sms_content": "Et tenetur velit voluptatibus.",
"created_at": "2025-07-12T00:13:13.357-07:00",
"updated_at": "2025-07-12T00:13:13.357-07:00",
"communication_stage": {
"id": "add6a124-ce2b-4486-9696-a55421eb2dc2",
"name": "aidm4"
},
"communication_template": {
"id": "248b8e51-b6ba-4541-87c2-40788345d803",
"name": "1jg78"
}
}
}
}
]
}
},
{
"id": "8a88263d-21f3-4573-80b4-3ec2a04e3276",
"type": "communications-templates",
"attributes": {
"name": "hnlaz",
"slug": "hnlaz",
"description": "Occaecati sint temporibus aut.",
"position": 3,
"created_at": "2025-07-12T00:13:13.361-07:00",
"updated_at": "2025-07-12T00:13:13.361-07:00",
"communication_type_id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"communication_type": {
"data": {
"id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"type": "communications_types",
"attributes": {
"name": "82mth",
"slug": "82mth",
"description": "Iusto explicabo reiciendis aut.",
"color": "#F5D9C4",
"position": 1,
"created_at": "2025-07-12T00:13:13.289-07:00",
"updated_at": "2025-07-12T00:13:13.289-07:00",
"communication_groups": [],
"communication_templates": [
{
"id": "1eae97c7-77e9-46dd-a7d0-05cbabe07062",
"name": "5r6qs"
},
{
"id": "248b8e51-b6ba-4541-87c2-40788345d803",
"name": "1jg78"
},
{
"id": "8a88263d-21f3-4573-80b4-3ec2a04e3276",
"name": "hnlaz"
},
{
"id": "c718adce-4e9a-4276-acd6-6622ac0b3b17",
"name": "jn6fy"
},
{
"id": "23c338ed-0fad-4514-9791-cc721da82b94",
"name": "w5cby"
},
{
"id": "592376bc-7349-4fbb-bbeb-baf2028683dd",
"name": "3jm37"
},
{
"id": "dab74dad-06b4-4f11-96a0-c43920158a98",
"name": "yay4z"
},
{
"id": "30d35b81-db86-488b-9701-3276ab047ab4",
"name": "jn5fq"
},
{
"id": "5e582084-aa58-4524-b695-8e3f66f917b3",
"name": "pcco0"
},
{
"id": "e4eda618-3e43-4223-9a2a-f85929dfd7bd",
"name": "fp8y2"
}
]
}
}
},
"communication_template_stages": [
{
"data": {
"id": "40bfa5bb-c85f-4e88-a338-0d76b5204369",
"type": "communications-template_stages",
"attributes": {
"email_body": "Quia nesciunt nemo modi.",
"email_subject": "32esd90x85",
"slack_content": "Laboriosam asperiores culpa ipsam.",
"sms_content": "Qui eius ipsa dolores.",
"created_at": "2025-07-12T00:13:13.372-07:00",
"updated_at": "2025-07-12T00:13:13.372-07:00",
"communication_stage": {
"id": "2af847b1-d2e0-4683-b7bf-8b5fd2e13d91",
"name": "pfjk6"
},
"communication_template": {
"id": "8a88263d-21f3-4573-80b4-3ec2a04e3276",
"name": "hnlaz"
}
}
}
}
]
}
},
{
"id": "c718adce-4e9a-4276-acd6-6622ac0b3b17",
"type": "communications-templates",
"attributes": {
"name": "jn6fy",
"slug": "jn6fy",
"description": "Porro quia fugiat optio.",
"position": 4,
"created_at": "2025-07-12T00:13:13.376-07:00",
"updated_at": "2025-07-12T00:13:13.376-07:00",
"communication_type_id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"communication_type": {
"data": {
"id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"type": "communications_types",
"attributes": {
"name": "82mth",
"slug": "82mth",
"description": "Iusto explicabo reiciendis aut.",
"color": "#F5D9C4",
"position": 1,
"created_at": "2025-07-12T00:13:13.289-07:00",
"updated_at": "2025-07-12T00:13:13.289-07:00",
"communication_groups": [],
"communication_templates": [
{
"id": "1eae97c7-77e9-46dd-a7d0-05cbabe07062",
"name": "5r6qs"
},
{
"id": "248b8e51-b6ba-4541-87c2-40788345d803",
"name": "1jg78"
},
{
"id": "8a88263d-21f3-4573-80b4-3ec2a04e3276",
"name": "hnlaz"
},
{
"id": "c718adce-4e9a-4276-acd6-6622ac0b3b17",
"name": "jn6fy"
},
{
"id": "23c338ed-0fad-4514-9791-cc721da82b94",
"name": "w5cby"
},
{
"id": "592376bc-7349-4fbb-bbeb-baf2028683dd",
"name": "3jm37"
},
{
"id": "dab74dad-06b4-4f11-96a0-c43920158a98",
"name": "yay4z"
},
{
"id": "30d35b81-db86-488b-9701-3276ab047ab4",
"name": "jn5fq"
},
{
"id": "5e582084-aa58-4524-b695-8e3f66f917b3",
"name": "pcco0"
},
{
"id": "e4eda618-3e43-4223-9a2a-f85929dfd7bd",
"name": "fp8y2"
}
]
}
}
},
"communication_template_stages": [
{
"data": {
"id": "c08710f5-df56-4d61-a55a-f5ec2a7a2392",
"type": "communications-template_stages",
"attributes": {
"email_body": "Tenetur ipsam dolores voluptates.",
"email_subject": "2u7zsolhmi",
"slack_content": "Amet nesciunt eos voluptate.",
"sms_content": "Eveniet molestiae tempora consequuntur.",
"created_at": "2025-07-12T00:13:13.385-07:00",
"updated_at": "2025-07-12T00:13:13.385-07:00",
"communication_stage": {
"id": "1df857e9-9ae2-4203-9927-a72ea76b3f9b",
"name": "db6fk"
},
"communication_template": {
"id": "c718adce-4e9a-4276-acd6-6622ac0b3b17",
"name": "jn6fy"
}
}
}
}
]
}
},
{
"id": "23c338ed-0fad-4514-9791-cc721da82b94",
"type": "communications-templates",
"attributes": {
"name": "w5cby",
"slug": "w5cby",
"description": "Nesciunt atque repellendus iure.",
"position": 5,
"created_at": "2025-07-12T00:13:13.388-07:00",
"updated_at": "2025-07-12T00:13:13.388-07:00",
"communication_type_id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"communication_type": {
"data": {
"id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"type": "communications_types",
"attributes": {
"name": "82mth",
"slug": "82mth",
"description": "Iusto explicabo reiciendis aut.",
"color": "#F5D9C4",
"position": 1,
"created_at": "2025-07-12T00:13:13.289-07:00",
"updated_at": "2025-07-12T00:13:13.289-07:00",
"communication_groups": [],
"communication_templates": [
{
"id": "1eae97c7-77e9-46dd-a7d0-05cbabe07062",
"name": "5r6qs"
},
{
"id": "248b8e51-b6ba-4541-87c2-40788345d803",
"name": "1jg78"
},
{
"id": "8a88263d-21f3-4573-80b4-3ec2a04e3276",
"name": "hnlaz"
},
{
"id": "c718adce-4e9a-4276-acd6-6622ac0b3b17",
"name": "jn6fy"
},
{
"id": "23c338ed-0fad-4514-9791-cc721da82b94",
"name": "w5cby"
},
{
"id": "592376bc-7349-4fbb-bbeb-baf2028683dd",
"name": "3jm37"
},
{
"id": "dab74dad-06b4-4f11-96a0-c43920158a98",
"name": "yay4z"
},
{
"id": "30d35b81-db86-488b-9701-3276ab047ab4",
"name": "jn5fq"
},
{
"id": "5e582084-aa58-4524-b695-8e3f66f917b3",
"name": "pcco0"
},
{
"id": "e4eda618-3e43-4223-9a2a-f85929dfd7bd",
"name": "fp8y2"
}
]
}
}
},
"communication_template_stages": [
{
"data": {
"id": "c3b57616-92bd-4019-b55d-884ed3fad08a",
"type": "communications-template_stages",
"attributes": {
"email_body": "Quaerat autem molestiae hic.",
"email_subject": "gns50rou24",
"slack_content": "Ad molestias asperiores facere.",
"sms_content": "Voluptas omnis expedita consequatur.",
"created_at": "2025-07-12T00:13:13.397-07:00",
"updated_at": "2025-07-12T00:13:13.397-07:00",
"communication_stage": {
"id": "93365557-e0a3-4e52-bbad-e33ffbf41b5f",
"name": "ejvx1"
},
"communication_template": {
"id": "23c338ed-0fad-4514-9791-cc721da82b94",
"name": "w5cby"
}
}
}
}
]
}
},
{
"id": "592376bc-7349-4fbb-bbeb-baf2028683dd",
"type": "communications-templates",
"attributes": {
"name": "3jm37",
"slug": "3jm37",
"description": "Eveniet recusandae porro consequatur.",
"position": 6,
"created_at": "2025-07-12T00:13:13.401-07:00",
"updated_at": "2025-07-12T00:13:13.401-07:00",
"communication_type_id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"communication_type": {
"data": {
"id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"type": "communications_types",
"attributes": {
"name": "82mth",
"slug": "82mth",
"description": "Iusto explicabo reiciendis aut.",
"color": "#F5D9C4",
"position": 1,
"created_at": "2025-07-12T00:13:13.289-07:00",
"updated_at": "2025-07-12T00:13:13.289-07:00",
"communication_groups": [],
"communication_templates": [
{
"id": "1eae97c7-77e9-46dd-a7d0-05cbabe07062",
"name": "5r6qs"
},
{
"id": "248b8e51-b6ba-4541-87c2-40788345d803",
"name": "1jg78"
},
{
"id": "8a88263d-21f3-4573-80b4-3ec2a04e3276",
"name": "hnlaz"
},
{
"id": "c718adce-4e9a-4276-acd6-6622ac0b3b17",
"name": "jn6fy"
},
{
"id": "23c338ed-0fad-4514-9791-cc721da82b94",
"name": "w5cby"
},
{
"id": "592376bc-7349-4fbb-bbeb-baf2028683dd",
"name": "3jm37"
},
{
"id": "dab74dad-06b4-4f11-96a0-c43920158a98",
"name": "yay4z"
},
{
"id": "30d35b81-db86-488b-9701-3276ab047ab4",
"name": "jn5fq"
},
{
"id": "5e582084-aa58-4524-b695-8e3f66f917b3",
"name": "pcco0"
},
{
"id": "e4eda618-3e43-4223-9a2a-f85929dfd7bd",
"name": "fp8y2"
}
]
}
}
},
"communication_template_stages": [
{
"data": {
"id": "a2cf84bf-b567-4cfc-8040-e116f2ad5ca1",
"type": "communications-template_stages",
"attributes": {
"email_body": "Vel dolores excepturi nam.",
"email_subject": "76ih26pwm3",
"slack_content": "Repellendus numquam omnis non.",
"sms_content": "Debitis dolorum quia neque.",
"created_at": "2025-07-12T00:13:13.410-07:00",
"updated_at": "2025-07-12T00:13:13.410-07:00",
"communication_stage": {
"id": "e21afd60-d211-49d4-b217-22da8bc22782",
"name": "k2b68"
},
"communication_template": {
"id": "592376bc-7349-4fbb-bbeb-baf2028683dd",
"name": "3jm37"
}
}
}
}
]
}
},
{
"id": "dab74dad-06b4-4f11-96a0-c43920158a98",
"type": "communications-templates",
"attributes": {
"name": "yay4z",
"slug": "yay4z",
"description": "Sit fugiat at animi.",
"position": 7,
"created_at": "2025-07-12T00:13:13.414-07:00",
"updated_at": "2025-07-12T00:13:13.414-07:00",
"communication_type_id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"communication_type": {
"data": {
"id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"type": "communications_types",
"attributes": {
"name": "82mth",
"slug": "82mth",
"description": "Iusto explicabo reiciendis aut.",
"color": "#F5D9C4",
"position": 1,
"created_at": "2025-07-12T00:13:13.289-07:00",
"updated_at": "2025-07-12T00:13:13.289-07:00",
"communication_groups": [],
"communication_templates": [
{
"id": "1eae97c7-77e9-46dd-a7d0-05cbabe07062",
"name": "5r6qs"
},
{
"id": "248b8e51-b6ba-4541-87c2-40788345d803",
"name": "1jg78"
},
{
"id": "8a88263d-21f3-4573-80b4-3ec2a04e3276",
"name": "hnlaz"
},
{
"id": "c718adce-4e9a-4276-acd6-6622ac0b3b17",
"name": "jn6fy"
},
{
"id": "23c338ed-0fad-4514-9791-cc721da82b94",
"name": "w5cby"
},
{
"id": "592376bc-7349-4fbb-bbeb-baf2028683dd",
"name": "3jm37"
},
{
"id": "dab74dad-06b4-4f11-96a0-c43920158a98",
"name": "yay4z"
},
{
"id": "30d35b81-db86-488b-9701-3276ab047ab4",
"name": "jn5fq"
},
{
"id": "5e582084-aa58-4524-b695-8e3f66f917b3",
"name": "pcco0"
},
{
"id": "e4eda618-3e43-4223-9a2a-f85929dfd7bd",
"name": "fp8y2"
}
]
}
}
},
"communication_template_stages": [
{
"data": {
"id": "952ee7c0-2938-41ed-b5b8-4bcfce2ca1b6",
"type": "communications-template_stages",
"attributes": {
"email_body": "In et laborum voluptatem.",
"email_subject": "rclujwgob0",
"slack_content": "Saepe nisi aut sit.",
"sms_content": "Omnis totam quia sunt.",
"created_at": "2025-07-12T00:13:13.423-07:00",
"updated_at": "2025-07-12T00:13:13.423-07:00",
"communication_stage": {
"id": "0c56c17e-65f1-4ee2-9f1f-de1e335c2e32",
"name": "w5lnn"
},
"communication_template": {
"id": "dab74dad-06b4-4f11-96a0-c43920158a98",
"name": "yay4z"
}
}
}
}
]
}
},
{
"id": "30d35b81-db86-488b-9701-3276ab047ab4",
"type": "communications-templates",
"attributes": {
"name": "jn5fq",
"slug": "jn5fq",
"description": "Dolorum nulla voluptas magni.",
"position": 8,
"created_at": "2025-07-12T00:13:13.427-07:00",
"updated_at": "2025-07-12T00:13:13.427-07:00",
"communication_type_id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"communication_type": {
"data": {
"id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"type": "communications_types",
"attributes": {
"name": "82mth",
"slug": "82mth",
"description": "Iusto explicabo reiciendis aut.",
"color": "#F5D9C4",
"position": 1,
"created_at": "2025-07-12T00:13:13.289-07:00",
"updated_at": "2025-07-12T00:13:13.289-07:00",
"communication_groups": [],
"communication_templates": [
{
"id": "1eae97c7-77e9-46dd-a7d0-05cbabe07062",
"name": "5r6qs"
},
{
"id": "248b8e51-b6ba-4541-87c2-40788345d803",
"name": "1jg78"
},
{
"id": "8a88263d-21f3-4573-80b4-3ec2a04e3276",
"name": "hnlaz"
},
{
"id": "c718adce-4e9a-4276-acd6-6622ac0b3b17",
"name": "jn6fy"
},
{
"id": "23c338ed-0fad-4514-9791-cc721da82b94",
"name": "w5cby"
},
{
"id": "592376bc-7349-4fbb-bbeb-baf2028683dd",
"name": "3jm37"
},
{
"id": "dab74dad-06b4-4f11-96a0-c43920158a98",
"name": "yay4z"
},
{
"id": "30d35b81-db86-488b-9701-3276ab047ab4",
"name": "jn5fq"
},
{
"id": "5e582084-aa58-4524-b695-8e3f66f917b3",
"name": "pcco0"
},
{
"id": "e4eda618-3e43-4223-9a2a-f85929dfd7bd",
"name": "fp8y2"
}
]
}
}
},
"communication_template_stages": [
{
"data": {
"id": "2d15ce0a-ca16-4843-95e5-841d838a0b71",
"type": "communications-template_stages",
"attributes": {
"email_body": "Deleniti earum ipsum rem.",
"email_subject": "k5l9245huq",
"slack_content": "Quia sed omnis repellat.",
"sms_content": "Doloremque consequuntur ut similique.",
"created_at": "2025-07-12T00:13:13.436-07:00",
"updated_at": "2025-07-12T00:13:13.436-07:00",
"communication_stage": {
"id": "cc993d2c-6997-40e8-b8fa-915c3d712bc1",
"name": "fzfr1"
},
"communication_template": {
"id": "30d35b81-db86-488b-9701-3276ab047ab4",
"name": "jn5fq"
}
}
}
}
]
}
},
{
"id": "5e582084-aa58-4524-b695-8e3f66f917b3",
"type": "communications-templates",
"attributes": {
"name": "pcco0",
"slug": "pcco0",
"description": "Ut officia vitae porro.",
"position": 9,
"created_at": "2025-07-12T00:13:13.439-07:00",
"updated_at": "2025-07-12T00:13:13.439-07:00",
"communication_type_id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"communication_type": {
"data": {
"id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"type": "communications_types",
"attributes": {
"name": "82mth",
"slug": "82mth",
"description": "Iusto explicabo reiciendis aut.",
"color": "#F5D9C4",
"position": 1,
"created_at": "2025-07-12T00:13:13.289-07:00",
"updated_at": "2025-07-12T00:13:13.289-07:00",
"communication_groups": [],
"communication_templates": [
{
"id": "1eae97c7-77e9-46dd-a7d0-05cbabe07062",
"name": "5r6qs"
},
{
"id": "248b8e51-b6ba-4541-87c2-40788345d803",
"name": "1jg78"
},
{
"id": "8a88263d-21f3-4573-80b4-3ec2a04e3276",
"name": "hnlaz"
},
{
"id": "c718adce-4e9a-4276-acd6-6622ac0b3b17",
"name": "jn6fy"
},
{
"id": "23c338ed-0fad-4514-9791-cc721da82b94",
"name": "w5cby"
},
{
"id": "592376bc-7349-4fbb-bbeb-baf2028683dd",
"name": "3jm37"
},
{
"id": "dab74dad-06b4-4f11-96a0-c43920158a98",
"name": "yay4z"
},
{
"id": "30d35b81-db86-488b-9701-3276ab047ab4",
"name": "jn5fq"
},
{
"id": "5e582084-aa58-4524-b695-8e3f66f917b3",
"name": "pcco0"
},
{
"id": "e4eda618-3e43-4223-9a2a-f85929dfd7bd",
"name": "fp8y2"
}
]
}
}
},
"communication_template_stages": [
{
"data": {
"id": "6f0f5383-5267-47e2-aaba-48569ef052c2",
"type": "communications-template_stages",
"attributes": {
"email_body": "Voluptatem eum officia officiis.",
"email_subject": "rmzdj36da3",
"slack_content": "Officiis quo laborum expedita.",
"sms_content": "Cupiditate fugit occaecati aut.",
"created_at": "2025-07-12T00:13:13.449-07:00",
"updated_at": "2025-07-12T00:13:13.449-07:00",
"communication_stage": {
"id": "fd9d0181-3752-45f1-ae66-4ec93429c4c2",
"name": "3ke2e"
},
"communication_template": {
"id": "5e582084-aa58-4524-b695-8e3f66f917b3",
"name": "pcco0"
}
}
}
}
]
}
},
{
"id": "e4eda618-3e43-4223-9a2a-f85929dfd7bd",
"type": "communications-templates",
"attributes": {
"name": "fp8y2",
"slug": "fp8y2",
"description": "Repudiandae occaecati harum tempore.",
"position": 10,
"created_at": "2025-07-12T00:13:13.453-07:00",
"updated_at": "2025-07-12T00:13:13.453-07:00",
"communication_type_id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"communication_type": {
"data": {
"id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"type": "communications_types",
"attributes": {
"name": "82mth",
"slug": "82mth",
"description": "Iusto explicabo reiciendis aut.",
"color": "#F5D9C4",
"position": 1,
"created_at": "2025-07-12T00:13:13.289-07:00",
"updated_at": "2025-07-12T00:13:13.289-07:00",
"communication_groups": [],
"communication_templates": [
{
"id": "1eae97c7-77e9-46dd-a7d0-05cbabe07062",
"name": "5r6qs"
},
{
"id": "248b8e51-b6ba-4541-87c2-40788345d803",
"name": "1jg78"
},
{
"id": "8a88263d-21f3-4573-80b4-3ec2a04e3276",
"name": "hnlaz"
},
{
"id": "c718adce-4e9a-4276-acd6-6622ac0b3b17",
"name": "jn6fy"
},
{
"id": "23c338ed-0fad-4514-9791-cc721da82b94",
"name": "w5cby"
},
{
"id": "592376bc-7349-4fbb-bbeb-baf2028683dd",
"name": "3jm37"
},
{
"id": "dab74dad-06b4-4f11-96a0-c43920158a98",
"name": "yay4z"
},
{
"id": "30d35b81-db86-488b-9701-3276ab047ab4",
"name": "jn5fq"
},
{
"id": "5e582084-aa58-4524-b695-8e3f66f917b3",
"name": "pcco0"
},
{
"id": "e4eda618-3e43-4223-9a2a-f85929dfd7bd",
"name": "fp8y2"
}
]
}
}
},
"communication_template_stages": [
{
"data": {
"id": "8d4d6edf-7896-4183-8376-99c720825149",
"type": "communications-template_stages",
"attributes": {
"email_body": "Et cum explicabo accusantium.",
"email_subject": "s0qmturoy6",
"slack_content": "Dolores consequuntur et modi.",
"sms_content": "Suscipit blanditiis et ut.",
"created_at": "2025-07-12T00:13:13.462-07:00",
"updated_at": "2025-07-12T00:13:13.462-07:00",
"communication_stage": {
"id": "1e6b90da-d682-472b-8cfd-9ce93805cebd",
"name": "tkf0a"
},
"communication_template": {
"id": "e4eda618-3e43-4223-9a2a-f85929dfd7bd",
"name": "fp8y2"
}
}
}
}
]
}
}
],
"links": {
"self": "http://www.example.com/v1/communications/templates?page%5Bnumber%5D=1&page%5Bsize%5D=50",
"first": "http://www.example.com/v1/communications/templates?page%5Bnumber%5D=1&page%5Bsize%5D=50",
"prev": null,
"next": null,
"last": "http://www.example.com/v1/communications/templates?page%5Bnumber%5D=1&page%5Bsize%5D=50"
},
"meta": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_count": 10,
"total_pages": 1
}
},
"schema": {
"$ref": "#/components/schemas/communications_templates_response"
}
}
}
}
}
}
},
"/v1/communications/templates/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"description": "Communications Template ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Shows a communications template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Templates"
],
"description": "Shows details of a communications template",
"operationId": "getCommunicationsTemplate",
"responses": {
"200": {
"description": "communications template found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "1eae97c7-77e9-46dd-a7d0-05cbabe07062",
"type": "communications-templates",
"attributes": {
"name": "5r6qs",
"slug": "5r6qs",
"description": "Omnis dolor nihil quisquam.",
"position": 1,
"created_at": "2025-07-12T00:13:13.302-07:00",
"updated_at": "2025-07-12T00:13:13.302-07:00",
"communication_type_id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"communication_type": {
"data": {
"id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"type": "communications_types",
"attributes": {
"name": "82mth",
"slug": "82mth",
"description": "Iusto explicabo reiciendis aut.",
"color": "#F5D9C4",
"position": 1,
"created_at": "2025-07-12T00:13:13.289-07:00",
"updated_at": "2025-07-12T00:13:13.289-07:00",
"communication_groups": [],
"communication_templates": [
{
"id": "1eae97c7-77e9-46dd-a7d0-05cbabe07062",
"name": "5r6qs"
},
{
"id": "248b8e51-b6ba-4541-87c2-40788345d803",
"name": "1jg78"
},
{
"id": "8a88263d-21f3-4573-80b4-3ec2a04e3276",
"name": "hnlaz"
},
{
"id": "c718adce-4e9a-4276-acd6-6622ac0b3b17",
"name": "jn6fy"
},
{
"id": "23c338ed-0fad-4514-9791-cc721da82b94",
"name": "w5cby"
},
{
"id": "592376bc-7349-4fbb-bbeb-baf2028683dd",
"name": "3jm37"
},
{
"id": "dab74dad-06b4-4f11-96a0-c43920158a98",
"name": "yay4z"
},
{
"id": "30d35b81-db86-488b-9701-3276ab047ab4",
"name": "jn5fq"
},
{
"id": "5e582084-aa58-4524-b695-8e3f66f917b3",
"name": "pcco0"
},
{
"id": "e4eda618-3e43-4223-9a2a-f85929dfd7bd",
"name": "fp8y2"
}
]
}
}
},
"communication_template_stages": [
{
"data": {
"id": "5f37b7c8-b7b1-46f0-8889-847fe4010ece",
"type": "communications-template_stages",
"attributes": {
"email_body": "Non ex consequuntur dolores.",
"email_subject": "qz3qn9ptcm",
"slack_content": "Rerum explicabo perferendis at.",
"sms_content": "Tenetur velit dicta eum.",
"created_at": "2025-07-12T00:13:13.314-07:00",
"updated_at": "2025-07-12T00:13:13.314-07:00",
"communication_stage": {
"id": "5573f726-2acc-4db4-8fc1-df2eb7364788",
"name": "b4syh"
},
"communication_template": {
"id": "1eae97c7-77e9-46dd-a7d0-05cbabe07062",
"name": "5r6qs"
}
}
}
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/communications_template_response"
}
}
}
},
"404": {
"description": "communications template not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"patch": {
"summary": "Updates a communications template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Templates"
],
"description": "Updates a communications template",
"operationId": "updateCommunicationsTemplate",
"parameters": [],
"responses": {
"200": {
"description": "communications template updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "1eae97c7-77e9-46dd-a7d0-05cbabe07062",
"type": "communications-templates",
"attributes": {
"name": "Updated Template Name",
"slug": "5r6qs",
"description": "Updated description",
"position": 1,
"created_at": "2025-07-12T00:13:13.302-07:00",
"updated_at": "2025-07-12T00:13:16.667-07:00",
"communication_type_id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"communication_type": {
"data": {
"id": "b2af583c-57c5-4edd-a8fb-0b7cf8bf4868",
"type": "communications_types",
"attributes": {
"name": "82mth",
"slug": "82mth",
"description": "Iusto explicabo reiciendis aut.",
"color": "#F5D9C4",
"position": 1,
"created_at": "2025-07-12T00:13:13.289-07:00",
"updated_at": "2025-07-12T00:13:13.289-07:00",
"communication_groups": [],
"communication_templates": [
{
"id": "1eae97c7-77e9-46dd-a7d0-05cbabe07062",
"name": "Updated Template Name"
},
{
"id": "248b8e51-b6ba-4541-87c2-40788345d803",
"name": "1jg78"
},
{
"id": "8a88263d-21f3-4573-80b4-3ec2a04e3276",
"name": "hnlaz"
},
{
"id": "c718adce-4e9a-4276-acd6-6622ac0b3b17",
"name": "jn6fy"
},
{
"id": "23c338ed-0fad-4514-9791-cc721da82b94",
"name": "w5cby"
},
{
"id": "592376bc-7349-4fbb-bbeb-baf2028683dd",
"name": "3jm37"
},
{
"id": "dab74dad-06b4-4f11-96a0-c43920158a98",
"name": "yay4z"
},
{
"id": "30d35b81-db86-488b-9701-3276ab047ab4",
"name": "jn5fq"
},
{
"id": "5e582084-aa58-4524-b695-8e3f66f917b3",
"name": "pcco0"
},
{
"id": "e4eda618-3e43-4223-9a2a-f85929dfd7bd",
"name": "fp8y2"
}
]
}
}
},
"communication_template_stages": [
{
"data": {
"id": "5f37b7c8-b7b1-46f0-8889-847fe4010ece",
"type": "communications-template_stages",
"attributes": {
"email_body": "Non ex consequuntur dolores.",
"email_subject": "qz3qn9ptcm",
"slack_content": "Rerum explicabo perferendis at.",
"sms_content": "Tenetur velit dicta eum.",
"created_at": "2025-07-12T00:13:13.314-07:00",
"updated_at": "2025-07-12T00:13:13.314-07:00",
"communication_stage": {
"id": "5573f726-2acc-4db4-8fc1-df2eb7364788",
"name": "b4syh"
},
"communication_template": {
"id": "1eae97c7-77e9-46dd-a7d0-05cbabe07062",
"name": "Updated Template Name"
}
}
}
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/communications_template_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_communications_template"
}
}
},
"required": true
}
},
"delete": {
"summary": "Deletes a communications template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Templates"
],
"description": "Deletes a communications template",
"operationId": "deleteCommunicationsTemplate",
"responses": {
"200": {
"description": "communications template deleted"
},
"404": {
"description": "communications template not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/communications/types": {
"post": {
"summary": "Creates a communications type",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Types"
],
"description": "Creates a new communications type from provided data",
"operationId": "createCommunicationsType",
"parameters": [],
"responses": {
"201": {
"description": "communications type created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "6c708094-9132-4dc1-b163-5c4feb5e1896",
"type": "communications_types",
"attributes": {
"name": "Incident Notifications",
"slug": "incident-notifications",
"description": "Type for incident-related communications",
"color": "#FF5733",
"position": 11,
"created_at": "2025-07-12T00:13:19.947-07:00",
"updated_at": "2025-07-12T00:13:19.947-07:00",
"communication_groups": [],
"communication_templates": []
}
}
},
"schema": {
"$ref": "#/components/schemas/communications_type_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_communications_type"
}
}
},
"required": true
}
},
"get": {
"summary": "Lists communications types",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Types"
],
"description": "Lists communications types",
"operationId": "listCommunicationsTypes",
"parameters": [
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "communications types found",
"content": {
"application/vnd.api+json": {
"example": {
"data": [
{
"id": "4cf6542f-05ad-49bf-a15f-0d98729877dc",
"type": "communications_types",
"attributes": {
"name": "gofrm",
"slug": "gofrm",
"description": "Laboriosam dignissimos eligendi harum.",
"color": "#D7F5E1",
"position": 1,
"created_at": "2025-07-12T00:13:18.006-07:00",
"updated_at": "2025-07-12T00:13:18.006-07:00",
"communication_groups": [],
"communication_templates": []
}
},
{
"id": "87a15679-c538-4a7b-be03-0671eb36ba18",
"type": "communications_types",
"attributes": {
"name": "c3tii",
"slug": "c3tii",
"description": "Quia odio eum quos.",
"color": "#D7E7F5",
"position": 2,
"created_at": "2025-07-12T00:13:18.010-07:00",
"updated_at": "2025-07-12T00:13:18.010-07:00",
"communication_groups": [],
"communication_templates": []
}
},
{
"id": "c4b15c32-b8f9-44a1-98af-2873a2c031f4",
"type": "communications_types",
"attributes": {
"name": "tccz8",
"slug": "tccz8",
"description": "Saepe voluptatum similique in.",
"color": "#D7F5E1",
"position": 3,
"created_at": "2025-07-12T00:13:18.017-07:00",
"updated_at": "2025-07-12T00:13:18.017-07:00",
"communication_groups": [],
"communication_templates": []
}
},
{
"id": "c415b543-25b2-4551-914f-82e5e612e0f8",
"type": "communications_types",
"attributes": {
"name": "sb69x",
"slug": "sb69x",
"description": "Amet eveniet magni expedita.",
"color": "#D7F5E1",
"position": 4,
"created_at": "2025-07-12T00:13:18.022-07:00",
"updated_at": "2025-07-12T00:13:18.022-07:00",
"communication_groups": [],
"communication_templates": []
}
},
{
"id": "a3de0ddb-d550-42c9-a97e-a8a51a6349dc",
"type": "communications_types",
"attributes": {
"name": "gnbfm",
"slug": "gnbfm",
"description": "Ut perferendis consequatur ducimus.",
"color": "#D7F5E1",
"position": 5,
"created_at": "2025-07-12T00:13:18.027-07:00",
"updated_at": "2025-07-12T00:13:18.027-07:00",
"communication_groups": [],
"communication_templates": []
}
},
{
"id": "81fc3de9-33d4-417a-a1ac-5b83f813ef12",
"type": "communications_types",
"attributes": {
"name": "raoec",
"slug": "raoec",
"description": "Non et rerum cupiditate.",
"color": "#FAEBB7",
"position": 6,
"created_at": "2025-07-12T00:13:18.032-07:00",
"updated_at": "2025-07-12T00:13:18.032-07:00",
"communication_groups": [],
"communication_templates": []
}
},
{
"id": "73ae3e6b-3524-4a84-b682-3f8b93a7d589",
"type": "communications_types",
"attributes": {
"name": "xsfhy",
"slug": "xsfhy",
"description": "Quo sapiente fuga enim.",
"color": "#F5D9C4",
"position": 7,
"created_at": "2025-07-12T00:13:18.037-07:00",
"updated_at": "2025-07-12T00:13:18.037-07:00",
"communication_groups": [],
"communication_templates": []
}
},
{
"id": "df1dfef6-7597-4307-8055-f6b0e579225b",
"type": "communications_types",
"attributes": {
"name": "g6fx4",
"slug": "g6fx4",
"description": "Dolorem dolorum eum ex.",
"color": "#F5D9C4",
"position": 8,
"created_at": "2025-07-12T00:13:18.042-07:00",
"updated_at": "2025-07-12T00:13:18.042-07:00",
"communication_groups": [],
"communication_templates": []
}
},
{
"id": "74b5265f-bbff-4247-a5e3-a96a9d82ac32",
"type": "communications_types",
"attributes": {
"name": "ru6y2",
"slug": "ru6y2",
"description": "Sint iusto ut similique.",
"color": "#F4CFD1",
"position": 9,
"created_at": "2025-07-12T00:13:18.047-07:00",
"updated_at": "2025-07-12T00:13:18.047-07:00",
"communication_groups": [],
"communication_templates": []
}
},
{
"id": "ae3b3064-e00d-4562-9350-8bf2286f4802",
"type": "communications_types",
"attributes": {
"name": "abvfb",
"slug": "abvfb",
"description": "Aut quas qui quisquam.",
"color": "#F4CFD1",
"position": 10,
"created_at": "2025-07-12T00:13:18.053-07:00",
"updated_at": "2025-07-12T00:13:18.053-07:00",
"communication_groups": [],
"communication_templates": []
}
}
],
"links": {
"self": "http://www.example.com/v1/communications/types?page%5Bnumber%5D=1&page%5Bsize%5D=50",
"first": "http://www.example.com/v1/communications/types?page%5Bnumber%5D=1&page%5Bsize%5D=50",
"prev": null,
"next": null,
"last": "http://www.example.com/v1/communications/types?page%5Bnumber%5D=1&page%5Bsize%5D=50"
},
"meta": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_count": 10,
"total_pages": 1
}
},
"schema": {
"$ref": "#/components/schemas/communications_types_response"
}
}
}
}
}
}
},
"/v1/communications/types/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"description": "Communications Type ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Shows a communications type",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Types"
],
"description": "Shows details of a communications type",
"operationId": "getCommunicationsType",
"responses": {
"200": {
"description": "communications type found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "4cf6542f-05ad-49bf-a15f-0d98729877dc",
"type": "communications_types",
"attributes": {
"name": "gofrm",
"slug": "gofrm",
"description": "Laboriosam dignissimos eligendi harum.",
"color": "#D7F5E1",
"position": 1,
"created_at": "2025-07-12T00:13:18.006-07:00",
"updated_at": "2025-07-12T00:13:18.006-07:00",
"communication_groups": [],
"communication_templates": []
}
}
},
"schema": {
"$ref": "#/components/schemas/communications_type_response"
}
}
}
},
"404": {
"description": "communications type not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"patch": {
"summary": "Updates a communications type",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Types"
],
"description": "Updates a communications type",
"operationId": "updateCommunicationsType",
"parameters": [],
"responses": {
"200": {
"description": "communications type updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "4cf6542f-05ad-49bf-a15f-0d98729877dc",
"type": "communications_types",
"attributes": {
"name": "Updated Type Name",
"slug": "gofrm",
"description": "Updated description",
"color": "#00FF00",
"position": 1,
"created_at": "2025-07-12T00:13:18.006-07:00",
"updated_at": "2025-07-12T00:13:20.761-07:00",
"communication_groups": [],
"communication_templates": []
}
}
},
"schema": {
"$ref": "#/components/schemas/communications_type_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_communications_type"
}
}
},
"required": true
}
},
"delete": {
"summary": "Deletes a communications type",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Types"
],
"description": "Deletes a communications type",
"operationId": "deleteCommunicationsType",
"responses": {
"200": {
"description": "communications type deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "4cf6542f-05ad-49bf-a15f-0d98729877dc",
"type": "communications_types",
"attributes": {
"name": "gofrm",
"slug": "gofrm",
"description": "Laboriosam dignissimos eligendi harum.",
"color": "#D7F5E1",
"position": 1,
"created_at": "2025-07-12T00:13:18.006-07:00",
"updated_at": "2025-07-12T00:13:21.105-07:00",
"communication_groups": [],
"communication_templates": []
}
}
}
}
}
},
"404": {
"description": "communications type not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/custom_fields/{custom_field_id}/options": {
"parameters": [
{
"name": "custom_field_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "[DEPRECATED] Creates a custom field option",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] CustomFieldOptions"
],
"description": "[DEPRECATED] Use form field endpoints instead. Creates a new custom field option from provided data",
"deprecated": true,
"operationId": "createCustomFieldOption",
"parameters": [],
"responses": {
"201": {
"description": "custom_field_option created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "3",
"type": "custom_field_options",
"attributes": {
"custom_field_id": 127,
"value": "Test option value",
"color": "#FBE4A0",
"default": false,
"position": 3,
"updated_at": "2025-07-12T00:13:22.293-07:00",
"created_at": "2025-07-12T00:13:22.293-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/custom_field_option_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Value can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_custom_field_option"
}
}
},
"required": true
}
},
"get": {
"summary": "[DEPRECATED] List custom field options",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] CustomFieldOptions"
],
"description": "[DEPRECATED] Use form field endpoints instead. List custom field options",
"deprecated": true,
"operationId": "listCustomFieldOptions",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[value]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/custom_field_option_list"
}
}
}
}
}
}
},
"/v1/custom_field_options/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "[DEPRECATED] Retrieves a custom field option",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] CustomFieldOptions"
],
"description": "[DEPRECATED] Use form field endpoints instead. Retrieves a specific custom field option by id",
"deprecated": true,
"operationId": "getCustomFieldOption",
"responses": {
"200": {
"description": "custom_field_option found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "1",
"type": "custom_field_options",
"attributes": {
"custom_field_id": 127,
"value": "Beatae aut labore enim.",
"color": "#FBE4A0",
"default": false,
"position": 1,
"updated_at": "2025-07-12T00:13:22.159-07:00",
"created_at": "2025-07-12T00:13:22.159-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/custom_field_option_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "[DEPRECATED] Update a custom field option",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] CustomFieldOptions"
],
"description": "[DEPRECATED] Use form field endpoints instead. Update a specific custom field option by id",
"deprecated": true,
"operationId": "updateCustomFieldOption",
"parameters": [],
"responses": {
"200": {
"description": "custom_field_option updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "1",
"type": "custom_field_options",
"attributes": {
"custom_field_id": 127,
"value": "Test update option value",
"color": "#FBE4A0",
"default": false,
"position": 1,
"updated_at": "2025-07-12T00:13:23.310-07:00",
"created_at": "2025-07-12T00:13:22.159-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/custom_field_option_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_custom_field_option"
}
}
},
"required": true
}
},
"delete": {
"summary": "[DEPRECATED] Delete a custom field option",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] CustomFieldOptions"
],
"description": "[DEPRECATED] Use form field endpoints instead. Delete a specific Custom Field Option by id",
"deprecated": true,
"operationId": "deleteCustomFieldOption",
"responses": {
"200": {
"description": "custom_field_option deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "1",
"type": "custom_field_options",
"attributes": {
"custom_field_id": 127,
"value": "Beatae aut labore enim.",
"color": "#FBE4A0",
"default": false,
"position": 1,
"updated_at": "2025-07-12T00:13:23.765-07:00",
"created_at": "2025-07-12T00:13:22.159-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/custom_field_option_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/custom_fields": {
"post": {
"summary": "[DEPRECATED] Creates a Custom Field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] CustomFields"
],
"description": "[DEPRECATED] Use form field endpoints instead. Creates a new custom field from provided data",
"deprecated": true,
"operationId": "createCustomField",
"parameters": [],
"responses": {
"201": {
"description": "custom_field created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "138",
"type": "custom_fields",
"attributes": {
"slug": "test-custom-field",
"description": null,
"enabled": true,
"position": 11,
"updated_at": "2025-07-12T00:13:27.519-07:00",
"created_at": "2025-07-12T00:13:27.519-07:00",
"kind": "text",
"label": "Test custom field",
"shown": [
"incident_form",
"incident_slack_form"
],
"required": []
},
"relationships": {
"options": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/custom_field_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_custom_field"
}
}
},
"required": true
}
},
"get": {
"summary": "[DEPRECATED] List Custom Fields",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] CustomFields"
],
"description": "[DEPRECATED] Use form field endpoints instead. List Custom fields",
"deprecated": true,
"operationId": "listCustomFields",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: options",
"schema": {
"type": "string",
"enum": [
"options"
]
},
"required": false
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at",
"position",
"-position"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[label]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[enabled]",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/custom_field_list"
}
}
}
}
}
}
},
"/v1/custom_fields/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "[DEPRECATED] Retrieves a Custom Field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] CustomFields"
],
"description": "Retrieves a specific custom_field by id",
"deprecated": true,
"operationId": "getCustomField",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: options",
"schema": {
"type": "string",
"enum": [
"options"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "custom_field found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "128",
"type": "custom_fields",
"attributes": {
"slug": "recusandae-temporibus-asperiores-exercitationem",
"description": "Tempora debitis similique est.",
"enabled": true,
"position": 1,
"updated_at": "2025-07-12T00:13:24.908-07:00",
"created_at": "2025-07-12T00:13:24.908-07:00",
"kind": "text",
"label": "Recusandae temporibus asperiores exercitationem.",
"shown": [
"incident_form",
"incident_slack_form"
],
"required": []
},
"relationships": {
"options": {
"data": [
{
"id": "4",
"type": "custom_field_options"
},
{
"id": "5",
"type": "custom_field_options"
}
]
}
}
}
},
"schema": {
"$ref": "#/components/schemas/custom_field_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "[DEPRECATED] Update a Custom Field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] CustomFields"
],
"description": "[DEPRECATED] Use form field endpoints instead. Update a specific custom field by id",
"deprecated": true,
"operationId": "updateCustomField",
"parameters": [],
"responses": {
"200": {
"description": "custom_field updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "128",
"type": "custom_fields",
"attributes": {
"slug": "test-update-custom-field",
"description": "Tempora debitis similique est.",
"enabled": true,
"position": 1,
"updated_at": "2025-07-12T00:13:28.699-07:00",
"created_at": "2025-07-12T00:13:24.908-07:00",
"kind": "text",
"label": "Test update custom field",
"shown": [
"incident_form"
],
"required": []
},
"relationships": {
"options": {
"data": [
{
"id": "4",
"type": "custom_field_options"
},
{
"id": "5",
"type": "custom_field_options"
}
]
}
}
}
},
"schema": {
"$ref": "#/components/schemas/custom_field_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_custom_field"
}
}
},
"required": true
}
},
"delete": {
"summary": "[DEPRECATED] Delete a Custom Field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] CustomFields"
],
"description": "[DEPRECATED] Use form field endpoints instead. Delete a specific custom field by id",
"deprecated": true,
"operationId": "deleteCustomField",
"responses": {
"200": {
"description": "custom_field deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "128",
"type": "custom_fields",
"attributes": {
"slug": "recusandae-temporibus-asperiores-exercitationem",
"description": "Tempora debitis similique est.",
"enabled": true,
"position": 1,
"updated_at": "2025-07-12T00:13:29.316-07:00",
"created_at": "2025-07-12T00:13:24.908-07:00",
"kind": "text",
"label": "Recusandae temporibus asperiores exercitationem.",
"shown": [],
"required": []
},
"relationships": {
"options": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/custom_field_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/custom_forms": {
"post": {
"summary": "Creates a custom form",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CustomForms"
],
"description": "Creates a new custom form from provided data",
"operationId": "createCustomForm",
"parameters": [],
"responses": {
"201": {
"description": "custom_form created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "70e13216-a8d9-4d7f-8e92-658dea3fd55d",
"type": "custom_forms",
"attributes": {
"slug": "test",
"name": "Test",
"description": null,
"enabled": true,
"command": "test",
"created_at": "2025-07-12T00:13:31.783-07:00",
"updated_at": "2025-07-12T00:13:31.783-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/custom_form_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
},
{
"title": "Command can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_custom_form"
}
}
},
"required": true
}
},
"get": {
"summary": "List custom forms",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CustomForms"
],
"description": "List custom forms",
"operationId": "listCustomForms",
"parameters": [
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[command]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "custom_form found",
"content": {
"application/vnd.api+json": {
"example": {
"data": [
{
"id": "8431b5b3-cb8c-4f7a-9cb2-1e60fd4ab0eb",
"type": "custom_forms",
"attributes": {
"slug": "nulla-dolorem-placeat-officia",
"name": "Nulla dolorem placeat officia.",
"description": "Quod accusamus voluptatem quam.",
"enabled": true,
"command": "nulla-dolorem-placeat-officia",
"created_at": "2025-07-12T00:13:30.135-07:00",
"updated_at": "2025-07-12T00:13:30.135-07:00"
}
},
{
"id": "560ae027-4c8e-4b18-b4fb-7877e34aa3ad",
"type": "custom_forms",
"attributes": {
"slug": "aut-laboriosam-et-quasi",
"name": "Aut laboriosam et quasi.",
"description": "Ut dolorem sunt expedita.",
"enabled": true,
"command": "aut-laboriosam-et-quasi",
"created_at": "2025-07-12T00:13:30.131-07:00",
"updated_at": "2025-07-12T00:13:30.131-07:00"
}
},
{
"id": "ab5d5e92-7909-4893-9d28-fce5100bea6d",
"type": "custom_forms",
"attributes": {
"slug": "consequatur-tenetur-iure-nihil",
"name": "Consequatur tenetur iure nihil.",
"description": "Eveniet rerum vel et.",
"enabled": true,
"command": "consequatur-tenetur-iure-nihil",
"created_at": "2025-07-12T00:13:30.127-07:00",
"updated_at": "2025-07-12T00:13:30.127-07:00"
}
},
{
"id": "2011e55d-8b0a-4c4a-9645-8d8960622ddb",
"type": "custom_forms",
"attributes": {
"slug": "aliquam-ipsa-quos-et",
"name": "Aliquam ipsa quos et.",
"description": "Sit rerum delectus in.",
"enabled": true,
"command": "aliquam-ipsa-quos-et",
"created_at": "2025-07-12T00:13:30.123-07:00",
"updated_at": "2025-07-12T00:13:30.123-07:00"
}
},
{
"id": "efbfb567-aae6-49c1-93ce-7a0efb82639a",
"type": "custom_forms",
"attributes": {
"slug": "non-distinctio-et-nisi",
"name": "Non distinctio et nisi.",
"description": "Eum eaque est assumenda.",
"enabled": true,
"command": "non-distinctio-et-nisi",
"created_at": "2025-07-12T00:13:30.118-07:00",
"updated_at": "2025-07-12T00:13:30.118-07:00"
}
},
{
"id": "ff04c16a-d173-4bd1-ba8a-90c47b76fee0",
"type": "custom_forms",
"attributes": {
"slug": "a-voluptas-sit-mollitia",
"name": "A voluptas sit mollitia.",
"description": "Non nulla libero ratione.",
"enabled": true,
"command": "a-voluptas-sit-mollitia",
"created_at": "2025-07-12T00:13:30.114-07:00",
"updated_at": "2025-07-12T00:13:30.114-07:00"
}
},
{
"id": "64507fa0-b64f-485f-9de4-d3690f30f971",
"type": "custom_forms",
"attributes": {
"slug": "sit-aut-sed-at",
"name": "Sit aut sed at.",
"description": "Et nesciunt explicabo et.",
"enabled": true,
"command": "sit-aut-sed-at",
"created_at": "2025-07-12T00:13:30.110-07:00",
"updated_at": "2025-07-12T00:13:30.110-07:00"
}
},
{
"id": "ea858632-29c5-4b93-ba2d-b93f09363536",
"type": "custom_forms",
"attributes": {
"slug": "et-sunt-nisi-ut",
"name": "Et sunt nisi ut.",
"description": "Numquam placeat non dolores.",
"enabled": true,
"command": "et-sunt-nisi-ut",
"created_at": "2025-07-12T00:13:30.105-07:00",
"updated_at": "2025-07-12T00:13:30.105-07:00"
}
},
{
"id": "2f62c3eb-2bc6-4668-84ed-6ba444c09303",
"type": "custom_forms",
"attributes": {
"slug": "dolor-quia-natus-exercitationem",
"name": "Dolor quia natus exercitationem.",
"description": "Qui libero aliquam qui.",
"enabled": true,
"command": "dolor-quia-natus-exercitationem",
"created_at": "2025-07-12T00:13:30.100-07:00",
"updated_at": "2025-07-12T00:13:30.100-07:00"
}
},
{
"id": "3f21ad6d-f43d-47a9-b6ad-2f06b1d959be",
"type": "custom_forms",
"attributes": {
"slug": "suscipit-id-laboriosam-quo",
"name": "Suscipit id laboriosam quo.",
"description": "Est eos quaerat dolorum.",
"enabled": true,
"command": "suscipit-id-laboriosam-quo",
"created_at": "2025-07-12T00:13:30.094-07:00",
"updated_at": "2025-07-12T00:13:30.094-07:00"
}
}
],
"links": {
"self": "http://www.example.com/v1/custom_forms?page%5Bnumber%5D=1&page%5Bsize%5D=50",
"first": "http://www.example.com/v1/custom_forms?page%5Bnumber%5D=1&page%5Bsize%5D=50",
"prev": null,
"next": null,
"last": "http://www.example.com/v1/custom_forms?page%5Bnumber%5D=1&page%5Bsize%5D=50"
},
"meta": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_count": 10,
"total_pages": 1
}
},
"schema": {
"$ref": "#/components/schemas/custom_form_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/custom_forms/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a custom form",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CustomForms"
],
"description": "Retrieves a specific custom form by id",
"operationId": "getCustomForm",
"responses": {
"200": {
"description": "custom_form found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "3f21ad6d-f43d-47a9-b6ad-2f06b1d959be",
"type": "custom_forms",
"attributes": {
"slug": "suscipit-id-laboriosam-quo",
"name": "Suscipit id laboriosam quo.",
"description": "Est eos quaerat dolorum.",
"enabled": true,
"command": "suscipit-id-laboriosam-quo",
"created_at": "2025-07-12T00:13:30.094-07:00",
"updated_at": "2025-07-12T00:13:30.094-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/custom_form_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a custom form",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CustomForms"
],
"description": "Update a specific custom form by id",
"operationId": "updateCustomForm",
"parameters": [],
"responses": {
"200": {
"description": "custom_form updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "3f21ad6d-f43d-47a9-b6ad-2f06b1d959be",
"type": "custom_forms",
"attributes": {
"slug": "suscipit-id-laboriosam-quo",
"name": "Test Update",
"description": "Est eos quaerat dolorum.",
"enabled": true,
"command": "suscipit-id-laboriosam-quo",
"created_at": "2025-07-12T00:13:30.094-07:00",
"updated_at": "2025-07-12T00:13:33.316-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/custom_form_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_custom_form"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a custom form",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CustomForms"
],
"description": "Delete a specific custom form by id",
"operationId": "deleteCustomForm",
"responses": {
"200": {
"description": "custom_form deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "72cc7fb5-0d1f-4e88-a7d0-c6a958cfa4a2",
"type": "custom_forms",
"attributes": {
"slug": "quae-provident-amet-hic",
"name": "Quae provident amet hic.",
"description": "Eius exercitationem ex omnis.",
"enabled": true,
"command": "quae-provident-amet-hic",
"created_at": "2025-07-12T00:13:34.078-07:00",
"updated_at": "2025-07-12T00:13:34.199-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/custom_form_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/dashboards/{dashboard_id}/panels": {
"parameters": [
{
"name": "dashboard_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a dashboard panel",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"DashboardPanels"
],
"description": "Creates a new dashboard panel from provided data",
"operationId": "createDashboardPanel",
"parameters": [],
"responses": {
"201": {
"description": "dashboard panel created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "040a0a29-bef7-4c9d-8fd1-73fd9778f7db",
"type": "dashboard_panels",
"attributes": {
"dashboard_id": "2b241921-5bc6-4e1c-945c-58c5510bcda7",
"name": "test",
"params": {
"display": "line_chart",
"datasets": [
{
"collection": "incidents",
"filter": [],
"aggregate": {
"operation": "count",
"key": "results",
"cumulative": false
}
}
]
},
"position": null,
"created_at": "2025-07-12T00:13:35.969-07:00",
"updated_at": "2025-07-12T00:13:35.969-07:00",
"data": [
{
"name": "Incidents",
"color": null,
"data": {
"2025-07-05": 0,
"2025-07-06": 0,
"2025-07-07": 0,
"2025-07-08": 0,
"2025-07-09": 0,
"2025-07-10": 0,
"2025-07-11": 0,
"2025-07-12": 0
}
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/dashboard_panel_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_dashboard_panel"
}
}
},
"required": true
}
},
"get": {
"summary": "List dashboard panels",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"DashboardPanels"
],
"description": "List dashboard panels",
"operationId": "listDashboardPanels",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/dashboard_panel_list"
}
}
}
}
}
}
},
"/v1/dashboard_panels/{id}/duplicate": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Duplicates a dashboard panel",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"DashboardPanels"
],
"description": "Duplicates a dashboard panel",
"operationId": "duplicateDashboardPanel",
"responses": {
"201": {
"description": "dashboard panel created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "698e6928-487e-4141-b1f5-913ac89bfd60",
"type": "dashboard_panels",
"attributes": {
"dashboard_id": "2b241921-5bc6-4e1c-945c-58c5510bcda7",
"name": "Copy of Test panel",
"params": {
"display": "line_chart",
"datasets": [
{
"collection": "incidents",
"filter": [],
"aggregate": {
"operation": "count",
"key": "results",
"cumulative": false
}
}
]
},
"position": null,
"created_at": "2025-07-12T00:13:36.398-07:00",
"updated_at": "2025-07-12T00:13:36.398-07:00",
"data": [
{
"name": "Incidents",
"color": null,
"data": {
"2025-07-05": 0,
"2025-07-06": 0,
"2025-07-07": 0,
"2025-07-08": 0,
"2025-07-09": 0,
"2025-07-10": 0,
"2025-07-11": 0,
"2025-07-12": 0
}
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/dashboard_panel_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/dashboard_panels/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a dashboard panel",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"DashboardPanels"
],
"description": "Retrieves a specific dashboard panel by id",
"operationId": "getDashboardPanel",
"parameters": [
{
"name": "range",
"in": "query",
"required": false,
"description": "Date range for panel data, ISO8601 timestamps separated by the word 'to'. Ex: '2022-06-19T11:28:46.029Z to 2022-07-18T21:58:46.029Z'.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "query",
"required": false,
"description": "The time period to group data by. Accepts 'day', 'week', and 'month'",
"schema": {
"type": "string"
}
},
{
"name": "time_zone",
"in": "query",
"required": false,
"description": "The time zone to use for period",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "dashboard panel found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "4fb07c73-1e45-46a0-9d7c-51033996e0ec",
"type": "dashboard_panels",
"attributes": {
"dashboard_id": "2b241921-5bc6-4e1c-945c-58c5510bcda7",
"name": "Test panel",
"params": {
"display": "line_chart",
"datasets": [
{
"collection": "incidents",
"filter": [],
"aggregate": {
"operation": "count",
"key": "results",
"cumulative": false
}
}
]
},
"position": null,
"created_at": "2025-07-12T00:13:35.817-07:00",
"updated_at": "2025-07-12T00:13:35.817-07:00",
"data": [
{
"name": "Incidents",
"color": null,
"data": {
"2025-06-12": 0,
"2025-06-13": 0,
"2025-06-14": 0,
"2025-06-15": 0,
"2025-06-16": 0,
"2025-06-17": 0,
"2025-06-18": 0,
"2025-06-19": 0,
"2025-06-20": 0,
"2025-06-21": 0,
"2025-06-22": 0,
"2025-06-23": 0,
"2025-06-24": 0,
"2025-06-25": 0,
"2025-06-26": 0,
"2025-06-27": 0,
"2025-06-28": 0,
"2025-06-29": 0,
"2025-06-30": 0,
"2025-07-01": 0,
"2025-07-02": 0,
"2025-07-03": 0,
"2025-07-04": 0,
"2025-07-05": 0,
"2025-07-06": 0,
"2025-07-07": 0,
"2025-07-08": 0,
"2025-07-09": 0,
"2025-07-10": 0,
"2025-07-11": 0,
"2025-07-12": 0
}
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/dashboard_panel_response"
}
}
}
}
}
},
"put": {
"summary": "Update a dashboard panel",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"DashboardPanels"
],
"description": "Update a specific dashboard panel by id",
"operationId": "updateDashboardPanel",
"parameters": [],
"responses": {
"200": {
"description": "dashboard panel updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "4fb07c73-1e45-46a0-9d7c-51033996e0ec",
"type": "dashboard_panels",
"attributes": {
"dashboard_id": "2b241921-5bc6-4e1c-945c-58c5510bcda7",
"name": "test update",
"params": {
"display": "line_chart",
"datasets": [
{
"collection": "incidents",
"filter": [],
"aggregate": {
"operation": "count",
"key": "results",
"cumulative": false
}
}
]
},
"position": null,
"created_at": "2025-07-12T00:13:35.817-07:00",
"updated_at": "2025-07-12T00:13:36.899-07:00",
"data": [
{
"name": "Incidents",
"color": null,
"data": {
"2025-07-05": 0,
"2025-07-06": 0,
"2025-07-07": 0,
"2025-07-08": 0,
"2025-07-09": 0,
"2025-07-10": 0,
"2025-07-11": 0,
"2025-07-12": 0
}
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/dashboard_panel_response"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_dashboard_panel"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a dashboard panel",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"DashboardPanels"
],
"description": "Delete a specific dashboard panel by id",
"operationId": "deleteDashboardPanel",
"responses": {
"200": {
"description": "dashboard panel deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "4fb07c73-1e45-46a0-9d7c-51033996e0ec",
"type": "dashboard_panels",
"attributes": {
"dashboard_id": "2b241921-5bc6-4e1c-945c-58c5510bcda7",
"name": "Test panel",
"params": {
"display": "line_chart",
"datasets": [
{
"collection": "incidents",
"filter": [],
"aggregate": {
"operation": "count",
"key": "results",
"cumulative": false
}
}
]
},
"position": null,
"created_at": "2025-07-12T00:13:35.817-07:00",
"updated_at": "2025-07-12T00:13:37.222-07:00",
"data": [
{
"name": "Incidents",
"color": null,
"data": {
"2025-07-05": 0,
"2025-07-06": 0,
"2025-07-07": 0,
"2025-07-08": 0,
"2025-07-09": 0,
"2025-07-10": 0,
"2025-07-11": 0,
"2025-07-12": 0
}
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/dashboard_panel_response"
}
}
}
}
}
}
},
"/v1/dashboards": {
"post": {
"summary": "Creates a dashboard",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Dashboards"
],
"description": "Creates a new dashboard from provided data",
"operationId": "createDashboard",
"parameters": [],
"responses": {
"201": {
"description": "dashboard created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "3ffbbfff-10f3-43f5-b180-afb8faddb6a6",
"type": "dashboards",
"attributes": {
"team_id": 104,
"user_id": 81,
"name": "Test dashboard",
"description": null,
"slug": "test-dashboard",
"public": false,
"owner": "user",
"range": "Last 30 Days",
"period": "day",
"color": "#D7F5E1",
"icon": "\ud83d\udcca",
"auto_refresh": false,
"updated_at": "2025-07-12T00:13:40.594-07:00",
"created_at": "2025-07-12T00:13:40.594-07:00"
},
"relationships": {
"panels": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/dashboard_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_dashboard"
}
}
},
"required": true
}
},
"get": {
"summary": "List dashboards",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Dashboards"
],
"description": "List dashboards",
"operationId": "listDashboards",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: panels",
"schema": {
"type": "string",
"enum": [
"panels"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/dashboard_list"
}
}
}
}
}
}
},
"/v1/dashboards/{id}/duplicate": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Duplicates a dashboard",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Dashboards"
],
"description": "Duplicates a dashboard",
"operationId": "duplicateDashboard",
"responses": {
"201": {
"description": "dashboard created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "9ca841e2-2a4a-493b-87cc-450547502653",
"type": "dashboards",
"attributes": {
"team_id": 104,
"user_id": 81,
"name": "Copy of Dashboard 10 - 2025-07-12",
"description": null,
"slug": "copy-of-dashboard-10-2025-07-12",
"public": false,
"owner": "user",
"range": "Last 30 Days",
"period": "day",
"color": "#D7F5E1",
"icon": "\ud83d\udcca",
"auto_refresh": false,
"updated_at": "2025-07-12T00:13:41.293-07:00",
"created_at": "2025-07-12T00:13:41.293-07:00"
},
"relationships": {
"panels": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/dashboard_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/dashboards/{id}/set_default": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Sets dashboard to user default",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Dashboards"
],
"description": "Sets dashboard to user default",
"operationId": "setDefaultDashboard",
"responses": {
"200": {
"description": "dashboard created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "adb52ce0-10e1-42d0-9423-3bfe5b198f0a",
"type": "dashboards",
"attributes": {
"team_id": 104,
"user_id": 81,
"name": "Dashboard 10",
"description": null,
"slug": "dashboard-10",
"public": false,
"owner": "team",
"range": "Last 30 Days",
"period": "day",
"color": "#D7F5E1",
"icon": "\ud83d\udcca",
"auto_refresh": false,
"updated_at": "2025-07-12T00:13:38.570-07:00",
"created_at": "2025-07-12T00:13:38.570-07:00"
},
"relationships": {
"panels": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/dashboard_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/dashboards/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a dashboard",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Dashboards"
],
"description": "Retrieves a specific dashboard by id",
"operationId": "getDashboard",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: panels",
"schema": {
"type": "string",
"enum": [
"panels"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "dashboard found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "adb52ce0-10e1-42d0-9423-3bfe5b198f0a",
"type": "dashboards",
"attributes": {
"team_id": 104,
"user_id": 81,
"name": "Dashboard 10",
"description": null,
"slug": "dashboard-10",
"public": false,
"owner": "team",
"range": "Last 30 Days",
"period": "day",
"color": "#D7F5E1",
"icon": "\ud83d\udcca",
"auto_refresh": false,
"updated_at": "2025-07-12T00:13:38.570-07:00",
"created_at": "2025-07-12T00:13:38.570-07:00"
},
"relationships": {
"panels": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/dashboard_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a dashboard",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Dashboards"
],
"description": "Update a specific dashboard by id",
"operationId": "updateDashboard",
"parameters": [],
"responses": {
"200": {
"description": "dashboard updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "adb52ce0-10e1-42d0-9423-3bfe5b198f0a",
"type": "dashboards",
"attributes": {
"team_id": 104,
"user_id": 81,
"name": "Test update dashboard",
"description": null,
"slug": "test-update-dashboard",
"public": false,
"owner": "team",
"range": "Last 30 Days",
"period": "day",
"color": "#D7F5E1",
"icon": "\ud83d\udcca",
"auto_refresh": false,
"updated_at": "2025-07-12T00:13:42.322-07:00",
"created_at": "2025-07-12T00:13:38.570-07:00"
},
"relationships": {
"panels": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/dashboard_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_dashboard"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a dashboard",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Dashboards"
],
"description": "Delete a specific dashboard by id",
"operationId": "deleteDashboard",
"responses": {
"200": {
"description": "dashboard deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "adb52ce0-10e1-42d0-9423-3bfe5b198f0a",
"type": "dashboards",
"attributes": {
"team_id": 104,
"user_id": 81,
"name": "Dashboard 10",
"description": null,
"slug": "dashboard-10",
"public": false,
"owner": "user",
"range": "Last 30 Days",
"period": "day",
"color": "#D7F5E1",
"icon": "\ud83d\udcca",
"auto_refresh": false,
"updated_at": "2025-07-12T00:13:42.798-07:00",
"created_at": "2025-07-12T00:13:38.570-07:00"
},
"relationships": {
"panels": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/dashboard_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/environments": {
"post": {
"summary": "Creates an environment",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Environments"
],
"description": "Creates a new environment from provided data",
"operationId": "createEnvironment",
"parameters": [],
"responses": {
"201": {
"description": "environment created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "12196bef-1885-4e1e-beea-acdee5581f8a",
"type": "environments",
"attributes": {
"slug": "us-east-1",
"name": "us-east-1",
"description": "East Coast Datacenter",
"color": "#FFF",
"position": 1,
"notify_emails": [
"hello@rootly.com",
"world@rootly.com"
],
"slack_channels": [
{
"id": "C03MKDSEJE8",
"name": "elastisearch"
}
],
"slack_aliases": [
{
"id": "S03F7QUV7F1",
"name": "leadership"
}
],
"created_at": "2025-07-12T00:13:45.983-07:00",
"updated_at": "2025-07-12T00:13:45.983-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/environment_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_environment"
}
}
},
"required": true
}
},
"get": {
"summary": "List environments",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Environments"
],
"description": "List environments",
"operationId": "listEnvironments",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/environment_list"
}
}
}
}
}
}
},
"/v1/environments/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an environment",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Environments"
],
"description": "Retrieves a specific environment by id",
"operationId": "getEnvironment",
"responses": {
"200": {
"description": "environment found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "04ea188f-bde0-460f-87f1-ea8a702c9f24",
"type": "environments",
"attributes": {
"slug": "rem-ullam-voluptas-aliquam",
"name": "Rem ullam voluptas aliquam.",
"description": "Minus sed illo rem.",
"color": "#f84949",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-07-12T00:13:43.963-07:00",
"updated_at": "2025-07-12T00:13:43.963-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/environment_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an environment",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Environments"
],
"description": "Update a specific environment by id",
"operationId": "updateEnvironment",
"parameters": [],
"responses": {
"200": {
"description": "environment updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "04ea188f-bde0-460f-87f1-ea8a702c9f24",
"type": "environments",
"attributes": {
"slug": "us-east-1",
"name": "us-east-1",
"description": "East Coast Datacenter Region 1",
"color": "#000",
"position": 2,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-07-12T00:13:43.963-07:00",
"updated_at": "2025-07-12T00:13:47.031-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/environment_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_environment"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an environment",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Environments"
],
"description": "Delete a specific environment by id",
"operationId": "deleteEnvironment",
"responses": {
"200": {
"description": "environment deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "04ea188f-bde0-460f-87f1-ea8a702c9f24",
"type": "environments",
"attributes": {
"slug": "rem-ullam-voluptas-aliquam",
"name": "Rem ullam voluptas aliquam.",
"description": "Minus sed illo rem.",
"color": "#f84949",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-07-12T00:13:43.963-07:00",
"updated_at": "2025-07-12T00:13:47.512-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/environment_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/escalation_policies": {
"post": {
"summary": "Creates an escalation policy",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationPolicies"
],
"description": "Creates a new escalation policy from provided data",
"operationId": "createEscalationPolicy",
"parameters": [],
"responses": {
"201": {
"description": "escalation policy created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "393ba704-8e1f-4b8d-ac0d-a0cf7f7f9584",
"type": "escalation_policies",
"attributes": {
"name": "Platform EP",
"description": "test",
"repeat_count": 5,
"created_by_user_id": 85,
"last_updated_by_user_id": 85,
"group_ids": [
"5a7fe93a-026f-497f-a307-3d923b250402"
],
"service_ids": [],
"business_hours": {
"time_zone": null,
"days": [
"M",
"T",
"W",
"R",
"F"
],
"start_time": "09:00 AM",
"end_time": "05:00 PM"
},
"created_at": "2025-07-12T00:13:52.939-07:00",
"updated_at": "2025-07-12T00:13:52.939-07:00"
},
"relationships": {
"escalation_levels": {
"data": []
},
"escalation_paths": {
"data": []
},
"groups": {
"data": [
{
"id": "5a7fe93a-026f-497f-a307-3d923b250402",
"type": "groups"
}
]
},
"services": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/escalation_policy_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"name": [
"can't be blank"
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_escalation_policy"
}
}
},
"required": true
}
},
"get": {
"summary": "List escalation policies",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationPolicies"
],
"description": "List escalation policies",
"operationId": "listEscalationPolicies",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: escalation_policy_levels,escalation_policy_paths",
"schema": {
"type": "string",
"enum": [
"escalation_policy_levels",
"escalation_policy_paths",
"groups",
"services"
]
},
"required": false
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/escalation_policy_list"
}
}
}
}
}
}
},
"/v1/escalation_policies/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an escalation policy",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationPolicies"
],
"description": "Retrieves a specific escalation policy by id",
"operationId": "getEscalationPolicy",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: escalation_policy_levels,escalation_policy_paths",
"schema": {
"type": "string",
"enum": [
"escalation_policy_levels",
"escalation_policy_paths",
"groups",
"services"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "escalation policy found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "8d9388d4-3c53-421a-a62e-d388a92d4a0a",
"type": "escalation_policies",
"attributes": {
"name": "Deleniti eum et ipsa.",
"description": null,
"repeat_count": 1,
"created_by_user_id": 86,
"last_updated_by_user_id": 87,
"group_ids": [
"5a7fe93a-026f-497f-a307-3d923b250402"
],
"service_ids": [],
"business_hours": {
"time_zone": null,
"days": [
"F",
"M",
"T",
"R",
"W"
],
"start_time": "09:00 AM",
"end_time": "05:00 PM"
},
"created_at": "2025-07-12T00:13:48.420-07:00",
"updated_at": "2025-07-12T00:13:48.420-07:00"
},
"relationships": {
"escalation_levels": {
"data": [
{
"id": "464f974d-623a-4f53-8791-a94935f1f89b",
"type": "escalation_levels"
}
]
},
"escalation_paths": {
"data": []
},
"groups": {
"data": [
{
"id": "5a7fe93a-026f-497f-a307-3d923b250402",
"type": "groups"
}
]
},
"services": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/escalation_policy_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an escalation policy",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationPolicies"
],
"description": "Update a specific escalation policy by id",
"operationId": "updateEscalationPolicy",
"parameters": [],
"responses": {
"200": {
"description": "escalation policy updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "8d9388d4-3c53-421a-a62e-d388a92d4a0a",
"type": "escalation_policies",
"attributes": {
"name": "Platform EP",
"description": "test",
"repeat_count": 2,
"created_by_user_id": 86,
"last_updated_by_user_id": 87,
"group_ids": [
"5a7fe93a-026f-497f-a307-3d923b250402"
],
"service_ids": [],
"business_hours": {
"time_zone": null,
"days": [
"F",
"M",
"T",
"R",
"W"
],
"start_time": "09:00 AM",
"end_time": "05:00 PM"
},
"created_at": "2025-07-12T00:13:48.420-07:00",
"updated_at": "2025-07-12T00:13:54.829-07:00"
},
"relationships": {
"escalation_levels": {
"data": [
{
"id": "464f974d-623a-4f53-8791-a94935f1f89b",
"type": "escalation_levels"
}
]
},
"escalation_paths": {
"data": []
},
"groups": {
"data": [
{
"id": "5a7fe93a-026f-497f-a307-3d923b250402",
"type": "groups"
}
]
},
"services": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/escalation_policy_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_escalation_policy"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an escalation policy",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationPolicies"
],
"description": "Delete a specific escalation policy by id",
"operationId": "deleteEscalationPolicy",
"responses": {
"200": {
"description": "escalation policy deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "8d9388d4-3c53-421a-a62e-d388a92d4a0a",
"type": "escalation_policies",
"attributes": {
"name": "Deleniti eum et ipsa.",
"description": null,
"repeat_count": 1,
"created_by_user_id": 86,
"last_updated_by_user_id": 87,
"group_ids": [],
"service_ids": [],
"business_hours": {
"time_zone": null,
"days": [
"F",
"M",
"T",
"R",
"W"
],
"start_time": "09:00 AM",
"end_time": "05:00 PM"
},
"created_at": "2025-07-12T00:13:48.420-07:00",
"updated_at": "2025-07-12T00:13:55.375-07:00"
},
"relationships": {
"escalation_levels": {
"data": [
{
"id": "464f974d-623a-4f53-8791-a94935f1f89b",
"type": "escalation_levels"
}
]
},
"escalation_paths": {
"data": []
},
"groups": {
"data": []
},
"services": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/escalation_policy_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/escalation_policies/{escalation_policy_id}/escalation_levels": {
"parameters": [
{
"name": "escalation_policy_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an escalation level for an Escalation Policy",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationLevelsPolicies"
],
"description": "Creates a new escalation level from provided data",
"operationId": "createEscalationLevel",
"parameters": [],
"responses": {
"201": {
"description": "escalation level created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "a46e2900-08a2-4dfa-a924-97aa270eb258",
"type": "escalation_levels",
"attributes": {
"escalation_policy_path_id": "03bb6325-fd42-41ca-9482-d806d7084538",
"position": 1,
"delay": 2,
"escalation_policy_id": "f28ead73-d0e5-4554-976f-fe5c3fbb713b",
"paging_strategy_configuration_strategy": null,
"paging_strategy_configuration_schedule_strategy": null,
"created_at": "2025-07-12T00:13:59.188-07:00",
"updated_at": "2025-07-12T00:13:59.188-07:00",
"notification_target_params": [
{
"id": "112",
"type": "user",
"team_members": "all"
},
{
"id": "b5be2d8a-1c0b-4e7e-ab80-4396518417d1",
"type": "schedule",
"team_members": "all"
},
{
"id": "CX21345",
"type": "slack_channel",
"team_members": "all"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/escalation_policy_level_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
},
"example": {
"notification_target": [
"You need at least 1 notification target"
]
}
}
}
},
"401": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_escalation_policy_level"
}
}
},
"required": true
}
},
"get": {
"summary": "List escalation levels for an Escalation Policy",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationLevelsPolicies"
],
"description": "List escalation levels",
"operationId": "listEscalationLevels",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/escalation_policy_level_list"
}
}
}
}
}
}
},
"/v1/escalation_paths/{escalation_policy_path_id}/escalation_levels": {
"parameters": [
{
"name": "escalation_policy_path_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an escalation level for an Escalation Path",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationLevelsPath"
],
"description": "Creates a new escalation level from provided data",
"operationId": "createEscalationLevelPaths",
"parameters": [],
"responses": {
"201": {
"description": "escalation level created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "cf277326-ac15-434c-b25c-1d46453522c7",
"type": "escalation_levels",
"attributes": {
"escalation_policy_path_id": "300f54b3-ebc6-4d05-b9cb-f1a871f6c1f0",
"position": 2,
"delay": 2,
"escalation_policy_id": "f28ead73-d0e5-4554-976f-fe5c3fbb713b",
"paging_strategy_configuration_strategy": null,
"paging_strategy_configuration_schedule_strategy": null,
"created_at": "2025-07-12T00:13:59.636-07:00",
"updated_at": "2025-07-12T00:13:59.636-07:00",
"notification_target_params": [
{
"id": "112",
"type": "user",
"team_members": "all"
},
{
"id": "b5be2d8a-1c0b-4e7e-ab80-4396518417d1",
"type": "schedule",
"team_members": "all"
},
{
"id": "CX21345",
"type": "slack_channel",
"team_members": "all"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/escalation_policy_level_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"notification_target": [
"You need at least 1 notification target"
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_escalation_policy_level"
}
}
},
"required": true
}
},
"get": {
"summary": "List escalation levels for an Escalation Path",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationLevelsPath"
],
"description": "List escalation levels",
"operationId": "listEscalationLevelsPaths",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/escalation_policy_level_list"
}
}
}
}
}
}
},
"/v1/escalation_levels/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an escalation level",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationLevels"
],
"description": "Retrieves a specific escalation level by id",
"operationId": "getEscalationLevel",
"responses": {
"200": {
"description": "escalation level found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "05d93780-46bd-450b-84df-bbda0e97bf39",
"type": "escalation_levels",
"attributes": {
"escalation_policy_path_id": null,
"position": 1,
"delay": 5,
"escalation_policy_id": "f28ead73-d0e5-4554-976f-fe5c3fbb713b",
"paging_strategy_configuration_strategy": null,
"paging_strategy_configuration_schedule_strategy": null,
"created_at": "2025-07-12T00:13:56.786-07:00",
"updated_at": "2025-07-12T00:13:56.786-07:00",
"notification_target_params": [
{
"id": "116",
"type": "user",
"team_members": "all"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/escalation_policy_level_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an escalation level",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationLevels"
],
"description": "Update a specific escalation level by id",
"operationId": "updateEscalationLevel",
"parameters": [],
"responses": {
"200": {
"description": "escalation policy updated with notification_target set with slack_channel_id instead of slack_channel uuid",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "05d93780-46bd-450b-84df-bbda0e97bf39",
"type": "escalation_levels",
"attributes": {
"escalation_policy_path_id": null,
"position": 1,
"delay": 5,
"escalation_policy_id": "f28ead73-d0e5-4554-976f-fe5c3fbb713b",
"paging_strategy_configuration_strategy": null,
"paging_strategy_configuration_schedule_strategy": null,
"created_at": "2025-07-12T00:13:56.786-07:00",
"updated_at": "2025-07-12T00:13:56.786-07:00",
"notification_target_params": [
{
"id": "CX21345",
"type": "slack_channel",
"team_members": "all"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/escalation_policy_level_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_escalation_policy_level"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an escalation level",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationLevels"
],
"description": "Delete a specific escalation level by id",
"operationId": "deleteEscalationLevel",
"responses": {
"200": {
"description": "escalation level deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "05d93780-46bd-450b-84df-bbda0e97bf39",
"type": "escalation_levels",
"attributes": {
"escalation_policy_path_id": null,
"position": 1,
"delay": 5,
"escalation_policy_id": "f28ead73-d0e5-4554-976f-fe5c3fbb713b",
"paging_strategy_configuration_strategy": null,
"paging_strategy_configuration_schedule_strategy": null,
"created_at": "2025-07-12T00:13:56.786-07:00",
"updated_at": "2025-07-12T00:14:01.702-07:00",
"notification_target_params": [
{
"id": "116",
"type": "user",
"team_members": "all"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/escalation_policy_level_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/escalation_policies/{escalation_policy_id}/escalation_paths": {
"parameters": [
{
"name": "escalation_policy_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an escalation path",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationPaths"
],
"description": "Creates a new escalation path from provided data",
"operationId": "createEscalationPath",
"parameters": [],
"responses": {
"201": {
"description": "escalation path created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "a43a4f64-fe31-44dd-a514-3fcbfad0d8a4",
"type": "escalation_paths",
"attributes": {
"name": "Test EP Path",
"default": false,
"notification_type": "quiet",
"escalation_policy_id": "4b957afd-07f9-40a9-bf4e-a2f70ec08d9a",
"match_mode": "match-all-rules",
"position": 1,
"repeat": true,
"repeat_count": 3,
"initial_delay": 0,
"time_restriction_time_zone": "America/Los_Angeles",
"time_restrictions": [
{
"start_day": "monday",
"start_time": "17:00",
"end_day": "tuesday",
"end_time": "07:00"
},
{
"start_day": "wednesday",
"start_time": "07:00",
"end_day": "wednesday",
"end_time": "17:00"
}
],
"created_at": "2025-07-12T00:14:03.667-07:00",
"updated_at": "2025-07-12T00:14:03.705-07:00",
"rules": [
{
"rule_type": "alert_urgency",
"urgency_ids": [
"d8a251e8-b915-466e-a746-9417d6784e8a"
]
},
{
"rule_type": "working_hour",
"within_working_hour": true
},
{
"rule_type": "json_path",
"json_path": "$.title",
"operator": "is",
"value": "Test"
}
]
},
"relationships": {
"escalation_levels": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/escalation_policy_path_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"base": [
"You need at least 1 escalation path condition."
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_escalation_policy_path"
}
}
},
"required": true
}
},
"get": {
"summary": "List escalation paths",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationPaths"
],
"description": "List escalation paths",
"operationId": "listEscalationPaths",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: escalation_policy_levels",
"schema": {
"type": "string",
"enum": [
"escalation_policy_levels"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/escalation_policy_path_list"
}
}
}
}
}
}
},
"/v1/escalation_paths/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an escalation path",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationPaths"
],
"description": "Retrieves a specific escalation path by id",
"operationId": "getEscalationPath",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: escalation_policy_levels",
"schema": {
"type": "string",
"enum": [
"escalation_policy_levels"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "escalation path found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "a7556254-d453-4b35-9e8e-2ecc3d994d9c",
"type": "escalation_paths",
"attributes": {
"name": "Sint odit tempora aut.",
"default": false,
"notification_type": "audible",
"escalation_policy_id": "4b957afd-07f9-40a9-bf4e-a2f70ec08d9a",
"match_mode": "match-all-rules",
"position": 1,
"repeat": false,
"repeat_count": 1,
"initial_delay": 0,
"time_restriction_time_zone": null,
"time_restrictions": [],
"created_at": "2025-07-12T00:14:03.084-07:00",
"updated_at": "2025-07-12T00:14:03.084-07:00",
"rules": [
{
"rule_type": "alert_urgency",
"urgency_ids": [
"bc4d65fb-4607-4fe8-b03f-cb2249ccca51"
]
}
]
},
"relationships": {
"escalation_levels": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/escalation_policy_path_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an escalation path",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationPaths"
],
"description": "Update a specific escalation path by id",
"operationId": "updateEscalationPath",
"parameters": [],
"responses": {
"200": {
"description": "escalation policy updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "a7556254-d453-4b35-9e8e-2ecc3d994d9c",
"type": "escalation_paths",
"attributes": {
"name": "Sint odit tempora aut.",
"default": false,
"notification_type": "quiet",
"escalation_policy_id": "4b957afd-07f9-40a9-bf4e-a2f70ec08d9a",
"match_mode": "match-all-rules",
"position": 1,
"repeat": false,
"repeat_count": 1,
"initial_delay": 0,
"time_restriction_time_zone": "America/New_York",
"time_restrictions": [
{
"start_day": "monday",
"start_time": "17:00",
"end_day": "tuesday",
"end_time": "07:00"
},
{
"start_day": "wednesday",
"start_time": "09:00",
"end_day": "wednesday",
"end_time": "20:00"
}
],
"created_at": "2025-07-12T00:14:03.084-07:00",
"updated_at": "2025-07-12T00:14:04.820-07:00",
"rules": [
{
"rule_type": "alert_urgency",
"urgency_ids": [
"d8a251e8-b915-466e-a746-9417d6784e8a"
]
}
]
},
"relationships": {
"escalation_levels": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/escalation_policy_path_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_escalation_policy_path"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an escalation path",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationPaths"
],
"description": "Delete a specific escalation path by id",
"operationId": "deleteEscalationPath",
"responses": {
"200": {
"description": "escalation path deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "a7556254-d453-4b35-9e8e-2ecc3d994d9c",
"type": "escalation_paths",
"attributes": {
"name": "Sint odit tempora aut.",
"default": false,
"notification_type": "audible",
"escalation_policy_id": "4b957afd-07f9-40a9-bf4e-a2f70ec08d9a",
"match_mode": "match-all-rules",
"position": 1,
"repeat": false,
"repeat_count": 1,
"initial_delay": 0,
"time_restriction_time_zone": null,
"time_restrictions": [],
"created_at": "2025-07-12T00:14:03.084-07:00",
"updated_at": "2025-07-12T00:14:05.792-07:00",
"rules": [
{
"rule_type": "alert_urgency",
"urgency_ids": [
"bc4d65fb-4607-4fe8-b03f-cb2249ccca51"
]
}
]
},
"relationships": {
"escalation_levels": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/escalation_policy_path_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/form_fields/{form_field_id}/options": {
"parameters": [
{
"name": "form_field_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates FormField Options",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldOptions"
],
"description": "Creates a new form_field_option from provided data",
"operationId": "createFormFieldOption",
"parameters": [],
"responses": {
"201": {
"description": "form_field_option created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "170bc2a4-5d9a-465a-a2c9-4b7bd5c436dd",
"type": "form_field_options",
"attributes": {
"form_field_id": "d654bfca-9dee-42ff-becd-cdd738f77355",
"value": "Test option value",
"color": "#FBE4A0",
"default": false,
"position": 1,
"updated_at": "2025-07-12T00:14:07.131-07:00",
"created_at": "2025-07-12T00:14:07.131-07:00"
},
"relationships": {
"form_field": {
"data": {
"id": "d654bfca-9dee-42ff-becd-cdd738f77355",
"type": "form_fields"
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/form_field_option_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Value can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_form_field_option"
}
}
},
"required": true
}
},
"get": {
"summary": "List FormField Options",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldOptions"
],
"description": "List form_field_options",
"operationId": "listFormFieldOptions",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[value]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_option_list"
}
}
}
}
}
}
},
"/v1/form_field_options/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves FormField Options",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldOptions"
],
"description": "Retrieves a specific form_field_option by id",
"operationId": "getFormFieldOption",
"responses": {
"200": {
"description": "form_field_option found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "1cb19089-feb2-4233-8807-0ecde15e52be",
"type": "form_field_options",
"attributes": {
"form_field_id": "d654bfca-9dee-42ff-becd-cdd738f77355",
"value": "Culpa id deleniti iure.",
"color": "#FBE4A0",
"default": false,
"position": 1,
"updated_at": "2025-07-12T00:14:06.999-07:00",
"created_at": "2025-07-12T00:14:06.999-07:00"
},
"relationships": {
"form_field": {
"data": {
"id": "d654bfca-9dee-42ff-becd-cdd738f77355",
"type": "form_fields"
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/form_field_option_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update FormField Options",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldOptions"
],
"description": "Update a specific form_field_option by id",
"operationId": "updateFormFieldOption",
"parameters": [],
"responses": {
"200": {
"description": "form_field_option updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "1cb19089-feb2-4233-8807-0ecde15e52be",
"type": "form_field_options",
"attributes": {
"form_field_id": "d654bfca-9dee-42ff-becd-cdd738f77355",
"value": "Test update option value",
"color": "#FBE4A0",
"default": false,
"position": 1,
"updated_at": "2025-07-12T00:14:08.211-07:00",
"created_at": "2025-07-12T00:14:06.999-07:00"
},
"relationships": {
"form_field": {
"data": {
"id": "d654bfca-9dee-42ff-becd-cdd738f77355",
"type": "form_fields"
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/form_field_option_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_form_field_option"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete FormField Options",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldOptions"
],
"description": "Delete a specific form_field_option by id",
"operationId": "deleteFormFieldOption",
"responses": {
"200": {
"description": "form_field_option deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "1cb19089-feb2-4233-8807-0ecde15e52be",
"type": "form_field_options",
"attributes": {
"form_field_id": "d654bfca-9dee-42ff-becd-cdd738f77355",
"value": "Culpa id deleniti iure.",
"color": "#FBE4A0",
"default": false,
"position": 1,
"updated_at": "2025-07-12T00:14:08.654-07:00",
"created_at": "2025-07-12T00:14:06.999-07:00"
},
"relationships": {
"form_field": {
"data": {
"id": "d654bfca-9dee-42ff-becd-cdd738f77355",
"type": "form_fields"
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/form_field_option_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/form_field_placements/{form_field_placement_id}/conditions": {
"parameters": [
{
"name": "form_field_placement_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a Form Set Condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacementConditions"
],
"description": "Creates a new form_field_placement_condition from provided data",
"operationId": "createFormFieldPlacementCondition",
"parameters": [],
"responses": {
"201": {
"description": "form_field_placement_condition created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "a8de570c-a263-437e-ab91-718389f05554",
"type": "form_field_placement_conditions",
"attributes": {
"form_field_placement_id": "fdfd852e-2715-4a9b-b6cc-ac2ecd5cd9d4",
"conditioned": "placement",
"position": 2,
"form_field_id": "90a9da88-adec-46a6-906e-eeedc57fdfd8",
"comparison": "equal",
"values": [
"test"
]
}
}
},
"schema": {
"$ref": "#/components/schemas/form_field_placement_condition_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_form_field_placement_condition"
}
}
},
"required": true
}
},
"get": {
"summary": "List Form Set Conditions",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacementConditions"
],
"description": "List form_field_placement_conditions",
"operationId": "listFormFieldPlacementConditions",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[form_field_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_placement_condition_list"
}
}
}
}
}
}
},
"/v1/form_field_placement_conditions/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a Form Set Condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacementConditions"
],
"description": "Retrieves a specific form_field_placement_condition by id",
"operationId": "getFormFieldPlacementCondition",
"responses": {
"200": {
"description": "form_field_placement_condition found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "9a1e650e-267c-485f-83e9-eb9e22751ae3",
"type": "form_field_placement_conditions",
"attributes": {
"form_field_placement_id": "fdfd852e-2715-4a9b-b6cc-ac2ecd5cd9d4",
"conditioned": "placement",
"position": 1,
"form_field_id": "07403e8e-a032-4db6-a6c5-e81412c4c185",
"comparison": "equal",
"values": [
"test"
]
}
}
},
"schema": {
"$ref": "#/components/schemas/form_field_placement_condition_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a Form Set Condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacementConditions"
],
"description": "Update a specific form_field_placement_condition by id",
"operationId": "updateFormFieldPlacementCondition",
"parameters": [],
"responses": {
"200": {
"description": "form_field_placement_condition updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "9a1e650e-267c-485f-83e9-eb9e22751ae3",
"type": "form_field_placement_conditions",
"attributes": {
"form_field_placement_id": "fdfd852e-2715-4a9b-b6cc-ac2ecd5cd9d4",
"conditioned": "placement",
"position": 1,
"form_field_id": "07403e8e-a032-4db6-a6c5-e81412c4c185",
"comparison": "equal",
"values": [
"bar"
]
}
}
},
"schema": {
"$ref": "#/components/schemas/form_field_placement_condition_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_form_field_placement_condition"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a Form Set Condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacementConditions"
],
"description": "Delete a specific form_field_placement_condition by id",
"operationId": "deleteFormFieldPlacementCondition",
"responses": {
"200": {
"description": "form_field_placement_condition deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "9a1e650e-267c-485f-83e9-eb9e22751ae3",
"type": "form_field_placement_conditions",
"attributes": {
"form_field_placement_id": "fdfd852e-2715-4a9b-b6cc-ac2ecd5cd9d4",
"conditioned": "placement",
"position": 1,
"form_field_id": "07403e8e-a032-4db6-a6c5-e81412c4c185",
"comparison": "equal",
"values": [
"test"
]
}
}
},
"schema": {
"$ref": "#/components/schemas/form_field_placement_condition_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/form_fields/{form_field_id}/placements": {
"parameters": [
{
"name": "form_field_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a Form Field Placement",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacements"
],
"description": "Creates a new form_field_placement from provided data",
"operationId": "createFormFieldPlacement",
"parameters": [],
"responses": {
"201": {
"description": "form_field_placement created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "683bc130-d2c1-4d33-95c3-5637b62e5458",
"type": "form_field_placements",
"attributes": {
"form_field_id": "8e955b77-c234-477f-8a32-c9d6953f5b39",
"form_set_id": "a74e4a4d-62b8-46e0-b704-66142ef35e5d",
"form": "web_update_incident_form",
"position": 1,
"required": false,
"placement_operator": "and",
"required_operator": "and"
}
}
},
"schema": {
"$ref": "#/components/schemas/form_field_placement_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Form \"blah\"is not a valid form",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_form_field_placement"
}
}
},
"required": true
}
},
"get": {
"summary": "List Form Field Placements",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacements"
],
"description": "List form_field_placements",
"operationId": "listFormFieldPlacements",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[form_field_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_placement_list"
}
}
}
}
}
}
},
"/v1/form_field_placements/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a Form Field Placement",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacements"
],
"description": "Retrieves a specific form_field_placement by id",
"operationId": "getFormFieldPlacement",
"responses": {
"200": {
"description": "form_field_placement found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "87d00da5-c76a-4726-bd43-56c7ecc182d6",
"type": "form_field_placements",
"attributes": {
"form_field_id": "8e955b77-c234-477f-8a32-c9d6953f5b39",
"form_set_id": "a74e4a4d-62b8-46e0-b704-66142ef35e5d",
"form": "web_new_incident_form",
"position": 1,
"required": false,
"placement_operator": "and",
"required_operator": "and"
}
}
},
"schema": {
"$ref": "#/components/schemas/form_field_placement_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a Form Field Placement",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacements"
],
"description": "Update a specific form_field_placement by id",
"operationId": "updateFormFieldPlacement",
"parameters": [],
"responses": {
"200": {
"description": "form_field_placement updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "87d00da5-c76a-4726-bd43-56c7ecc182d6",
"type": "form_field_placements",
"attributes": {
"form_field_id": "8e955b77-c234-477f-8a32-c9d6953f5b39",
"form_set_id": "a74e4a4d-62b8-46e0-b704-66142ef35e5d",
"form": "web_new_incident_form",
"position": 5,
"required": false,
"placement_operator": "and",
"required_operator": "and"
}
}
},
"schema": {
"$ref": "#/components/schemas/form_field_placement_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_form_field_placement"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a Form Field Placement",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacements"
],
"description": "Delete a specific form_field_placement by id",
"operationId": "deleteFormFieldPlacement",
"responses": {
"200": {
"description": "form_field_placement deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "87d00da5-c76a-4726-bd43-56c7ecc182d6",
"type": "form_field_placements",
"attributes": {
"form_field_id": "8e955b77-c234-477f-8a32-c9d6953f5b39",
"form_set_id": "a74e4a4d-62b8-46e0-b704-66142ef35e5d",
"form": "web_new_incident_form",
"position": 1,
"required": false,
"placement_operator": "and",
"required_operator": "and"
}
}
},
"schema": {
"$ref": "#/components/schemas/form_field_placement_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/form_fields/{form_field_id}/positions": {
"parameters": [
{
"name": "form_field_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "List FormField Position",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPositions"
],
"description": "List form field positions",
"operationId": "listFormFieldPositions",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[form]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_position_list"
}
}
}
}
}
},
"post": {
"summary": "Creates FormField Positions",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPositions"
],
"description": "Creates a new form field_position from provided data",
"operationId": "createFormFieldPosition",
"parameters": [],
"responses": {
"201": {
"description": "form_field_position created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "975267b4-0523-4f31-baab-26aa2812d9e6",
"type": "form_field_positions",
"attributes": {
"form_field_id": "01116b20-cac6-4e5e-88d1-a67aaa306e24",
"form": "web_new_incident_form",
"position": 2
}
}
},
"schema": {
"$ref": "#/components/schemas/form_field_position_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_form_field_position"
}
}
},
"required": true
}
}
},
"/v1/form_field_positions/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a FormFieldPosition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPositions"
],
"description": "Retrieves a specific form field_position by id",
"operationId": "getFormFieldPosition",
"responses": {
"200": {
"description": "form_field_position found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "4506afb8-31c8-4a3a-a0eb-7f16cd4d4094",
"type": "form_field_positions",
"attributes": {
"form_field_id": "01116b20-cac6-4e5e-88d1-a67aaa306e24",
"form": "web_update_incident_form",
"position": 1
}
}
},
"schema": {
"$ref": "#/components/schemas/form_field_position_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a FormFieldPosition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPositions"
],
"description": "Update a specific form_field position by id",
"operationId": "updateFormFieldPosition",
"parameters": [],
"responses": {
"200": {
"description": "form_field_position updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "4506afb8-31c8-4a3a-a0eb-7f16cd4d4094",
"type": "form_field_positions",
"attributes": {
"form_field_id": "01116b20-cac6-4e5e-88d1-a67aaa306e24",
"form": "web_update_incident_form",
"position": 2
}
}
},
"schema": {
"$ref": "#/components/schemas/form_field_position_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_form_field_position"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a FormFieldPosition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPositions"
],
"description": "Delete a specific form_field position by id",
"operationId": "deleteFormFieldPosition",
"responses": {
"200": {
"description": "form_field_position deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "4506afb8-31c8-4a3a-a0eb-7f16cd4d4094",
"type": "form_field_positions",
"attributes": {
"form_field_id": "01116b20-cac6-4e5e-88d1-a67aaa306e24",
"form": "web_update_incident_form",
"position": 1
}
}
},
"schema": {
"$ref": "#/components/schemas/form_field_position_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/form_fields": {
"post": {
"summary": "Creates a Form Field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFields"
],
"description": "Creates a new form_field from provided data",
"operationId": "createFormField",
"parameters": [],
"responses": {
"201": {
"description": "form_field created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "3f64b460-790b-41e8-bc79-42617fbe6f40",
"type": "form_fields",
"attributes": {
"team_id": 124,
"slug": "test-custom-field",
"kind": "custom",
"input_kind": "text",
"value_kind": "inherit",
"value_kind_catalog_id": null,
"name": "Test custom field",
"description": null,
"shown": [
"web_new_incident_form",
"slack_new_incident_form"
],
"required": [],
"default_values": [],
"show_on_incident_details": true,
"enabled": true,
"updated_at": "2025-07-12T00:14:21.092-07:00",
"created_at": "2025-07-12T00:14:21.092-07:00"
},
"relationships": {
"options": {
"data": []
},
"positions": {
"data": [
{
"id": "6edbda90-32b7-46eb-80ba-c3e5ab52ccdf",
"type": "form_field_positions"
},
{
"id": "ecb6f7dd-9308-4dbb-9024-d89a9bf1434b",
"type": "form_field_positions"
}
]
}
}
}
},
"schema": {
"$ref": "#/components/schemas/form_field_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_form_field"
}
}
},
"required": true
}
},
"get": {
"summary": "List Form Fields",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFields"
],
"description": "List form_fields",
"operationId": "listFormFields",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: options,positions",
"schema": {
"type": "string",
"enum": [
"options",
"positions"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[enabled]",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_list"
}
}
}
}
}
}
},
"/v1/form_fields/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a Form Field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFields"
],
"description": "Retrieves a specific form_field by id",
"operationId": "getFormField",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: options,positions",
"schema": {
"type": "string",
"enum": [
"options",
"positions"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "form_field found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "f6e0576d-36a5-4857-8e6f-677aaa56b572",
"type": "form_fields",
"attributes": {
"team_id": 124,
"slug": "dolorem-quod-sequi-nobis",
"kind": "custom",
"input_kind": "text",
"value_kind": "inherit",
"value_kind_catalog_id": null,
"name": "Dolorem quod sequi nobis.",
"description": "Et consequatur eius perferendis.",
"shown": [
"web_new_incident_form",
"web_update_incident_form",
"slack_new_incident_form",
"slack_update_incident_form"
],
"required": [],
"default_values": [],
"show_on_incident_details": true,
"enabled": true,
"updated_at": "2025-07-12T00:14:18.348-07:00",
"created_at": "2025-07-12T00:14:18.348-07:00"
},
"relationships": {
"options": {
"data": [
{
"id": "1d30383b-9192-4be1-a602-4482c8f005d0",
"type": "form_field_options"
},
{
"id": "c23bd9d1-0fa5-4b6a-bf94-f21d9607ce64",
"type": "form_field_options"
}
]
},
"positions": {
"data": [
{
"id": "7bba9732-3e6c-40e5-8741-d92e08221704",
"type": "form_field_positions"
},
{
"id": "3eb97b62-60d7-4b89-85b9-a03be6238c22",
"type": "form_field_positions"
},
{
"id": "9d803c0d-be07-43cb-a83f-8a257fb8b18e",
"type": "form_field_positions"
},
{
"id": "769be376-577b-4553-9dbf-b0eac8342f0c",
"type": "form_field_positions"
}
]
}
}
}
},
"schema": {
"$ref": "#/components/schemas/form_field_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a Form Field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFields"
],
"description": "Update a specific form_field by id",
"operationId": "updateFormField",
"parameters": [],
"responses": {
"200": {
"description": "form_field updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "f6e0576d-36a5-4857-8e6f-677aaa56b572",
"type": "form_fields",
"attributes": {
"team_id": 124,
"slug": "test-update-custom-field",
"kind": "custom",
"input_kind": "text",
"value_kind": "inherit",
"value_kind_catalog_id": null,
"name": "Test update custom field",
"description": "Et consequatur eius perferendis.",
"shown": [
"web_new_incident_form",
"web_update_incident_form",
"slack_new_incident_form",
"slack_update_incident_form"
],
"required": [],
"default_values": [],
"show_on_incident_details": false,
"enabled": true,
"updated_at": "2025-07-12T00:14:22.268-07:00",
"created_at": "2025-07-12T00:14:18.348-07:00"
},
"relationships": {
"options": {
"data": [
{
"id": "1d30383b-9192-4be1-a602-4482c8f005d0",
"type": "form_field_options"
},
{
"id": "c23bd9d1-0fa5-4b6a-bf94-f21d9607ce64",
"type": "form_field_options"
}
]
},
"positions": {
"data": [
{
"id": "7bba9732-3e6c-40e5-8741-d92e08221704",
"type": "form_field_positions"
},
{
"id": "3eb97b62-60d7-4b89-85b9-a03be6238c22",
"type": "form_field_positions"
},
{
"id": "9d803c0d-be07-43cb-a83f-8a257fb8b18e",
"type": "form_field_positions"
},
{
"id": "769be376-577b-4553-9dbf-b0eac8342f0c",
"type": "form_field_positions"
}
]
}
}
}
},
"schema": {
"$ref": "#/components/schemas/form_field_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_form_field"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a Form Field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFields"
],
"description": "Delete a specific form_field by id",
"operationId": "deleteFormField",
"responses": {
"200": {
"description": "form_field deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "f6e0576d-36a5-4857-8e6f-677aaa56b572",
"type": "form_fields",
"attributes": {
"team_id": 124,
"slug": "dolorem-quod-sequi-nobis",
"kind": "custom",
"input_kind": "text",
"value_kind": "inherit",
"value_kind_catalog_id": null,
"name": "Dolorem quod sequi nobis.",
"description": "Et consequatur eius perferendis.",
"shown": [],
"required": [],
"default_values": [],
"show_on_incident_details": true,
"enabled": true,
"updated_at": "2025-07-12T00:14:22.795-07:00",
"created_at": "2025-07-12T00:14:18.348-07:00"
},
"relationships": {
"options": {
"data": []
},
"positions": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/form_field_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/form_sets/{form_set_id}/conditions": {
"parameters": [
{
"name": "form_set_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a Form Set Condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormSetConditions"
],
"description": "Creates a new form_set_condition from provided data",
"operationId": "createFormSetCondition",
"parameters": [],
"responses": {
"201": {
"description": "form_set_condition created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "75db1ae5-750f-4ef7-bf76-2f5aef757643",
"type": "form_set_conditions",
"attributes": {
"form_set_id": "86cda60c-6e2f-40b3-81cf-9ad054491fb6",
"form_field_id": "f8c25d2e-eeaa-40cf-a056-f2e0df139265",
"comparison": "equal",
"values": [
"test"
]
}
}
},
"schema": {
"$ref": "#/components/schemas/form_set_condition_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Values can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_form_set_condition"
}
}
},
"required": true
}
},
"get": {
"summary": "List Form Set Conditions",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormSetConditions"
],
"description": "List form_set_conditions",
"operationId": "listFormSetConditions",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[form_field_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_set_condition_list"
}
}
}
}
}
}
},
"/v1/form_set_conditions/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a Form Set Condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormSetConditions"
],
"description": "Retrieves a specific form_set_condition by id",
"operationId": "getFormSetCondition",
"responses": {
"200": {
"description": "form_set_condition found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "06bd70c8-a81b-4513-9d55-d903143a1985",
"type": "form_set_conditions",
"attributes": {
"form_set_id": "c57993e2-bbc6-4892-a0ea-426437656653",
"form_field_id": "b00fc625-dea7-4d7a-8322-8c5f5fb9273c",
"comparison": "equal",
"values": [
"test"
]
}
}
},
"schema": {
"$ref": "#/components/schemas/form_set_condition_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a Form Set Condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormSetConditions"
],
"description": "Update a specific form_set_condition by id",
"operationId": "updateFormSetCondition",
"parameters": [],
"responses": {
"200": {
"description": "form_set_condition updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "06bd70c8-a81b-4513-9d55-d903143a1985",
"type": "form_set_conditions",
"attributes": {
"form_set_id": "c57993e2-bbc6-4892-a0ea-426437656653",
"form_field_id": "b00fc625-dea7-4d7a-8322-8c5f5fb9273c",
"comparison": "equal",
"values": [
"test update"
]
}
}
},
"schema": {
"$ref": "#/components/schemas/form_set_condition_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_form_set_condition"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a Form Set Condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormSetConditions"
],
"description": "Delete a specific form_set_condition by id",
"operationId": "deleteFormSetCondition",
"responses": {
"200": {
"description": "form_set_condition deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "06bd70c8-a81b-4513-9d55-d903143a1985",
"type": "form_set_conditions",
"attributes": {
"form_set_id": "c57993e2-bbc6-4892-a0ea-426437656653",
"form_field_id": "b00fc625-dea7-4d7a-8322-8c5f5fb9273c",
"comparison": "equal",
"values": [
"test"
]
}
}
},
"schema": {
"$ref": "#/components/schemas/form_set_condition_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/form_sets": {
"post": {
"summary": "Creates a Form Set",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormSets"
],
"description": "Creates a new form_set from provided data",
"operationId": "createFormSet",
"parameters": [],
"responses": {
"201": {
"description": "form_set created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "f68cbf61-028e-483e-acad-1bc2903351dd",
"type": "form_sets",
"attributes": {
"name": "Test custom form set",
"slug": "test-custom-form-set",
"is_default": false,
"forms": [
"web_new_incident_form"
],
"updated_at": "2025-07-12T00:14:28.537-07:00",
"created_at": "2025-07-12T00:14:28.537-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/form_set_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Forms are required (at least one)",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_form_set"
}
}
},
"required": true
}
},
"get": {
"summary": "List Form Sets",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormSets"
],
"description": "List form_sets",
"operationId": "listFormSets",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[is_default]",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_set_list"
}
}
}
}
}
}
},
"/v1/form_sets/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a Form Set",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormSets"
],
"description": "Retrieves a specific form_set by id",
"operationId": "getFormSet",
"responses": {
"200": {
"description": "form_set found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "2e22bc9b-9adb-4457-8c75-08adfbcd068c",
"type": "form_sets",
"attributes": {
"name": "Test",
"slug": "test",
"is_default": false,
"forms": [
"web_new_incident_form"
],
"updated_at": "2025-07-12T00:14:26.872-07:00",
"created_at": "2025-07-12T00:14:26.872-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/form_set_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a Form Set",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormSets"
],
"description": "Update a specific form_set by id",
"operationId": "updateFormSet",
"parameters": [],
"responses": {
"200": {
"description": "form_set updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "2e22bc9b-9adb-4457-8c75-08adfbcd068c",
"type": "form_sets",
"attributes": {
"name": "Test update custom form set",
"slug": "test",
"is_default": false,
"forms": [
"web_new_incident_form"
],
"updated_at": "2025-07-12T00:14:29.569-07:00",
"created_at": "2025-07-12T00:14:26.872-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/form_set_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_form_set"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a Form Set",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormSets"
],
"description": "Delete a specific form_set by id",
"operationId": "deleteFormSet",
"responses": {
"200": {
"description": "form_set deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "2e22bc9b-9adb-4457-8c75-08adfbcd068c",
"type": "form_sets",
"attributes": {
"name": "Test",
"slug": "test",
"is_default": false,
"forms": [
"web_new_incident_form"
],
"updated_at": "2025-07-12T00:14:30.046-07:00",
"created_at": "2025-07-12T00:14:26.872-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/form_set_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/functionalities": {
"post": {
"summary": "Creates a functionality",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Functionalities"
],
"description": "Creates a new functionality from provided data",
"operationId": "createFunctionality",
"parameters": [],
"responses": {
"201": {
"description": "functionality created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "c159c23a-132c-4cdc-a51b-311424bf4e11",
"type": "functionalities",
"attributes": {
"name": "Add items to cart",
"slug": "add-items-to-cart",
"description": "Users should be able to add items to cart",
"public_description": "Public description",
"notify_emails": [
"john@rootly.com",
"doe@rootly.com"
],
"color": "#FFF",
"status": "operational",
"position": 1,
"show_uptime": true,
"show_uptime_last_days": 60,
"slack_channels": [
{
"id": "C03MKDSEJE8",
"name": "elastisearch"
}
],
"slack_aliases": [
{
"id": "S03F7QUV7F1",
"name": "engineering"
}
],
"backstage_id": null,
"external_id": "d795fe69-acc2-4b30-92c9-3c25cbb92056",
"opsgenie_id": "8743a1b2-11da-480e-8493-744660987bef",
"pagerduty_id": "PQ9K7I8",
"cortex_id": null,
"opslevel_id": null,
"service_now_ci_sys_id": null,
"environment_ids": [
"3bbfe1b8-a763-4ea3-b284-f684467613ff"
],
"service_ids": [
"d3914826-3021-4310-9a09-8cc12b3dc8a8"
],
"owner_group_ids": [
"08e9ee05-08ff-433b-8d16-c2122583e245"
],
"owners_group_ids": [
"08e9ee05-08ff-433b-8d16-c2122583e245"
],
"owner_user_ids": [
138
],
"owners_user_ids": [
138
],
"incidents_count": 0,
"created_at": "2025-07-12T00:14:34.809-07:00",
"updated_at": "2025-07-12T00:14:34.809-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/functionality_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_functionality"
}
}
},
"required": true
}
},
"get": {
"summary": "List functionalities",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Functionalities"
],
"description": "List functionalities",
"operationId": "listFunctionalities",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[backstage_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[cortex_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[opslevel_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[external_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/functionality_list"
}
}
}
}
}
}
},
"/v1/functionalities/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a functionality",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Functionalities"
],
"description": "Retrieves a specific functionality by id",
"operationId": "getFunctionality",
"responses": {
"200": {
"description": "functionality found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "88e357d4-2c73-483f-8da5-14d2908f5884",
"type": "functionalities",
"attributes": {
"name": "Non corporis molestias sit.",
"slug": "non-corporis-molestias-sit",
"description": "Ut accusamus dolore aperiam.",
"public_description": null,
"notify_emails": [],
"color": "#D7E7F5",
"status": "partial_outage",
"position": 1,
"show_uptime": true,
"show_uptime_last_days": 60,
"slack_channels": [],
"slack_aliases": [],
"backstage_id": null,
"external_id": null,
"opsgenie_id": null,
"pagerduty_id": null,
"cortex_id": null,
"opslevel_id": null,
"service_now_ci_sys_id": null,
"environment_ids": [],
"service_ids": [],
"owner_group_ids": [],
"owners_group_ids": [],
"owner_user_ids": [],
"owners_user_ids": [],
"incidents_count": 1,
"created_at": "2025-07-12T00:14:31.206-07:00",
"updated_at": "2025-07-12T00:14:31.425-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/functionality_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a functionality",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Functionalities"
],
"description": "Update a specific functionality by id",
"operationId": "updateFunctionality",
"parameters": [],
"responses": {
"200": {
"description": "functionality updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "88e357d4-2c73-483f-8da5-14d2908f5884",
"type": "functionalities",
"attributes": {
"name": "Checkout",
"slug": "non-corporis-molestias-sit",
"description": "Users should be able to checkout",
"public_description": "Public description updated",
"notify_emails": [
"hello@rootly.com",
"world@rootly.com"
],
"color": "#000",
"status": "partial_outage",
"position": 2,
"show_uptime": true,
"show_uptime_last_days": 60,
"slack_channels": [
{
"id": "C03MKDSEJE8",
"name": "elastisearch"
}
],
"slack_aliases": [
{
"id": "S03F7QUV7F1",
"name": "leadership"
}
],
"backstage_id": null,
"external_id": "33bfcc62-cc35-46e6-a270-8c52a56fb358",
"opsgenie_id": "8743a1b2-11da-480e-8493-744660987bec",
"pagerduty_id": "PQ9K7I9",
"cortex_id": null,
"opslevel_id": null,
"service_now_ci_sys_id": null,
"environment_ids": [
"3bbfe1b8-a763-4ea3-b284-f684467613ff"
],
"service_ids": [],
"owner_group_ids": [],
"owners_group_ids": [],
"owner_user_ids": [],
"owners_user_ids": [],
"incidents_count": 1,
"created_at": "2025-07-12T00:14:31.206-07:00",
"updated_at": "2025-07-12T00:14:36.616-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/functionality_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_functionality"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a functionality",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Functionalities"
],
"description": "Delete a specific functionality by id",
"operationId": "deleteFunctionality",
"responses": {
"200": {
"description": "functionality deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "88e357d4-2c73-483f-8da5-14d2908f5884",
"type": "functionalities",
"attributes": {
"name": "Non corporis molestias sit.",
"slug": "non-corporis-molestias-sit",
"description": "Ut accusamus dolore aperiam.",
"public_description": null,
"notify_emails": [],
"color": "#D7E7F5",
"status": "partial_outage",
"position": 1,
"show_uptime": true,
"show_uptime_last_days": 60,
"slack_channels": [],
"slack_aliases": [],
"backstage_id": null,
"external_id": null,
"opsgenie_id": null,
"pagerduty_id": null,
"cortex_id": null,
"opslevel_id": null,
"service_now_ci_sys_id": null,
"environment_ids": [],
"service_ids": [],
"owner_group_ids": [],
"owners_group_ids": [],
"owner_user_ids": [],
"owners_user_ids": [],
"incidents_count": 1,
"created_at": "2025-07-12T00:14:31.206-07:00",
"updated_at": "2025-07-12T00:14:37.401-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/functionality_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/functionalities/{id}/incidents_chart": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Get functionality incidents chart",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Functionalities"
],
"description": "Get functionality incidents chart",
"operationId": "getFunctionalityIncidentsChart",
"parameters": [
{
"name": "period",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"2025-05-13 00:00:00 UTC": 0,
"2025-05-20 00:00:00 UTC": 0,
"2025-05-27 00:00:00 UTC": 0,
"2025-06-03 00:00:00 UTC": 0,
"2025-06-10 00:00:00 UTC": 0,
"2025-06-17 00:00:00 UTC": 0,
"2025-06-24 00:00:00 UTC": 0,
"2025-07-01 00:00:00 UTC": 0,
"2025-07-08 00:00:00 UTC": 1
}
},
"schema": {
"$ref": "#/components/schemas/incidents_chart_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/functionalities/{id}/uptime_chart": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Get functionality uptime chart",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Functionalities"
],
"description": "Get functionality uptime chart",
"operationId": "getFunctionalityUptimeChart",
"parameters": [
{
"name": "period",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"2025-06-27": 100.0,
"2025-06-28": 100.0,
"2025-06-29": 100.0,
"2025-06-30": 100.0,
"2025-07-01": 100.0,
"2025-07-02": 100.0,
"2025-07-03": 100.0,
"2025-07-04": 100.0,
"2025-07-05": 100.0,
"2025-07-06": 100.0,
"2025-07-07": 100.0,
"2025-07-08": 100.0,
"2025-07-09": 50.0,
"2025-07-10": 0.0,
"2025-07-11": 100.0,
"2025-07-12": 100.0
}
},
"schema": {
"$ref": "#/components/schemas/uptime_chart_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/workflows/{workflow_id}/workflow_tasks": {
"parameters": [
{
"name": "workflow_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a workflow task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowTasks"
],
"description": "Creates a new workflow task from provided data",
"operationId": "createWorkflowTask",
"parameters": [],
"responses": {
"201": {
"description": "workflow task created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "d8ce8dcd-d430-401b-9342-2b68b75ea599",
"type": "workflow_tasks",
"attributes": {
"workflow_id": "8fea63ed-5374-4087-8000-5e19bd30c2d3",
"task_params": {
"task_type": "send_email",
"from": "Rootly <workflows@rootly.com>",
"to": [
"test@example.com"
],
"cc": [],
"bcc": [],
"subject": "Hello from Rootly",
"preheader": null,
"body": "Hello from Rootly",
"include_header": true,
"include_footer": true,
"custom_logo_url": null
},
"name": "My Custom Name",
"position": 2,
"skip_on_failure": false,
"enabled": true,
"created_at": "2025-07-12T00:14:40.669-07:00",
"updated_at": "2025-07-12T00:14:40.669-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/workflow_task_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_workflow_task"
}
}
},
"required": true
}
},
"get": {
"summary": "List workflow tasks",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowTasks"
],
"description": "List workflow tasks",
"operationId": "listWorkflowTasks",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_task_list"
}
}
}
}
}
}
},
"/v1/workflow_tasks/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a workflow task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowTasks"
],
"description": "Retrieves a specific workflow_task by id",
"operationId": "getWorkflowTask",
"responses": {
"200": {
"description": "workflow_task found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "74b1c4a3-2e65-4d97-bbb1-8e11b79a26fc",
"type": "workflow_tasks",
"attributes": {
"workflow_id": "8fea63ed-5374-4087-8000-5e19bd30c2d3",
"task_params": {
"task_type": "send_email",
"from": "Rootly <workflows@rootly.com>",
"to": [
"magni"
],
"cc": [],
"bcc": [],
"subject": "Ut labore mollitia omnis.",
"preheader": null,
"body": "Ullam eius facilis odio.",
"include_header": true,
"include_footer": true,
"custom_logo_url": null
},
"name": "Send an email",
"position": 1,
"skip_on_failure": false,
"enabled": true,
"created_at": "2025-07-12T00:14:40.414-07:00",
"updated_at": "2025-07-12T00:14:40.414-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/workflow_task_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a workflow task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowTasks"
],
"description": "Update a specific workflow task by id",
"operationId": "updateWorkflowTask",
"parameters": [],
"responses": {
"200": {
"description": "workflow_task updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "74b1c4a3-2e65-4d97-bbb1-8e11b79a26fc",
"type": "workflow_tasks",
"attributes": {
"workflow_id": "8fea63ed-5374-4087-8000-5e19bd30c2d3",
"task_params": {
"task_type": "send_email",
"from": "Rootly <workflows@rootly.com>",
"to": [
"magni"
],
"cc": [],
"bcc": [],
"subject": "Ut labore mollitia omnis.",
"preheader": null,
"body": "updated",
"include_header": true,
"include_footer": true,
"custom_logo_url": null
},
"name": "Another name",
"position": 2,
"skip_on_failure": true,
"enabled": false,
"created_at": "2025-07-12T00:14:40.414-07:00",
"updated_at": "2025-07-12T00:14:41.695-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/workflow_task_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_workflow_task"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a workflow task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowTasks"
],
"description": "Delete a specific workflow task by id",
"operationId": "deleteWorkflowTask",
"responses": {
"200": {
"description": "workflow_task deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "74b1c4a3-2e65-4d97-bbb1-8e11b79a26fc",
"type": "workflow_tasks",
"attributes": {
"workflow_id": "8fea63ed-5374-4087-8000-5e19bd30c2d3",
"task_params": {
"task_type": "send_email",
"from": "Rootly <workflows@rootly.com>",
"to": [
"magni"
],
"cc": [],
"bcc": [],
"subject": "Ut labore mollitia omnis.",
"preheader": null,
"body": "Ullam eius facilis odio.",
"include_header": true,
"include_footer": true,
"custom_logo_url": null
},
"name": "Send an email",
"position": 1,
"skip_on_failure": false,
"enabled": true,
"created_at": "2025-07-12T00:14:40.414-07:00",
"updated_at": "2025-07-12T00:14:42.243-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/workflow_task_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/workflows/{workflow_id}/custom_field_selections": {
"parameters": [
{
"name": "workflow_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "[DEPRECATED] Creates a workflow custom field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] WorkflowCustomFieldSelections"
],
"description": "[DEPRECATED] Use form field endpoints instead. Creates a new workflow custom field selection from provided data",
"deprecated": true,
"operationId": "createWorkflowCustomFieldSelection",
"parameters": [],
"responses": {
"201": {
"description": "workflow_custom_field_selection created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "2",
"type": "workflow_custom_field_selections",
"attributes": {
"custom_field_id": 167,
"workflow_id": "6d564fb2-29b4-4262-8a6f-9b460d0ff8ef",
"incident_condition": "ANY",
"values": [],
"selected_option_ids": []
}
}
},
"schema": {
"$ref": "#/components/schemas/workflow_custom_field_selection_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_workflow_custom_field_selection"
}
}
},
"required": true
}
},
"get": {
"summary": "[DEPRECATED] List workflow custom field selections",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] WorkflowCustomFieldSelections"
],
"description": "[DEPRECATED] Use form field endpoints instead. List workflow custom field selections",
"deprecated": true,
"operationId": "listWorkflowCustomFieldSelections",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_custom_field_selection_list"
}
}
}
}
}
}
},
"/v1/workflow_custom_field_selections/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "[DEPRECATED] Retrieves a workflow custom field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] WorkflowCustomFieldSelections"
],
"description": "[DEPRECATED] Use form field endpoints instead. Retrieves a specific workflow custom field selection by id",
"deprecated": true,
"operationId": "getWorkflowCustomFieldSelection",
"responses": {
"200": {
"description": "workflow_custom_field_selection found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "1",
"type": "workflow_custom_field_selections",
"attributes": {
"custom_field_id": 166,
"workflow_id": "6d564fb2-29b4-4262-8a6f-9b460d0ff8ef",
"incident_condition": "ANY",
"values": [],
"selected_option_ids": []
}
}
},
"schema": {
"$ref": "#/components/schemas/workflow_custom_field_selection_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "[DEPRECATED] Update a workflow custom field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] WorkflowCustomFieldSelections"
],
"description": "[DEPRECATED] Use form field endpoints instead. Update a specific workflow custom field selection by id",
"deprecated": true,
"operationId": "updateWorkflowCustomFieldSelection",
"parameters": [],
"responses": {
"200": {
"description": "workflow_custom_field_selection updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "1",
"type": "workflow_custom_field_selections",
"attributes": {
"custom_field_id": 166,
"workflow_id": "6d564fb2-29b4-4262-8a6f-9b460d0ff8ef",
"incident_condition": "IS",
"values": [],
"selected_option_ids": []
}
}
},
"schema": {
"$ref": "#/components/schemas/workflow_custom_field_selection_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_workflow_custom_field_selection"
}
}
},
"required": true
}
},
"delete": {
"summary": "[DEPRECATED] Delete a workflow custom field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] WorkflowCustomFieldSelections"
],
"description": "[DEPRECATED] Use form field endpoints instead. Delete a specific workflow custom field selection by id",
"deprecated": true,
"operationId": "deleteWorkflowCustomFieldSelection",
"responses": {
"200": {
"description": "workflow_custom_field_selection deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "1",
"type": "workflow_custom_field_selections",
"attributes": {
"custom_field_id": 166,
"workflow_id": "6d564fb2-29b4-4262-8a6f-9b460d0ff8ef",
"incident_condition": "ANY",
"values": [],
"selected_option_ids": []
}
}
},
"schema": {
"$ref": "#/components/schemas/workflow_custom_field_selection_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/workflows/{workflow_id}/form_field_conditions": {
"parameters": [
{
"name": "workflow_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a workflow form field condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowFormFieldConditions"
],
"description": "Creates a new workflow form field condition from provided data",
"operationId": "createWorkflowFormFieldCondition",
"parameters": [],
"responses": {
"201": {
"description": "workflow_form_field_condition created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "2dd21399-29a9-418f-8415-b71aa966b159",
"type": "workflow_form_field_conditions",
"attributes": {
"workflow_id": "44f4c4d3-d588-4ec8-ab09-2f046b0305f6",
"form_field_id": "d424f8d3-8290-47b6-bd08-9b05e1690e10",
"incident_condition": "ANY",
"values": [],
"selected_group_ids": [],
"selected_option_ids": [],
"selected_service_ids": [],
"selected_functionality_ids": [],
"selected_user_ids": [],
"selected_catalog_entity_ids": []
}
}
},
"schema": {
"$ref": "#/components/schemas/workflow_form_field_condition_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_workflow_form_field_condition"
}
}
},
"required": true
}
},
"get": {
"summary": "List workflow form field conditions",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowFormFieldConditions"
],
"description": "List workflow form field conditions",
"operationId": "listWorkflowFormFieldConditions",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_form_field_condition_list"
}
}
}
}
}
}
},
"/v1/workflow_form_field_conditions/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a workflow form field condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowFormFieldConditions"
],
"description": "Retrieves a specific workflow form field condition by id",
"operationId": "getWorkflowFormFieldCondition",
"responses": {
"200": {
"description": "workflow_form_field_condition found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "eb418efd-c7ac-4a69-8040-42fb84d40b68",
"type": "workflow_form_field_conditions",
"attributes": {
"workflow_id": "44f4c4d3-d588-4ec8-ab09-2f046b0305f6",
"form_field_id": "bd5262a8-d370-456d-beb6-92365076863d",
"incident_condition": "ANY",
"values": [],
"selected_group_ids": [],
"selected_option_ids": [],
"selected_service_ids": [],
"selected_functionality_ids": [],
"selected_user_ids": [],
"selected_catalog_entity_ids": []
}
}
},
"schema": {
"$ref": "#/components/schemas/workflow_form_field_condition_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a workflow form field condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowFormFieldConditions"
],
"description": "Update a specific workflow form field condition by id",
"operationId": "updateWorkflowFormFieldCondition",
"parameters": [],
"responses": {
"200": {
"description": "workflow_form_field_condition updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "eb418efd-c7ac-4a69-8040-42fb84d40b68",
"type": "workflow_form_field_conditions",
"attributes": {
"workflow_id": "44f4c4d3-d588-4ec8-ab09-2f046b0305f6",
"form_field_id": "bd5262a8-d370-456d-beb6-92365076863d",
"incident_condition": "IS",
"values": [],
"selected_group_ids": [],
"selected_option_ids": [],
"selected_service_ids": [],
"selected_functionality_ids": [],
"selected_user_ids": [],
"selected_catalog_entity_ids": []
}
}
},
"schema": {
"$ref": "#/components/schemas/workflow_form_field_condition_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_workflow_form_field_condition"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a workflow_form field condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowFormFieldConditions"
],
"description": "Delete a specific workflow form field condition by id",
"operationId": "deleteWorkflowFormFieldCondition",
"responses": {
"200": {
"description": "workflow_form_field_condition deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "eb418efd-c7ac-4a69-8040-42fb84d40b68",
"type": "workflow_form_field_conditions",
"attributes": {
"workflow_id": "44f4c4d3-d588-4ec8-ab09-2f046b0305f6",
"form_field_id": "bd5262a8-d370-456d-beb6-92365076863d",
"incident_condition": "ANY",
"values": [],
"selected_group_ids": [],
"selected_option_ids": [],
"selected_service_ids": [],
"selected_functionality_ids": [],
"selected_user_ids": [],
"selected_catalog_entity_ids": []
}
}
},
"schema": {
"$ref": "#/components/schemas/workflow_form_field_condition_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/workflow_groups": {
"post": {
"summary": "Creates a workflow group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowGroups"
],
"description": "Creates a new workflow group from provided data",
"operationId": "createWorkflowGroup",
"parameters": [],
"responses": {
"201": {
"description": "workflow group created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "200e112b-2144-4ce6-84e2-d02b0fdbc6fb",
"type": "workflow_groups",
"attributes": {
"kind": "incident",
"name": "Test",
"description": null,
"icon": "\ud83d\udcc1",
"slug": "test-incident",
"expanded": true,
"position": 1
}
}
},
"schema": {
"$ref": "#/components/schemas/workflow_group_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_workflow_group"
}
}
},
"required": true
}
},
"get": {
"summary": "List workflow groups",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowGroups"
],
"description": "List workflow groups",
"operationId": "listWorkflowGroups",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[expanded]",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "filter[position]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_group_list"
}
}
}
}
}
}
},
"/v1/workflow_groups/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a workflow group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowGroups"
],
"description": "Retrieves a specific workflow group by id",
"operationId": "getWorkflowGroup",
"responses": {
"200": {
"description": "workflow group found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "7e3d1259-4491-495c-bc5c-90aff4055e53",
"type": "workflow_groups",
"attributes": {
"kind": "incident",
"name": "Default Workflow Group",
"description": null,
"icon": "\ud83d\udcc1",
"slug": "default-workflow-group-incident",
"expanded": true,
"position": 10
}
}
},
"schema": {
"$ref": "#/components/schemas/workflow_group_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a workflow group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowGroups"
],
"description": "Update a specific workflow group by id",
"operationId": "updateWorkflowGroup",
"parameters": [],
"responses": {
"200": {
"description": "workflow group updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "7e3d1259-4491-495c-bc5c-90aff4055e53",
"type": "workflow_groups",
"attributes": {
"kind": "incident",
"name": "Test update",
"description": null,
"icon": "\ud83d\udcc1",
"slug": "default-workflow-group-incident",
"expanded": true,
"position": 10
}
}
},
"schema": {
"$ref": "#/components/schemas/workflow_group_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_workflow_group"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a workflow_group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowGroups"
],
"description": "Delete a specific workflow group by id",
"operationId": "deleteWorkflowGroup",
"responses": {
"200": {
"description": "workflow group deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "7e3d1259-4491-495c-bc5c-90aff4055e53",
"type": "workflow_groups",
"attributes": {
"kind": "incident",
"name": "Default Workflow Group",
"description": null,
"icon": "\ud83d\udcc1",
"slug": "default-workflow-group-incident",
"expanded": true,
"position": 10
}
}
},
"schema": {
"$ref": "#/components/schemas/workflow_group_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/workflows/{workflow_id}/workflow_runs": {
"parameters": [
{
"name": "workflow_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "List workflow runs",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowRuns"
],
"description": "List workflow runs",
"operationId": "ListWorkflowRuns",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: genius_task_runs",
"schema": {
"type": "string",
"enum": [
"genius_task_runs"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_runs_list"
}
}
}
}
}
},
"post": {
"summary": "Creates a workflow run",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowRuns"
],
"description": "Creates a new workflow run from provided data",
"operationId": "createWorkflowRun",
"parameters": [],
"responses": {
"201": {
"description": "workflow run created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "4d06a4bf-e95a-454f-bda1-49e71236c96e",
"type": "workflow_runs",
"attributes": {
"kind": "incident",
"status": "queued",
"status_message": null,
"triggered_by": "user",
"user_id": 148,
"queued_at": "2025-07-12T00:14:55.115-07:00",
"started_at": null,
"completed_at": null,
"failed_at": null,
"canceled_at": null,
"updated_at": "2025-07-12T00:14:55.115-07:00",
"created_at": "2025-07-12T00:14:55.115-07:00",
"incident_id": "72b316a0-896b-4e9d-bfbd-f297f9ef3cdf",
"post_mortem_id": null,
"action_item_id": null,
"alert_id": null,
"pulse_id": null,
"workflow_id": "a8f7cae5-0260-41ed-8a78-bda043b6d1cd",
"workflow_name": "Grave of the Fireflies"
},
"relationships": {
"task_runs": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/workflow_run_response"
}
}
}
},
"422": {
"description": "workflow run not created",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Incident conditions are not satisfied",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_workflow_run"
}
}
},
"required": true
}
}
},
"/v1/workflows": {
"post": {
"summary": "Creates a workflow",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Workflows"
],
"description": "Creates a new workflow from provided data",
"operationId": "createWorkflow",
"parameters": [],
"responses": {
"201": {
"description": "admins can set 'locked' while creating a workflow",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "3771fdf2-574f-4b11-af71-9d2425acd8b1",
"type": "workflows",
"attributes": {
"name": "Test",
"slug": "test",
"description": null,
"command": "incident-test",
"command_feedback_enabled": true,
"repeat_every_duration": null,
"repeat_condition_duration_since_first_run": null,
"repeat_condition_number_of_repeats": 0,
"continuously_repeat": false,
"repeat_on": [],
"wait": null,
"enabled": true,
"locked": true,
"position": 1,
"workflow_group_id": "180f5081-139b-4aca-84c7-1cdc911b00e7",
"trigger_params": {
"trigger_type": "incident",
"triggers": [],
"incident_visibilities": [],
"incident_kinds": [
"normal"
],
"incident_statuses": [],
"incident_inactivity_duration": null,
"incident_condition": "ALL",
"incident_condition_visibility": "ANY",
"incident_condition_kind": "IS",
"incident_condition_status": "ANY",
"incident_condition_sub_status": "ANY",
"incident_condition_environment": "ANY",
"incident_condition_severity": "ANY",
"incident_condition_incident_type": "ANY",
"incident_condition_incident_roles": "ANY",
"incident_condition_service": "ANY",
"incident_condition_functionality": "ANY",
"incident_condition_group": "ANY",
"incident_condition_cause": "ANY",
"incident_condition_summary": null,
"incident_condition_started_at": null,
"incident_condition_detected_at": null,
"incident_condition_acknowledged_at": null,
"incident_condition_mitigated_at": null,
"incident_condition_resolved_at": null,
"incident_conditional_inactivity": null,
"incident_post_mortem_condition_cause": "ANY"
},
"severity_ids": [],
"environment_ids": [],
"incident_type_ids": [],
"incident_role_ids": [],
"service_ids": [],
"functionality_ids": [],
"group_ids": [],
"updated_at": "2025-07-12T00:15:05.419-07:00",
"created_at": "2025-07-12T00:15:05.419-07:00"
},
"relationships": {
"custom_field_selections": {
"data": []
},
"workflow_tasks": {
"data": []
},
"workflow_runs": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/workflow_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"403": {
"description": "non-admins can't set 'locked' while creating a workflow",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Unauthorized Action. Only admins can set locked",
"status": "403"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_workflow"
}
}
},
"required": true
}
},
"get": {
"summary": "List workflows",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Workflows"
],
"description": "List workflows",
"operationId": "listWorkflows",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: form_field_conditions,genius_tasks",
"schema": {
"type": "string",
"enum": [
"form_field_conditions",
"genius_tasks",
"genius_workflow_runs"
]
},
"required": false
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at",
"position",
"-position"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_list"
}
}
}
}
}
}
},
"/v1/workflows/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a workflow",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Workflows"
],
"description": "Retrieves a specific workflow by id",
"operationId": "getWorkflow",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: form_field_conditions,genius_tasks",
"schema": {
"type": "string",
"enum": [
"form_field_conditions",
"genius_tasks",
"genius_workflow_runs"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "workflow found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "e79308de-f2c0-4cb3-9670-ed641dffee6e",
"type": "workflows",
"attributes": {
"name": "The Matrix",
"slug": "the-matrix",
"description": null,
"command": "incident-the-matrix",
"command_feedback_enabled": true,
"repeat_every_duration": null,
"repeat_condition_duration_since_first_run": "",
"repeat_condition_number_of_repeats": 0,
"continuously_repeat": false,
"repeat_on": [],
"wait": null,
"enabled": true,
"locked": false,
"position": 1,
"workflow_group_id": null,
"trigger_params": {
"trigger_type": "incident",
"triggers": [],
"incident_visibilities": [],
"incident_kinds": [
"normal"
],
"incident_statuses": [],
"incident_inactivity_duration": null,
"incident_condition": "ALL",
"incident_condition_visibility": "ANY",
"incident_condition_kind": "IS",
"incident_condition_status": "ANY",
"incident_condition_sub_status": "ANY",
"incident_condition_environment": "ANY",
"incident_condition_severity": "ANY",
"incident_condition_incident_type": "ANY",
"incident_condition_incident_roles": "ANY",
"incident_condition_service": "ANY",
"incident_condition_functionality": "ANY",
"incident_condition_group": "ANY",
"incident_condition_cause": "ANY",
"incident_condition_summary": null,
"incident_condition_started_at": null,
"incident_condition_detected_at": null,
"incident_condition_acknowledged_at": null,
"incident_condition_mitigated_at": null,
"incident_condition_resolved_at": null,
"incident_conditional_inactivity": null,
"incident_post_mortem_condition_cause": "ANY"
},
"severity_ids": [],
"environment_ids": [],
"incident_type_ids": [],
"incident_role_ids": [],
"service_ids": [],
"functionality_ids": [],
"group_ids": [],
"updated_at": "2025-07-12T00:15:06.825-07:00",
"created_at": "2025-07-12T00:15:06.825-07:00"
},
"relationships": {
"custom_field_selections": {
"data": []
},
"workflow_tasks": {
"data": []
},
"workflow_runs": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/workflow_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a workflow",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Workflows"
],
"description": "Update a specific workflow by id",
"operationId": "updateWorkflow",
"parameters": [],
"responses": {
"200": {
"description": "admin can update 'locked' attribute",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "b05d62a1-282c-4162-b660-76ac31be52b1",
"type": "workflows",
"attributes": {
"name": "Updated",
"slug": "updated",
"description": null,
"command": "incident-spotlight",
"command_feedback_enabled": true,
"repeat_every_duration": null,
"repeat_condition_duration_since_first_run": null,
"repeat_condition_number_of_repeats": 0,
"continuously_repeat": false,
"repeat_on": [],
"wait": null,
"enabled": true,
"locked": true,
"position": 1,
"workflow_group_id": null,
"trigger_params": {
"trigger_type": "incident",
"triggers": [],
"incident_visibilities": [],
"incident_kinds": [
"normal"
],
"incident_statuses": [],
"incident_inactivity_duration": null,
"incident_condition": "ALL",
"incident_condition_visibility": "ANY",
"incident_condition_kind": "IS",
"incident_condition_status": "ANY",
"incident_condition_sub_status": "ANY",
"incident_condition_environment": "ANY",
"incident_condition_severity": "ANY",
"incident_condition_incident_type": "ANY",
"incident_condition_incident_roles": "ANY",
"incident_condition_service": "ANY",
"incident_condition_functionality": "ANY",
"incident_condition_group": "ANY",
"incident_condition_cause": "ANY",
"incident_condition_summary": null,
"incident_condition_started_at": null,
"incident_condition_detected_at": null,
"incident_condition_acknowledged_at": null,
"incident_condition_mitigated_at": null,
"incident_condition_resolved_at": null,
"incident_conditional_inactivity": null,
"incident_post_mortem_condition_cause": "ANY"
},
"severity_ids": [],
"environment_ids": [],
"incident_type_ids": [],
"incident_role_ids": [],
"service_ids": [],
"functionality_ids": [],
"group_ids": [],
"updated_at": "2025-07-12T00:15:12.858-07:00",
"created_at": "2025-07-12T00:15:12.360-07:00"
},
"relationships": {
"custom_field_selections": {
"data": []
},
"workflow_tasks": {
"data": []
},
"workflow_runs": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/workflow_response"
}
}
}
},
"404": {
"description": "non-admin can't update locked workflow",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"403": {
"description": "non-admin can't update 'locked' attribute",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Unauthorized Action. Only admins can set locked",
"status": "403"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_workflow"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a workflow",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Workflows"
],
"description": "Delete a specific workflow by id",
"operationId": "deleteWorkflow",
"responses": {
"200": {
"description": "admin can destroy locked workflow",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "bb974eac-9e08-4220-8de3-83857df71272",
"type": "workflows",
"attributes": {
"name": "Memento",
"slug": "memento",
"description": null,
"command": null,
"command_feedback_enabled": true,
"repeat_every_duration": null,
"repeat_condition_duration_since_first_run": "",
"repeat_condition_number_of_repeats": 0,
"continuously_repeat": false,
"repeat_on": [],
"wait": null,
"enabled": true,
"locked": true,
"position": 1,
"workflow_group_id": null,
"trigger_params": {
"trigger_type": "incident",
"triggers": [],
"incident_visibilities": [],
"incident_kinds": [
"normal"
],
"incident_statuses": [],
"incident_inactivity_duration": null,
"incident_condition": "ALL",
"incident_condition_visibility": "ANY",
"incident_condition_kind": "IS",
"incident_condition_status": "ANY",
"incident_condition_sub_status": "ANY",
"incident_condition_environment": "ANY",
"incident_condition_severity": "ANY",
"incident_condition_incident_type": "ANY",
"incident_condition_incident_roles": "ANY",
"incident_condition_service": "ANY",
"incident_condition_functionality": "ANY",
"incident_condition_group": "ANY",
"incident_condition_cause": "ANY",
"incident_condition_summary": null,
"incident_condition_started_at": null,
"incident_condition_detected_at": null,
"incident_condition_acknowledged_at": null,
"incident_condition_mitigated_at": null,
"incident_condition_resolved_at": null,
"incident_conditional_inactivity": null,
"incident_post_mortem_condition_cause": "ANY"
},
"severity_ids": [],
"environment_ids": [],
"incident_type_ids": [],
"incident_role_ids": [],
"service_ids": [],
"functionality_ids": [],
"group_ids": [],
"updated_at": "2025-07-12T00:15:15.511-07:00",
"created_at": "2025-07-12T00:15:15.038-07:00"
},
"relationships": {
"custom_field_selections": {
"data": []
},
"workflow_tasks": {
"data": []
},
"workflow_runs": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/workflow_response"
}
}
}
},
"404": {
"description": "non-admin can't destroy locked workflow",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/heartbeats/{heartbeat_id}/ping": {
"parameters": [
{
"name": "heartbeat_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Ping a heartbeat",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Heartbeats"
],
"description": "Ping a specific heartbeat by id",
"operationId": "pingHeartbeat",
"responses": {
"204": {
"description": "create ping"
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/heartbeats": {
"post": {
"summary": "Creates a heartbeat",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Heartbeats"
],
"description": "Creates a new heartbeat from provided data",
"operationId": "createHeartbeat",
"parameters": [],
"responses": {
"201": {
"description": "heartbeat created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "d7527a21-0017-409c-a7de-e45881bb1afd",
"type": "heartbeats",
"attributes": {
"slug": "api",
"name": "API",
"description": "This is a description",
"alert_summary": "API is down",
"alert_urgency_id": "6a92e1e8-8365-427d-a3ed-37e81e08522c",
"interval": 1,
"interval_unit": "minutes",
"notification_target_id": "158",
"notification_target_type": "User",
"ping_url": "http://localhost:3001/v1/heartbeats/d7527a21-0017-409c-a7de-e45881bb1afd/ping",
"secret": "heartbeat_5da073c24dc72fd1ae6306d87c5f906fd454a313090e761e2e453a4f1d8255d6",
"last_pinged_at": null,
"expires_at": null,
"enabled": false,
"status": "waiting",
"updated_at": "2025-07-12T00:15:24.862-07:00",
"created_at": "2025-07-12T00:15:24.862-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/heartbeat_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
},
{
"title": "Name can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_heartbeat"
}
}
},
"required": true
}
},
"get": {
"summary": "List heartbeats",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Heartbeats"
],
"description": "List heartbeats",
"operationId": "listHeartbeats",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/heartbeat_list"
}
}
}
}
}
}
},
"/v1/heartbeats/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a heartbeat",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Heartbeats"
],
"description": "Retrieves a specific heartbeat by id",
"operationId": "getHeartbeat",
"responses": {
"200": {
"description": "heartbeat found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "f95ba55b-7a24-451c-8942-1358aa83c63c",
"type": "heartbeats",
"attributes": {
"slug": "iusto-labore-aliquam-ut",
"name": "Iusto labore aliquam ut.",
"description": "Est rerum voluptatem repudiandae.",
"alert_summary": "API is down",
"alert_urgency_id": "3fb1c49b-68d2-4a26-b2f6-03d1181e80c3",
"interval": 2,
"interval_unit": "hours",
"notification_target_id": "160",
"notification_target_type": "User",
"ping_url": "http://localhost:3001/v1/heartbeats/f95ba55b-7a24-451c-8942-1358aa83c63c/ping",
"secret": "heartbeat_c8b49163f95b72c692d7de632050417fb7af2fefb8c92a45b6ca2b88057024a9",
"last_pinged_at": null,
"expires_at": null,
"enabled": false,
"status": "waiting",
"updated_at": "2025-07-12T00:15:19.078-07:00",
"created_at": "2025-07-12T00:15:19.078-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/heartbeat_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a heartbeat",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Heartbeats"
],
"description": "Update a specific heartbeat by id",
"operationId": "updateHeartbeat",
"parameters": [],
"responses": {
"200": {
"description": "heartbeat updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "f95ba55b-7a24-451c-8942-1358aa83c63c",
"type": "heartbeats",
"attributes": {
"slug": "iusto-labore-aliquam-ut",
"name": "api.rootly.com",
"description": "This is a description",
"alert_summary": "API is down",
"alert_urgency_id": "6a92e1e8-8365-427d-a3ed-37e81e08522c",
"interval": 10,
"interval_unit": "minutes",
"notification_target_id": "160",
"notification_target_type": "User",
"ping_url": "http://localhost:3001/v1/heartbeats/f95ba55b-7a24-451c-8942-1358aa83c63c/ping",
"secret": "heartbeat_c8b49163f95b72c692d7de632050417fb7af2fefb8c92a45b6ca2b88057024a9",
"last_pinged_at": null,
"expires_at": null,
"enabled": false,
"status": "waiting",
"updated_at": "2025-07-12T00:15:25.920-07:00",
"created_at": "2025-07-12T00:15:19.078-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/heartbeat_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"422": {
"description": "invalid enum value",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Interval unit is not included in the list",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_heartbeat"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a heartbeat",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Heartbeats"
],
"description": "Delete a specific heartbeat by id",
"operationId": "deleteHeartbeat",
"responses": {
"200": {
"description": "heartbeat deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "f95ba55b-7a24-451c-8942-1358aa83c63c",
"type": "heartbeats",
"attributes": {
"slug": "iusto-labore-aliquam-ut",
"name": "Iusto labore aliquam ut.",
"description": "Est rerum voluptatem repudiandae.",
"alert_summary": "API is down",
"alert_urgency_id": "3fb1c49b-68d2-4a26-b2f6-03d1181e80c3",
"interval": 2,
"interval_unit": "hours",
"notification_target_id": "160",
"notification_target_type": "User",
"ping_url": "http://localhost:3001/v1/heartbeats/f95ba55b-7a24-451c-8942-1358aa83c63c/ping",
"secret": "heartbeat_c8b49163f95b72c692d7de632050417fb7af2fefb8c92a45b6ca2b88057024a9",
"last_pinged_at": null,
"expires_at": null,
"enabled": false,
"status": "waiting",
"updated_at": "2025-07-12T00:15:26.518-07:00",
"created_at": "2025-07-12T00:15:19.078-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/heartbeat_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incidents/{incident_id}/action_items": {
"parameters": [
{
"name": "incident_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an incident action item",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentActionItems"
],
"description": "Creates a new action item from provided data",
"operationId": "createIncidentActionItem",
"parameters": [],
"responses": {
"201": {
"description": "incident_action_item created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "0d75e397-28e4-4ded-bcee-7c95cf0b7088",
"type": "incident_action_items",
"attributes": {
"incident_id": "4cb76c85-9531-4195-93ff-974722dfbf7f",
"incident_title": "Maiores modi quo et.",
"description": "New action item description",
"assigned_to": {
"id": 171,
"email": "buffy_jacobs@wilderman.example",
"deleted_at": null,
"created_at": "2025-07-12T00:15:26.879-07:00",
"updated_at": "2025-07-12T00:15:30.037-07:00",
"current_team_id": 162,
"first_name": "Johnetta",
"last_name": "Langosh",
"time_zone": "UTC",
"last_seen_at": null,
"profile_photo_id": null,
"ability_cache": {
"team_ids": [
162
],
"administrating_team_ids": []
},
"last_notification_email_sent_at": null,
"accept_terms": true,
"onboarding_completed": true,
"service_user": false,
"accept_marketing": true,
"teams_count": 1,
"created_through_sso": false,
"scim_uid": null,
"session_token": null,
"incidents_example_count": 0,
"incidents_test_count": 0,
"incidents_normal_count": 0,
"incidents_scheduled_count": 0,
"incidents_backfilled_count": 0,
"incidents_count": 0,
"theme": "light_v2",
"skip_tutorial": false,
"external_id": null,
"jti": "81cdf534-2713-4734-9901-7f7fa4caae6a",
"is_super_admin": false,
"has_impersonate_write_permission": false,
"view_multiple_schedules": true,
"push_notification_new_alert_sound": "default",
"push_notification_shift_starts_sound": "soft_bloob",
"push_notification_shift_ends_sound": "soft_bloob",
"how_did_you_hear_about_us": null,
"push_notification_new_alert_volume": 1.0,
"opsgenie_id": null,
"victor_ops_id": null,
"pagerduty_id": null,
"locale": "en"
},
"assigned_to_group_ids": [
"0745da67-2ec2-4df4-9c13-09fabcb8b493",
"9a126afa-4184-4b73-b533-95ed606ab597"
],
"kind": "task",
"priority": "medium",
"status": "open",
"due_date": null,
"jira_issue_id": null,
"jira_issue_key": null,
"jira_issue_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,
"shortcut_story_id": null,
"shortcut_story_url": null,
"shortcut_task_id": null,
"shortcut_task_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,
"airtable_base_key": null,
"airtable_table_name": null,
"airtable_record_id": null,
"airtable_record_url": null,
"freshservice_ticket_id": null,
"freshservice_ticket_url": null,
"freshservice_task_id": null,
"freshservice_task_url": null,
"url": "https://test.rootly.com/account/incidents/maiores-modi-quo-et#nav-action-items",
"short_url": null,
"created_at": "2025-07-12T00:15:30.186-07:00",
"updated_at": "2025-07-12T00:15:30.186-07:00",
"summary": "New action item summary"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_action_item_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Summary can't be blank",
"status": "422"
},
{
"title": "Summary raw can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_action_item"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident action items",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentActionItems"
],
"description": "List incident action items",
"operationId": "listIncidentActionItems",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_action_item_list"
}
}
}
}
}
}
},
"/v1/action_items/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident action item",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentActionItems"
],
"description": "Retrieves a specific incident_action_item by id",
"operationId": "getIncidentActionItems",
"responses": {
"200": {
"description": "incident_action_item found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "ebbf496a-4fb9-42c5-8cbd-1bea52ff254e",
"type": "incident_action_items",
"attributes": {
"incident_id": "4cb76c85-9531-4195-93ff-974722dfbf7f",
"incident_title": "Maiores modi quo et.",
"description": "shabby chic wolf locavore pickled twee poke. YOLO godard health goth pork belly cold-pressed swag",
"assigned_to": null,
"assigned_to_group_ids": [],
"kind": "follow_up",
"priority": "high",
"status": "open",
"due_date": null,
"jira_issue_id": null,
"jira_issue_key": null,
"jira_issue_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,
"shortcut_story_id": null,
"shortcut_story_url": null,
"shortcut_task_id": null,
"shortcut_task_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,
"airtable_base_key": null,
"airtable_table_name": null,
"airtable_record_id": null,
"airtable_record_url": null,
"freshservice_ticket_id": null,
"freshservice_ticket_url": null,
"freshservice_task_id": null,
"freshservice_task_url": null,
"url": "https://test.rootly.com/account/incidents/maiores-modi-quo-et#nav-action-items",
"short_url": null,
"created_at": "2025-07-12T00:15:29.439-07:00",
"updated_at": "2025-07-12T00:15:29.439-07:00",
"summary": "shabby chic wolf locavore pickled twee poke. YOLO godard health goth pork belly cold-pressed swag"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_action_item_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident action item",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentActionItems"
],
"description": "Update a specific incident action item by id",
"operationId": "updateIncidentActionItem",
"parameters": [],
"responses": {
"200": {
"description": "incident_action_item updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "ebbf496a-4fb9-42c5-8cbd-1bea52ff254e",
"type": "incident_action_items",
"attributes": {
"incident_id": "4cb76c85-9531-4195-93ff-974722dfbf7f",
"incident_title": "Maiores modi quo et.",
"description": "Action item description updated",
"assigned_to": null,
"assigned_to_group_ids": [],
"kind": "follow_up",
"priority": "high",
"status": "open",
"due_date": null,
"jira_issue_id": null,
"jira_issue_key": null,
"jira_issue_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,
"shortcut_story_id": null,
"shortcut_story_url": null,
"shortcut_task_id": null,
"shortcut_task_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,
"airtable_base_key": null,
"airtable_table_name": null,
"airtable_record_id": null,
"airtable_record_url": null,
"freshservice_ticket_id": null,
"freshservice_ticket_url": null,
"freshservice_task_id": null,
"freshservice_task_url": null,
"url": "https://test.rootly.com/account/incidents/maiores-modi-quo-et#nav-action-items",
"short_url": null,
"created_at": "2025-07-12T00:15:29.439-07:00",
"updated_at": "2025-07-12T00:15:31.817-07:00",
"summary": "Action item summary updated"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_action_item_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_action_item"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident action item",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentActionItems"
],
"description": "Delete a specific incident action item by id",
"operationId": "deleteIncidentActionItem",
"responses": {
"200": {
"description": "incident_action_item deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "ebbf496a-4fb9-42c5-8cbd-1bea52ff254e",
"type": "incident_action_items",
"attributes": {
"incident_id": "4cb76c85-9531-4195-93ff-974722dfbf7f",
"incident_title": "Maiores modi quo et.",
"description": "shabby chic wolf locavore pickled twee poke. YOLO godard health goth pork belly cold-pressed swag",
"assigned_to": null,
"assigned_to_group_ids": [],
"kind": "follow_up",
"priority": "high",
"status": "open",
"due_date": null,
"jira_issue_id": null,
"jira_issue_key": null,
"jira_issue_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,
"shortcut_story_id": null,
"shortcut_story_url": null,
"shortcut_task_id": null,
"shortcut_task_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,
"airtable_base_key": null,
"airtable_table_name": null,
"airtable_record_id": null,
"airtable_record_url": null,
"freshservice_ticket_id": null,
"freshservice_ticket_url": null,
"freshservice_task_id": null,
"freshservice_task_url": null,
"url": "https://test.rootly.com/account/incidents/maiores-modi-quo-et#nav-action-items",
"short_url": null,
"created_at": "2025-07-12T00:15:29.439-07:00",
"updated_at": "2025-07-12T00:15:33.104-07:00",
"summary": "shabby chic wolf locavore pickled twee poke. YOLO godard health goth pork belly cold-pressed swag"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_action_item_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/action_items": {
"get": {
"summary": "List all action items for an organization",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentActionItems"
],
"description": "List all action items for an organization",
"operationId": "listAllIncidentActionItems",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[priority]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[status]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[incident_status]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[incident_created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[incident_created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[incident_created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[incident_created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[due_date][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[due_date][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[due_date][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[due_date][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_action_item_list"
}
}
}
}
}
}
},
"/v1/incidents/{incident_id}/custom_field_selections": {
"parameters": [
{
"name": "incident_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "[DEPRECATED] Creates an incident custom field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] IncidentCustomFieldSelections"
],
"description": "[DEPRECATED] Use form field endpoints instead. Creates a new incident custom field selection from provided data",
"deprecated": true,
"operationId": "createIncidentCustomFieldSelection",
"parameters": [],
"responses": {
"201": {
"description": "incident_custom_field_selection created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "2",
"type": "incident_custom_field_selections",
"attributes": {
"custom_field_id": 173,
"incident_id": "f33c9c1f-9b8b-4961-97e0-5247276d88e9",
"value": "Test custom field",
"selected_option_ids": []
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_custom_field_selection_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "requires either value or at least one selected option, group, service, or user",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_custom_field_selection"
}
}
},
"required": true
}
},
"get": {
"summary": "[DEPRECATED] List incident custom field selections",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] IncidentCustomFieldSelections"
],
"description": "[DEPRECATED] Use form field endpoints instead. List incident custom field selections",
"deprecated": true,
"operationId": "listIncidentCustomFieldSelections",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_custom_field_selection_list"
}
}
}
}
}
}
},
"/v1/incident_custom_field_selections/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "[DEPRECATED] Retrieves an incident custom field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] IncidentCustomFieldSelections"
],
"description": "[DEPRECATED] Use form field endpoints instead. Retrieves a specific incident custom field selection by id",
"deprecated": true,
"operationId": "getIncidentCustomFieldSelection",
"responses": {
"200": {
"description": "incident_custom_field_selection found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "1",
"type": "incident_custom_field_selections",
"attributes": {
"custom_field_id": 172,
"incident_id": "f33c9c1f-9b8b-4961-97e0-5247276d88e9",
"value": "Numquam aut quis tenetur.",
"selected_option_ids": []
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_custom_field_selection_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "[DEPRECATED] Update an incident custom field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] IncidentCustomFieldSelections"
],
"description": "[DEPRECATED] Use form field endpoints instead. Update a specific incident custom field selection by id",
"deprecated": true,
"operationId": "updateIncidentCustomFieldSelection",
"parameters": [],
"responses": {
"200": {
"description": "incident_custom_field_selection updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "1",
"type": "incident_custom_field_selections",
"attributes": {
"custom_field_id": 172,
"incident_id": "f33c9c1f-9b8b-4961-97e0-5247276d88e9",
"value": "Test update custom field",
"selected_option_ids": []
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_custom_field_selection_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_custom_field_selection"
}
}
},
"required": true
}
},
"delete": {
"summary": "[DEPRECATED] Delete an incident custom field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] IncidentCustomFieldSelections"
],
"description": "[DEPRECATED] Use form field endpoints instead. Delete a specific incident custom field selection by id",
"deprecated": true,
"operationId": "deleteIncidentCustomFieldSelection",
"responses": {
"200": {
"description": "incident_custom_field_selection deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "1",
"type": "incident_custom_field_selections",
"attributes": {
"custom_field_id": 172,
"incident_id": "f33c9c1f-9b8b-4961-97e0-5247276d88e9",
"value": "Numquam aut quis tenetur.",
"selected_option_ids": []
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_custom_field_selection_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/events/{incident_event_id}/functionalities": {
"parameters": [
{
"name": "incident_event_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an incident event functionality",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEventFunctionalities"
],
"description": "Creates a new event functionality from provided data",
"operationId": "createIncidentEventFunctionality",
"parameters": [],
"responses": {
"201": {
"description": "incident_event_functionality created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "73609fea-07f3-475d-b7be-9a89376f7a28",
"type": "incident_event_functionalities",
"attributes": {
"incident_event_id": "99d33d33-f100-4d57-9def-fdbc253b3a4c",
"functionality_id": "7f7a3a6c-b6d3-473f-8a44-f2d674393039",
"status": "partial_outage"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_event_functionality_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Functionality must exist",
"status": "422"
},
{
"title": "Functionality can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_event_functionality"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident event functionalities",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEventFunctionalities"
],
"description": "List incident event functionalities",
"operationId": "listIncidentEventFunctionalities",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_event_functionality_list"
}
}
}
}
}
}
},
"/v1/incident_event_functionalities/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident event functionality",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEventFunctionalities"
],
"description": "Retrieves a specific incident_event_functionality by id",
"operationId": "getIncidentEventFunctionalities",
"responses": {
"200": {
"description": "incident_event_functionality found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "d8df5035-74f8-4dc0-85b2-97e8393d9ba2",
"type": "incident_event_functionalities",
"attributes": {
"incident_event_id": "99d33d33-f100-4d57-9def-fdbc253b3a4c",
"functionality_id": "0ad87656-3b9d-471e-9622-3f3864967a1d",
"status": "partial_outage"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_event_functionality_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEventFunctionalities"
],
"description": "Update a specific incident event functionality by id",
"operationId": "updateIncidentEventFunctionality",
"parameters": [],
"responses": {
"200": {
"description": "incident_event_functionality updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "d8df5035-74f8-4dc0-85b2-97e8393d9ba2",
"type": "incident_event_functionalities",
"attributes": {
"incident_event_id": "99d33d33-f100-4d57-9def-fdbc253b3a4c",
"functionality_id": "0ad87656-3b9d-471e-9622-3f3864967a1d",
"status": "major_outage"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_event_functionality_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_event_functionality"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident event functionality",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEventFunctionalities"
],
"description": "Delete a specific incident event functionality by id",
"operationId": "deleteIncidentEventFunctionality",
"responses": {
"200": {
"description": "incident_event deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "d8df5035-74f8-4dc0-85b2-97e8393d9ba2",
"type": "incident_event_functionalities",
"attributes": {
"incident_event_id": "99d33d33-f100-4d57-9def-fdbc253b3a4c",
"functionality_id": "0ad87656-3b9d-471e-9622-3f3864967a1d",
"status": "partial_outage"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_event_functionality_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/events/{incident_event_id}/services": {
"parameters": [
{
"name": "incident_event_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an incident event service",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEventServices"
],
"description": "Creates a new event service from provided data",
"operationId": "createIncidentEventService",
"parameters": [],
"responses": {
"201": {
"description": "incident_event_service created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "baa68659-8085-42f2-bfab-246879fc3acd",
"type": "incident_event_services",
"attributes": {
"incident_event_id": "595ae66e-0031-4a48-afbc-a1978a7201b8",
"service_id": "3d0c1c77-0ec1-43c3-947c-62db12b36ba3",
"status": "partial_outage"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_event_service_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Service must exist",
"status": "422"
},
{
"title": "Service can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_event_service"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident event services",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEventServices"
],
"description": "List incident event services",
"operationId": "listIncidentEventServices",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_event_service_list"
}
}
}
}
}
}
},
"/v1/incident_event_services/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident event service",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEventServices"
],
"description": "Retrieves a specific incident_event_service by id",
"operationId": "getIncidentEventServices",
"responses": {
"200": {
"description": "incident_event_service found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "82f815bb-da71-4658-ae0c-273b33612e21",
"type": "incident_event_services",
"attributes": {
"incident_event_id": "595ae66e-0031-4a48-afbc-a1978a7201b8",
"service_id": "37ce3ba0-5462-47e0-aefb-d74787a70b77",
"status": "partial_outage"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_event_service_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEventServices"
],
"description": "Update a specific incident event service by id",
"operationId": "updateIncidentEventService",
"parameters": [],
"responses": {
"200": {
"description": "incident_event_service updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "82f815bb-da71-4658-ae0c-273b33612e21",
"type": "incident_event_services",
"attributes": {
"incident_event_id": "595ae66e-0031-4a48-afbc-a1978a7201b8",
"service_id": "37ce3ba0-5462-47e0-aefb-d74787a70b77",
"status": "major_outage"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_event_service_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_event_service"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident event functionalitu",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEventServices"
],
"description": "Delete a specific incident event service by id",
"operationId": "deleteIncidentEventService",
"responses": {
"200": {
"description": "incident_event deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "82f815bb-da71-4658-ae0c-273b33612e21",
"type": "incident_event_services",
"attributes": {
"incident_event_id": "595ae66e-0031-4a48-afbc-a1978a7201b8",
"service_id": "37ce3ba0-5462-47e0-aefb-d74787a70b77",
"status": "partial_outage"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_event_service_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incidents/{incident_id}/events": {
"parameters": [
{
"name": "incident_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an incident event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEvents"
],
"description": "Creates a new event from provided data",
"operationId": "createIncidentEvent",
"parameters": [],
"responses": {
"201": {
"description": "incident_event created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "9e08307b-126a-499c-b65d-9f3454285d76",
"type": "incident_events",
"attributes": {
"event": "New Event",
"event_raw": "New Event",
"kind": "event",
"source": "web",
"visibility": "external",
"user_display_name": "Rootly",
"occurred_at": "2025-07-12T00:15:47.811-07:00",
"starred_at": null,
"created_at": "2025-07-12T00:15:47.811-07:00",
"updated_at": "2025-07-12T00:15:47.811-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_event_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Event can't be blank",
"status": "422"
},
{
"title": "Event raw can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_event"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident events",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEvents"
],
"description": "List incident events",
"operationId": "listIncidentEvents",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_event_list"
}
}
}
}
}
}
},
"/v1/events/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEvents"
],
"description": "Retrieves a specific incident_event by id",
"operationId": "getIncidentEvents",
"responses": {
"200": {
"description": "incident_event found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "63bc5b9d-9382-496b-8ed0-182b3be847f8",
"type": "incident_events",
"attributes": {
"event": "Beatae at eum excepturi.",
"event_raw": "Beatae at eum excepturi.",
"kind": "event",
"source": "web",
"visibility": "internal",
"user_display_name": "Misti Christiansen",
"occurred_at": "2025-07-12T00:15:47.227-07:00",
"starred_at": null,
"created_at": "2025-07-12T00:15:47.227-07:00",
"updated_at": "2025-07-12T00:15:47.227-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_event_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEvents"
],
"description": "Update a specific incident event by id",
"operationId": "updateIncidentEvent",
"parameters": [],
"responses": {
"200": {
"description": "incident_event updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "63bc5b9d-9382-496b-8ed0-182b3be847f8",
"type": "incident_events",
"attributes": {
"event": "Event updated",
"event_raw": "Event updated",
"kind": "event",
"source": "web",
"visibility": "internal",
"user_display_name": "Misti Christiansen",
"occurred_at": "2025-07-12T00:15:47.227-07:00",
"starred_at": null,
"created_at": "2025-07-12T00:15:47.227-07:00",
"updated_at": "2025-07-12T00:15:49.174-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_event_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_event"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEvents"
],
"description": "Delete a specific incident event by id",
"operationId": "deleteIncidentEvent",
"responses": {
"200": {
"description": "incident_event deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "63bc5b9d-9382-496b-8ed0-182b3be847f8",
"type": "incident_events",
"attributes": {
"event": "Beatae at eum excepturi.",
"event_raw": "Beatae at eum excepturi.",
"kind": "event",
"source": "web",
"visibility": "internal",
"user_display_name": "Misti Christiansen",
"occurred_at": "2025-07-12T00:15:47.227-07:00",
"starred_at": null,
"created_at": "2025-07-12T00:15:47.227-07:00",
"updated_at": "2025-07-12T00:15:49.656-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_event_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incidents/{incident_id}/feedbacks": {
"parameters": [
{
"name": "incident_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an incident feedback",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentFeedbacks"
],
"description": "Creates a new feedback from provided data",
"operationId": "createIncidentFeedback",
"parameters": [],
"responses": {
"201": {
"description": "incident_feedback created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "92e789fa-a14d-4bac-aa64-9ca870b49e86",
"type": "incident_feedbacks",
"attributes": {
"rating": 4,
"rating_humanized": "Very satisfied",
"feedback": "New Feedback",
"anonymous": true,
"updated_at": "2025-07-12T00:15:52.515-07:00",
"created_at": "2025-07-12T00:15:52.515-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_feedback_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Feedback can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_feedback"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident feedbacks",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentFeedbacks"
],
"description": "List incident feedbacks",
"operationId": "listIncidentFeedbacks",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_feedback_list"
}
}
}
}
}
}
},
"/v1/feedbacks/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident feedback",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentFeedbacks"
],
"description": "Retrieves a specific incident_feedback by id",
"operationId": "getIncidentFeedbacks",
"responses": {
"200": {
"description": "incident_feedback found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "6300d8fb-e7ba-4d51-8746-8aa758277a05",
"type": "incident_feedbacks",
"attributes": {
"rating": 1,
"rating_humanized": "Somewhat dissatisfied",
"feedback": "Aut ipsam sunt iure.",
"anonymous": false,
"updated_at": "2025-07-12T00:15:51.963-07:00",
"created_at": "2025-07-12T00:15:51.963-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_feedback_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident feedback",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentFeedbacks"
],
"description": "Update a specific incident feedback by id",
"operationId": "updateIncidentFeedback",
"parameters": [],
"responses": {
"200": {
"description": "incident_feedback updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "6300d8fb-e7ba-4d51-8746-8aa758277a05",
"type": "incident_feedbacks",
"attributes": {
"rating": 3,
"rating_humanized": "Somewhat satisfied",
"feedback": "Feedback updated",
"anonymous": false,
"updated_at": "2025-07-12T00:15:54.420-07:00",
"created_at": "2025-07-12T00:15:51.963-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_feedback_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_feedback"
}
}
},
"required": true
}
}
},
"/v1/incidents/{incident_id}/form_field_selections": {
"parameters": [
{
"name": "incident_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an incident form field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentFormFieldSelections"
],
"description": "Creates a new incident form field selection from provided data",
"operationId": "createIncidentFormFieldSelection",
"parameters": [],
"responses": {
"201": {
"description": "incident_form_field_selection created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "761046c3-a92b-435b-96df-e92a787519ae",
"type": "incident_form_field_selections",
"attributes": {
"incident_id": "dc0ab3c2-16b2-47fd-b06b-3ea21832fa94",
"custom_field_id": 176,
"form_field_id": "cddc42e1-e643-4abf-8615-0bfa1c4436ab",
"form_field": {
"id": "cddc42e1-e643-4abf-8615-0bfa1c4436ab",
"team_id": 186,
"slug": "eaque-non-et-asperiores",
"kind": "custom",
"input_kind": "text",
"value_kind": "inherit",
"value_kind_catalog_id": null,
"name": "Eaque non et asperiores.",
"description": "Distinctio ut voluptatibus eos.",
"shown": [
"web_new_incident_form",
"web_update_incident_form",
"slack_new_incident_form",
"slack_update_incident_form"
],
"required": [],
"default_values": [],
"show_on_incident_details": true,
"enabled": true,
"updated_at": "2025-07-12T00:15:56.122-07:00",
"created_at": "2025-07-12T00:15:56.122-07:00",
"options": [
{
"id": "287563cb-63d9-4587-95a8-fa12614d9a63",
"form_field_id": "cddc42e1-e643-4abf-8615-0bfa1c4436ab",
"value": "Quis optio sequi id.",
"color": "#FBE4A0",
"default": false,
"position": 1,
"updated_at": "2025-07-12T00:15:56.181-07:00",
"created_at": "2025-07-12T00:15:56.181-07:00"
},
{
"id": "b8d9c638-c4c5-4d13-8b5f-548f0e3f3043",
"form_field_id": "cddc42e1-e643-4abf-8615-0bfa1c4436ab",
"value": "Eaque consectetur et reiciendis.",
"color": "#FBE4A0",
"default": false,
"position": 2,
"updated_at": "2025-07-12T00:15:56.183-07:00",
"created_at": "2025-07-12T00:15:56.183-07:00"
}
],
"positions": [
{
"id": "ebad9ea0-0b39-490c-b1a9-668b01490171",
"form_field_id": "cddc42e1-e643-4abf-8615-0bfa1c4436ab",
"form": "web_new_incident_form",
"position": 2
},
{
"id": "293e599c-4a13-4094-ba10-75b8d60d74a7",
"form_field_id": "cddc42e1-e643-4abf-8615-0bfa1c4436ab",
"form": "slack_new_incident_form",
"position": 2
},
{
"id": "1ac6a377-de66-4bb3-ac0d-246b6d953c80",
"form_field_id": "cddc42e1-e643-4abf-8615-0bfa1c4436ab",
"form": "web_update_incident_form",
"position": 2
},
{
"id": "8ba293e3-307b-4d51-bcd3-dd6a3ed7f927",
"form_field_id": "cddc42e1-e643-4abf-8615-0bfa1c4436ab",
"form": "slack_update_incident_form",
"position": 2
}
]
},
"value": "Test custom field",
"selected_group_ids": [],
"selected_groups": {
"id": null,
"value": "Test custom field"
},
"selected_option_ids": [],
"selected_options": {
"id": null,
"value": "Test custom field"
},
"selected_service_ids": [],
"selected_services": {
"id": null,
"value": "Test custom field"
},
"selected_functionality_ids": [],
"selected_functionalities": {
"id": null,
"value": "Test custom field"
},
"selected_catalog_entity_ids": [],
"selected_catalog_entities": {
"id": null,
"value": "Test custom field"
},
"selected_user_ids": [],
"selected_users": {
"id": null,
"value": "Test custom field"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_form_field_selection_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Form field must exist",
"status": "422"
},
{
"title": "requires either value or at least one selected option, group, service, or user",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_form_field_selection"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident form field selections",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentFormFieldSelections"
],
"description": "List incident form field selections",
"operationId": "listIncidentFormFieldSelections",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_form_field_selection_list"
}
}
}
}
}
}
},
"/v1/incident_form_field_selections/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident form field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentFormFieldSelections"
],
"description": "Retrieves a specific incident form field selection by id",
"operationId": "getIncidentFormFieldSelection",
"responses": {
"200": {
"description": "incident_form_field_selection found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "699a3405-1585-4bab-813f-42207df57f5d",
"type": "incident_form_field_selections",
"attributes": {
"incident_id": "dc0ab3c2-16b2-47fd-b06b-3ea21832fa94",
"custom_field_id": 175,
"form_field_id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"form_field": {
"id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"team_id": 186,
"slug": "debitis-et-autem-sunt",
"kind": "custom",
"input_kind": "text",
"value_kind": "inherit",
"value_kind_catalog_id": null,
"name": "Debitis et autem sunt.",
"description": "Deserunt exercitationem eos voluptatibus.",
"shown": [
"web_new_incident_form",
"web_update_incident_form",
"slack_new_incident_form",
"slack_update_incident_form"
],
"required": [],
"default_values": [],
"show_on_incident_details": true,
"enabled": true,
"updated_at": "2025-07-12T00:15:56.055-07:00",
"created_at": "2025-07-12T00:15:56.055-07:00",
"options": [
{
"id": "efd6f446-84a9-4b93-a7e4-3b6dfe21481a",
"form_field_id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"value": "Omnis et est consequuntur.",
"color": "#FBE4A0",
"default": false,
"position": 1,
"updated_at": "2025-07-12T00:15:56.112-07:00",
"created_at": "2025-07-12T00:15:56.112-07:00"
},
{
"id": "1e358da7-c55a-44cd-a3e5-d6ee31efd5ff",
"form_field_id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"value": "Dolor ab sunt nesciunt.",
"color": "#FBE4A0",
"default": false,
"position": 2,
"updated_at": "2025-07-12T00:15:56.116-07:00",
"created_at": "2025-07-12T00:15:56.116-07:00"
}
],
"positions": [
{
"id": "c2738d85-bb08-4a4b-8b69-d314cfab7f8f",
"form_field_id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"form": "web_new_incident_form",
"position": 1
},
{
"id": "d35d7604-a04f-4fec-a68a-baed994009cd",
"form_field_id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"form": "slack_new_incident_form",
"position": 1
},
{
"id": "3f059180-1188-4a63-b6de-73c11b3fb271",
"form_field_id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"form": "web_update_incident_form",
"position": 1
},
{
"id": "9fa4a718-c951-41d9-a851-175cbaa2dc63",
"form_field_id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"form": "slack_update_incident_form",
"position": 1
}
]
},
"value": "Assumenda quam vitae qui.",
"selected_group_ids": [],
"selected_groups": {
"id": null,
"value": "Assumenda quam vitae qui."
},
"selected_option_ids": [],
"selected_options": {
"id": null,
"value": "Assumenda quam vitae qui."
},
"selected_service_ids": [],
"selected_services": {
"id": null,
"value": "Assumenda quam vitae qui."
},
"selected_functionality_ids": [],
"selected_functionalities": {
"id": null,
"value": "Assumenda quam vitae qui."
},
"selected_catalog_entity_ids": [],
"selected_catalog_entities": {
"id": null,
"value": "Assumenda quam vitae qui."
},
"selected_user_ids": [],
"selected_users": {
"id": null,
"value": "Assumenda quam vitae qui."
}
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_form_field_selection_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident form field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentFormFieldSelections"
],
"description": "Update a specific incident form field selection by id",
"operationId": "updateIncidentFormFieldSelection",
"parameters": [],
"responses": {
"200": {
"description": "incident_form_field_selection updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "699a3405-1585-4bab-813f-42207df57f5d",
"type": "incident_form_field_selections",
"attributes": {
"incident_id": "dc0ab3c2-16b2-47fd-b06b-3ea21832fa94",
"custom_field_id": 175,
"form_field_id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"form_field": {
"id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"team_id": 186,
"slug": "debitis-et-autem-sunt",
"kind": "custom",
"input_kind": "text",
"value_kind": "inherit",
"value_kind_catalog_id": null,
"name": "Debitis et autem sunt.",
"description": "Deserunt exercitationem eos voluptatibus.",
"shown": [
"web_new_incident_form",
"web_update_incident_form",
"slack_new_incident_form",
"slack_update_incident_form"
],
"required": [],
"default_values": [],
"show_on_incident_details": true,
"enabled": true,
"updated_at": "2025-07-12T00:15:56.055-07:00",
"created_at": "2025-07-12T00:15:56.055-07:00",
"options": [
{
"id": "efd6f446-84a9-4b93-a7e4-3b6dfe21481a",
"form_field_id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"value": "Omnis et est consequuntur.",
"color": "#FBE4A0",
"default": false,
"position": 1,
"updated_at": "2025-07-12T00:15:56.112-07:00",
"created_at": "2025-07-12T00:15:56.112-07:00"
},
{
"id": "1e358da7-c55a-44cd-a3e5-d6ee31efd5ff",
"form_field_id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"value": "Dolor ab sunt nesciunt.",
"color": "#FBE4A0",
"default": false,
"position": 2,
"updated_at": "2025-07-12T00:15:56.116-07:00",
"created_at": "2025-07-12T00:15:56.116-07:00"
}
],
"positions": [
{
"id": "c2738d85-bb08-4a4b-8b69-d314cfab7f8f",
"form_field_id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"form": "web_new_incident_form",
"position": 1
},
{
"id": "d35d7604-a04f-4fec-a68a-baed994009cd",
"form_field_id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"form": "slack_new_incident_form",
"position": 1
},
{
"id": "3f059180-1188-4a63-b6de-73c11b3fb271",
"form_field_id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"form": "web_update_incident_form",
"position": 1
},
{
"id": "9fa4a718-c951-41d9-a851-175cbaa2dc63",
"form_field_id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"form": "slack_update_incident_form",
"position": 1
}
]
},
"value": "Test update custom field",
"selected_group_ids": [],
"selected_groups": {
"id": null,
"value": "Test update custom field"
},
"selected_option_ids": [],
"selected_options": {
"id": null,
"value": "Test update custom field"
},
"selected_service_ids": [],
"selected_services": {
"id": null,
"value": "Test update custom field"
},
"selected_functionality_ids": [],
"selected_functionalities": {
"id": null,
"value": "Test update custom field"
},
"selected_catalog_entity_ids": [],
"selected_catalog_entities": {
"id": null,
"value": "Test update custom field"
},
"selected_user_ids": [],
"selected_users": {
"id": null,
"value": "Test update custom field"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_form_field_selection_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_form_field_selection"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident form field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentFormFieldSelections"
],
"description": "Delete a specific incident form field selection by id",
"operationId": "deleteIncidentFormFieldSelection",
"responses": {
"200": {
"description": "incident_form_field_selection deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "699a3405-1585-4bab-813f-42207df57f5d",
"type": "incident_form_field_selections",
"attributes": {
"incident_id": "dc0ab3c2-16b2-47fd-b06b-3ea21832fa94",
"custom_field_id": 175,
"form_field_id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"form_field": {
"id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"team_id": 186,
"slug": "debitis-et-autem-sunt",
"kind": "custom",
"input_kind": "text",
"value_kind": "inherit",
"value_kind_catalog_id": null,
"name": "Debitis et autem sunt.",
"description": "Deserunt exercitationem eos voluptatibus.",
"shown": [
"web_new_incident_form",
"web_update_incident_form",
"slack_new_incident_form",
"slack_update_incident_form"
],
"required": [],
"default_values": [],
"show_on_incident_details": true,
"enabled": true,
"updated_at": "2025-07-12T00:15:56.055-07:00",
"created_at": "2025-07-12T00:15:56.055-07:00",
"options": [
{
"id": "efd6f446-84a9-4b93-a7e4-3b6dfe21481a",
"form_field_id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"value": "Omnis et est consequuntur.",
"color": "#FBE4A0",
"default": false,
"position": 1,
"updated_at": "2025-07-12T00:15:56.112-07:00",
"created_at": "2025-07-12T00:15:56.112-07:00"
},
{
"id": "1e358da7-c55a-44cd-a3e5-d6ee31efd5ff",
"form_field_id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"value": "Dolor ab sunt nesciunt.",
"color": "#FBE4A0",
"default": false,
"position": 2,
"updated_at": "2025-07-12T00:15:56.116-07:00",
"created_at": "2025-07-12T00:15:56.116-07:00"
}
],
"positions": [
{
"id": "c2738d85-bb08-4a4b-8b69-d314cfab7f8f",
"form_field_id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"form": "web_new_incident_form",
"position": 1
},
{
"id": "d35d7604-a04f-4fec-a68a-baed994009cd",
"form_field_id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"form": "slack_new_incident_form",
"position": 1
},
{
"id": "3f059180-1188-4a63-b6de-73c11b3fb271",
"form_field_id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"form": "web_update_incident_form",
"position": 1
},
{
"id": "9fa4a718-c951-41d9-a851-175cbaa2dc63",
"form_field_id": "a2814266-6083-443e-bbe7-09b0919fc14c",
"form": "slack_update_incident_form",
"position": 1
}
]
},
"value": "Assumenda quam vitae qui.",
"selected_group_ids": [],
"selected_groups": {
"id": null,
"value": "Assumenda quam vitae qui."
},
"selected_option_ids": [],
"selected_options": {
"id": null,
"value": "Assumenda quam vitae qui."
},
"selected_service_ids": [],
"selected_services": {
"id": null,
"value": "Assumenda quam vitae qui."
},
"selected_functionality_ids": [],
"selected_functionalities": {
"id": null,
"value": "Assumenda quam vitae qui."
},
"selected_catalog_entity_ids": [],
"selected_catalog_entities": {
"id": null,
"value": "Assumenda quam vitae qui."
},
"selected_user_ids": [],
"selected_users": {
"id": null,
"value": "Assumenda quam vitae qui."
}
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_form_field_selection_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incident_permission_sets/{incident_permission_set_id}/booleans": {
"parameters": [
{
"name": "incident_permission_set_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an incident_permission_set_boolean",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSetBooleans"
],
"description": "Creates a new incident_permission_set_boolean from provided data",
"operationId": "createIncidentPermissionSetBoolean",
"parameters": [],
"responses": {
"201": {
"description": "incident_permission_set_boolean created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "918d09d2-e1a7-427d-9259-399ea8e6bf0b",
"type": "incident_permission_set_booleans",
"attributes": {
"incident_permission_set_id": "a32a1830-a427-4dec-9533-a666f90fc638",
"kind": "update_summary",
"private": false,
"enabled": false,
"updated_at": "2025-07-12T00:16:00.044-07:00",
"created_at": "2025-07-12T00:16:00.044-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_permission_set_boolean_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Kind can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_permission_set_boolean"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident_permission_set_booleans",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSetBooleans"
],
"description": "List incident_permission_set_booleans",
"operationId": "listIncidentPermissionSetBooleans",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_permission_set_boolean_list"
}
}
}
}
}
}
},
"/v1/incident_permission_set_booleans/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident_permission_set_boolean",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSetBooleans"
],
"description": "Retrieves a specific incident_permission_set_boolean by id",
"operationId": "getIncidentPermissionSetBoolean",
"responses": {
"200": {
"description": "incident_permission_set_boolean found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "058a2fdd-5eb9-4f5c-ae91-106a6c6f536c",
"type": "incident_permission_set_booleans",
"attributes": {
"incident_permission_set_id": "a43872ad-9f80-4d65-90a4-71ec41d4e9ad",
"kind": "update_summary",
"private": false,
"enabled": false,
"updated_at": "2025-07-12T00:16:02.418-07:00",
"created_at": "2025-07-12T00:16:02.418-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_permission_set_boolean_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident_permission_set_boolean",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSetBooleans"
],
"description": "Update a specific incident_permission_set_boolean by id",
"operationId": "updateIncidentPermissionSetBoolean",
"parameters": [],
"responses": {
"200": {
"description": "incident_permission_set_boolean updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "3f30b69d-6945-4f52-b888-17950efbf39e",
"type": "incident_permission_set_booleans",
"attributes": {
"incident_permission_set_id": "57fefb01-3532-4b83-a8e2-d7e59baff253",
"kind": "update_timeline",
"private": false,
"enabled": false,
"updated_at": "2025-07-12T00:16:04.817-07:00",
"created_at": "2025-07-12T00:16:04.680-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_permission_set_boolean_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_permission_set_boolean"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident_permission_set_boolean",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSetBooleans"
],
"description": "Delete a specific incident_permission_set_boolean by id",
"operationId": "deleteIncidentPermissionSetBoolean",
"responses": {
"200": {
"description": "incident_permission_set_boolean deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "8b8145dc-6bd4-4021-8e14-59168af830c5",
"type": "incident_permission_set_booleans",
"attributes": {
"incident_permission_set_id": "00865b8c-27d9-4129-ba0d-857c54316817",
"kind": "update_summary",
"private": false,
"enabled": false,
"updated_at": "2025-07-12T00:16:06.931-07:00",
"created_at": "2025-07-12T00:16:06.931-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_permission_set_boolean_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incident_permission_sets/{incident_permission_set_id}/resources": {
"parameters": [
{
"name": "incident_permission_set_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an incident_permission_set_resource",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSetResources"
],
"description": "Creates a new incident_permission_set_resource from provided data",
"operationId": "createIncidentPermissionSetResource",
"parameters": [],
"responses": {
"201": {
"description": "incident_permission_set_resource created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "3dc641bf-4384-4411-ac53-fa3373864260",
"type": "incident_permission_set_resources",
"attributes": {
"incident_permission_set_id": "0738d212-10e2-4fa1-af5c-d94654dc5eb2",
"kind": "incident_types",
"private": false,
"resource_id": "df1ba521-2ee0-4159-8be8-d7627588680e",
"resource_type": "IncidentType",
"updated_at": "2025-07-12T00:16:10.040-07:00",
"created_at": "2025-07-12T00:16:10.040-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_permission_set_resource_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Resource must exist",
"status": "422"
},
{
"title": "Kind can't be blank",
"status": "422"
},
{
"title": "Kind is not included in the list",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_permission_set_resource"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident_permission_set_resources",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSetResources"
],
"description": "List incident_permission_set_resources",
"operationId": "listIncidentPermissionSetResources",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_permission_set_resource_list"
}
}
}
}
}
}
},
"/v1/incident_permission_set_resources/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident_permission_set_resource",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSetResources"
],
"description": "Retrieves a specific incident_permission_set_resource by id",
"operationId": "getIncidentPermissionSetResource",
"responses": {
"200": {
"description": "incident_permission_set_resource found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "9e0555e1-bf86-4c46-9be6-c6d4b3fe6b83",
"type": "incident_permission_set_resources",
"attributes": {
"incident_permission_set_id": "0f00c35a-134a-4e00-8da9-ea58987cca73",
"kind": "incident_types",
"private": false,
"resource_id": "392f099a-17bb-4cd4-b5ce-fdcf1002363e",
"resource_type": "IncidentType",
"updated_at": "2025-07-12T00:16:12.444-07:00",
"created_at": "2025-07-12T00:16:12.444-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_permission_set_resource_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident_permission_set_resource",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSetResources"
],
"description": "Update a specific incident_permission_set_resource by id",
"operationId": "updateIncidentPermissionSetResource",
"parameters": [],
"responses": {
"200": {
"description": "incident_permission_set_resource updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "f779497e-0928-4a02-8c7e-0de852c10b39",
"type": "incident_permission_set_resources",
"attributes": {
"incident_permission_set_id": "43035c19-b481-4bdb-9832-de393ebc90e8",
"kind": "statuses",
"private": false,
"resource_id": "12859ef3-6b7a-44e5-963b-241c9a90c35d",
"resource_type": "IncidentType",
"updated_at": "2025-07-12T00:16:14.854-07:00",
"created_at": "2025-07-12T00:16:14.708-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_permission_set_resource_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_permission_set_resource"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident_permission_set_resource",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSetResources"
],
"description": "Delete a specific incident_permission_set_resource by id",
"operationId": "deleteIncidentPermissionSetResource",
"responses": {
"200": {
"description": "incident_permission_set_resource deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "bdfb18cb-b435-4c81-8850-b9020f019a0a",
"type": "incident_permission_set_resources",
"attributes": {
"incident_permission_set_id": "d5e0f303-66cc-47dd-9e2e-3432bde8a953",
"kind": "incident_types",
"private": false,
"resource_id": "646bd0fc-3510-4ff0-abd8-052d919ac7df",
"resource_type": "IncidentType",
"updated_at": "2025-07-12T00:16:17.024-07:00",
"created_at": "2025-07-12T00:16:17.024-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_permission_set_resource_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incident_permission_sets": {
"post": {
"summary": "Creates an incident_permission_set",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSets"
],
"description": "Creates a new incident_permission_set from provided data",
"operationId": "createIncidentPermissionSet",
"parameters": [],
"responses": {
"201": {
"description": "incident_permission_set created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "71e09923-3e18-41b7-846b-17718b55d8df",
"type": "incident_permission_sets",
"attributes": {
"team_id": 224,
"name": "Infrastructure",
"slug": "infrastructure",
"description": null,
"private_incident_permissions": [
"read"
],
"public_incident_permissions": [
"read"
],
"updated_at": "2025-07-12T00:16:21.882-07:00",
"created_at": "2025-07-12T00:16:21.882-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_permission_set_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_permission_set"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident_permission_sets",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSets"
],
"description": "List incident_permission_sets",
"operationId": "listIncidentPermissionSets",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_permission_set_list"
}
}
}
}
}
}
},
"/v1/incident_permission_sets/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident_permission_set",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSets"
],
"description": "Retrieves a specific incident_permission_set by id",
"operationId": "getIncidentPermissionSet",
"responses": {
"200": {
"description": "incident_permission_set found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "dfc5f257-3f39-43c4-b7ea-2351b265bdc8",
"type": "incident_permission_sets",
"attributes": {
"team_id": 227,
"name": "Omnis earum impedit sed.",
"slug": "omnis-earum-impedit-sed",
"description": "Voluptates voluptatem recusandae nobis.",
"private_incident_permissions": [
"read"
],
"public_incident_permissions": [
"read"
],
"updated_at": "2025-07-12T00:16:23.621-07:00",
"created_at": "2025-07-12T00:16:23.621-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_permission_set_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident_permission_set",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSets"
],
"description": "Update a specific incident_permission_set by id",
"operationId": "updateIncidentPermissionSet",
"parameters": [],
"responses": {
"200": {
"description": "incident_permission_set updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "1ff835cd-2fa3-4423-b7d2-92546ac62671",
"type": "incident_permission_sets",
"attributes": {
"team_id": 231,
"name": "Security",
"slug": "reiciendis-rerum-aut-consequuntur",
"description": "Adipisci aliquam aspernatur temporibus.",
"private_incident_permissions": [
"read"
],
"public_incident_permissions": [
"read"
],
"updated_at": "2025-07-12T00:16:26.085-07:00",
"created_at": "2025-07-12T00:16:25.897-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_permission_set_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_permission_set"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident_permission_set",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSets"
],
"description": "Delete a specific incident_permission_set by id",
"operationId": "deleteIncidentPermissionSet",
"responses": {
"200": {
"description": "incident_permission_set deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "cd89acda-98cb-4a5c-a2a5-b23e0af5fa1b",
"type": "incident_permission_sets",
"attributes": {
"team_id": 235,
"name": "Et debitis temporibus in.",
"slug": "et-debitis-temporibus-in",
"description": "Debitis voluptatum maxime quia.",
"private_incident_permissions": [
"read"
],
"public_incident_permissions": [
"read"
],
"updated_at": "2025-07-12T00:16:28.359-07:00",
"created_at": "2025-07-12T00:16:28.145-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_permission_set_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/post_mortems": {
"get": {
"summary": "List incident retrospectives",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRetrospectives"
],
"description": "List incident retrospectives",
"operationId": "listIncidentPostMortems",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[status]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[severity]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[type]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[user_id]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[environments]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[functionalities]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[services]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[teams]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[mitigated_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[mitigated_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[mitigated_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[mitigated_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[resolved_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[resolved_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[resolved_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[resolved_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_post_mortem_list"
}
}
}
}
}
}
},
"/v1/post_mortems/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident retrospective",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRetrospectives"
],
"description": "List incidents retrospectives",
"operationId": "ListIncidentPostmortem",
"responses": {
"200": {
"description": "incident_post_mortem found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "937f3c93-c1a7-4b96-a7f8-96d0333c7966",
"type": "incident_post_mortems",
"attributes": {
"incident_id": "2b025253-00d1-497a-85f0-41e3774c2782",
"title": "Nesciunt sunt eum consequatur.",
"status": "draft",
"url": "https://test.rootly.com/account/post_mortems/nesciunt-sunt-eum-consequatur",
"short_url": null,
"content": null,
"published_at": null,
"started_at": "2025-07-12T00:16:32.105-07:00",
"mitigated_at": null,
"resolved_at": null,
"cancelled_at": null,
"show_timeline": true,
"show_timeline_starred_only": false,
"show_timeline_genius": true,
"show_timeline_trail": true,
"show_timeline_tasks": true,
"show_timeline_action_items": true,
"show_timeline_order": "desc",
"show_functionalities_impacted": true,
"show_services_impacted": true,
"show_groups_impacted": true,
"show_action_items": true,
"created_at": "2025-07-12T00:16:32.605-07:00",
"updated_at": "2025-07-12T00:16:32.611-07:00"
},
"relationships": {
"incident_retrospective_steps": {
"data": [
{
"id": "75cda75f-ccb6-4ab8-a716-3035445de260",
"type": "incident_retrospective_steps"
}
]
}
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_post_mortem_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident retrospective",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRetrospectives"
],
"description": "Update a specific incident retrospective by id",
"operationId": "updateIncidentPostmortem",
"parameters": [],
"responses": {
"200": {
"description": "incident_post_mortem updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "937f3c93-c1a7-4b96-a7f8-96d0333c7966",
"type": "incident_post_mortems",
"attributes": {
"incident_id": "2b025253-00d1-497a-85f0-41e3774c2782",
"title": "Retrospective updated",
"status": "draft",
"url": "https://test.rootly.com/account/post_mortems/nesciunt-sunt-eum-consequatur",
"short_url": null,
"content": null,
"published_at": null,
"started_at": "2025-07-12T00:16:32.105-07:00",
"mitigated_at": null,
"resolved_at": null,
"cancelled_at": null,
"show_timeline": false,
"show_timeline_starred_only": false,
"show_timeline_genius": true,
"show_timeline_trail": true,
"show_timeline_tasks": true,
"show_timeline_action_items": true,
"show_timeline_order": "desc",
"show_functionalities_impacted": true,
"show_services_impacted": true,
"show_groups_impacted": true,
"show_action_items": true,
"created_at": "2025-07-12T00:16:32.605-07:00",
"updated_at": "2025-07-12T00:16:43.004-07:00"
},
"relationships": {
"incident_retrospective_steps": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_post_mortem_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_post_mortem"
}
}
},
"required": true
}
}
},
"/v1/incident_retrospective_steps/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident retrospective step",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRetrospectiveSteps"
],
"description": "Retrieves a specific incident retrospective step by id",
"operationId": "getIncidentRetrospectiveStep",
"responses": {
"200": {
"description": "incident retrospective_step found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "cd67944b-a666-45f6-a14f-28acd317ecc3",
"type": "incident_retrospective_steps",
"attributes": {
"retrospective_step_id": "55ee6967-edce-4ce0-860f-9aae553fe845",
"incident_id": "b7fbf4bb-e062-4d83-8de4-a4e0e9820767",
"title": "Step 4",
"description": null,
"due_date": null,
"user_id": null,
"kind": "custom",
"position": 1,
"skippable": false,
"status": "todo",
"status_changed_at": null,
"status_changed_by_id": null,
"created_at": "2025-07-12T00:16:44.718-07:00",
"updated_at": "2025-07-12T00:16:44.718-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_retrospective_step_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident retrospective step",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRetrospectiveSteps"
],
"description": "Update a specific incident retrospective step by id",
"operationId": "updateIncidentRetrospectiveStep",
"parameters": [],
"responses": {
"200": {
"description": "incident_retrospective_step updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "cd67944b-a666-45f6-a14f-28acd317ecc3",
"type": "incident_retrospective_steps",
"attributes": {
"retrospective_step_id": "55ee6967-edce-4ce0-860f-9aae553fe845",
"incident_id": "b7fbf4bb-e062-4d83-8de4-a4e0e9820767",
"title": "Step 2",
"description": "Step 2 description",
"due_date": "2024-12-05T08:10:58.323-08:00",
"user_id": null,
"kind": "custom",
"position": 2,
"skippable": true,
"status": "todo",
"status_changed_at": null,
"status_changed_by_id": null,
"created_at": "2025-07-12T00:16:44.718-07:00",
"updated_at": "2025-07-12T00:16:45.347-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_retrospective_step_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_retrospective_step"
}
}
},
"required": true
}
}
},
"/v1/incident_roles/{incident_role_id}/incident_role_tasks": {
"parameters": [
{
"name": "incident_role_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an incident role task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRoleTasks"
],
"description": "Creates a new task from provided data",
"operationId": "createIncidentRoleTask",
"parameters": [],
"responses": {
"201": {
"description": "incident_role_task created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "de89a561-73db-4aa8-8e47-7e28368810f2",
"type": "incident_role_tasks",
"attributes": {
"incident_role_id": "9ea96e51-1b51-488c-93e8-e88a4c154a90",
"task": "New task",
"description": "New task description",
"priority": "high",
"created_at": "2025-07-12T00:16:46.728-07:00",
"updated_at": "2025-07-12T00:16:46.728-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_role_task_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Task can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_role_task"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident role tasks",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRoleTasks"
],
"description": "List incident_role tasks",
"operationId": "listIncidentRoleTasks",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_role_task_list"
}
}
}
}
}
}
},
"/v1/incident_role_tasks/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident role task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRoleTasks"
],
"description": "Retrieves a specific incident_role_task by id",
"operationId": "getIncidentRoleTask",
"responses": {
"200": {
"description": "incident_role_task found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "61fd12d6-44d6-4039-a7ef-c588aea2ea40",
"type": "incident_role_tasks",
"attributes": {
"incident_role_id": "9ea96e51-1b51-488c-93e8-e88a4c154a90",
"task": "Autem veritatis est saepe.",
"description": "Recusandae perspiciatis maiores quia.",
"priority": "medium",
"created_at": "2025-07-12T00:16:46.577-07:00",
"updated_at": "2025-07-12T00:16:46.585-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_role_task_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident role task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRoleTasks"
],
"description": "Update a specific incident_role task by id",
"operationId": "updateIncidentRoleTask",
"parameters": [],
"responses": {
"200": {
"description": "incident_role_task updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "61fd12d6-44d6-4039-a7ef-c588aea2ea40",
"type": "incident_role_tasks",
"attributes": {
"incident_role_id": "9ea96e51-1b51-488c-93e8-e88a4c154a90",
"task": "Task updated",
"description": "Task description updated",
"priority": "medium",
"created_at": "2025-07-12T00:16:46.577-07:00",
"updated_at": "2025-07-12T00:16:48.395-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_role_task_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_role_task"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident role task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRoleTasks"
],
"description": "Delete a specific incident_role task by id",
"operationId": "deleteIncidentRoleTask",
"responses": {
"200": {
"description": "incident_role_task deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "61fd12d6-44d6-4039-a7ef-c588aea2ea40",
"type": "incident_role_tasks",
"attributes": {
"incident_role_id": "9ea96e51-1b51-488c-93e8-e88a4c154a90",
"task": "Autem veritatis est saepe.",
"description": "Recusandae perspiciatis maiores quia.",
"priority": "medium",
"created_at": "2025-07-12T00:16:46.577-07:00",
"updated_at": "2025-07-12T00:16:48.883-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_role_task_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incident_roles": {
"post": {
"summary": "Creates an incident role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRoles"
],
"description": "Creates a new incident role from provided data",
"operationId": "createIncidentRole",
"parameters": [],
"responses": {
"201": {
"description": "incident_role created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "1f707a8d-a5f5-4d0d-8d51-2fb2a13355a6",
"type": "incident_roles",
"attributes": {
"slug": "my-incident-role",
"name": "My Incident Role",
"summary": "My Incident Role summary",
"description": "My Incident Role description",
"position": 1,
"optional": false,
"enabled": true,
"allow_multi_user_assignment": true,
"created_at": "2025-07-12T00:16:51.899-07:00",
"updated_at": "2025-07-12T00:16:51.899-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_role_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_role"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident roles",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRoles"
],
"description": "List incident roles",
"operationId": "listIncidentRoles",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[enabled]",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_role_list"
}
}
}
}
}
}
},
"/v1/incident_roles/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRoles"
],
"description": "Retrieves a specific incident_role by id",
"operationId": "getIncidentRole",
"responses": {
"200": {
"description": "incident_role found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "e85ed053-07b3-4a8d-a6c3-75e2d33e8d68",
"type": "incident_roles",
"attributes": {
"slug": "fuga-velit-corrupti-ipsam",
"name": "Fuga velit corrupti ipsam.",
"summary": null,
"description": null,
"position": 1,
"optional": false,
"enabled": true,
"allow_multi_user_assignment": false,
"created_at": "2025-07-12T00:16:50.043-07:00",
"updated_at": "2025-07-12T00:16:50.044-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_role_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRoles"
],
"description": "Update a specific incident_role by id",
"operationId": "updateIncidentRole",
"parameters": [],
"responses": {
"200": {
"description": "incident_role updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "e85ed053-07b3-4a8d-a6c3-75e2d33e8d68",
"type": "incident_roles",
"attributes": {
"slug": "my-incident-role-updated",
"name": "My Incident Role Updated",
"summary": "My Incident Role Summary Updated",
"description": "My Incident Role Description Updated",
"position": 2,
"optional": true,
"enabled": true,
"allow_multi_user_assignment": false,
"created_at": "2025-07-12T00:16:50.043-07:00",
"updated_at": "2025-07-12T00:16:52.953-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_role_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_role"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRoles"
],
"description": "Delete a specific incident_role by id",
"operationId": "deleteIncidentRole",
"responses": {
"200": {
"description": "incident_role deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "e85ed053-07b3-4a8d-a6c3-75e2d33e8d68",
"type": "incident_roles",
"attributes": {
"slug": "fuga-velit-corrupti-ipsam",
"name": "Fuga velit corrupti ipsam.",
"summary": null,
"description": null,
"position": 1,
"optional": false,
"enabled": true,
"allow_multi_user_assignment": false,
"created_at": "2025-07-12T00:16:50.043-07:00",
"updated_at": "2025-07-12T00:16:53.433-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_role_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incidents/{incident_id}/status-page-events": {
"parameters": [
{
"name": "incident_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an incident status page event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentStatusPageEvents"
],
"description": "Creates a new event from provided data",
"operationId": "createIncidentStatusPage",
"parameters": [],
"responses": {
"201": {
"description": "incident_status_page_event created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "982d6d2a-842d-44db-881d-3784be748db3",
"type": "incident_status_page_events",
"attributes": {
"incident_id": "033f6248-39e0-4704-a2dc-c116b58b26cd",
"status_page_id": "8ae44a48-26f6-4183-bacb-350b86f77527",
"status": "investigating",
"notify_subscribers": true,
"should_tweet": false,
"started_at": "2025-07-12T00:16:55.346-07:00",
"created_at": "2025-07-12T00:16:55.346-07:00",
"updated_at": "2025-07-12T00:16:55.346-07:00",
"event": "New Event"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_status_page_event_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Status page must exist",
"status": "422"
},
{
"title": "Event can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_status_page_event"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident status page events",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentStatusPageEvents"
],
"description": "List incident status page events",
"operationId": "listIncidentStatusPages",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_status_page_event_list"
}
}
}
}
}
}
},
"/v1/status-page-events/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident status page event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentStatusPageEvents"
],
"description": "Retrieves a specific incident_status_page_event by id",
"operationId": "getIncidentStatusPages",
"responses": {
"200": {
"description": "incident_status_page_event found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "8595d286-69a6-486f-9123-68fe157cdb37",
"type": "incident_status_page_events",
"attributes": {
"incident_id": "033f6248-39e0-4704-a2dc-c116b58b26cd",
"status_page_id": "8ae44a48-26f6-4183-bacb-350b86f77527",
"status": "investigating",
"notify_subscribers": false,
"should_tweet": false,
"started_at": "2025-07-12T00:16:55.095-07:00",
"created_at": "2025-07-12T00:16:55.095-07:00",
"updated_at": "2025-07-12T00:16:55.095-07:00",
"event": "Voluptatem consequatur minima eveniet."
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_status_page_event_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident status page event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentStatusPageEvents"
],
"description": "Update a specific incident status page event by id",
"operationId": "updateIncidentStatusPage",
"parameters": [],
"responses": {
"200": {
"description": "incident_status_page_event updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "8595d286-69a6-486f-9123-68fe157cdb37",
"type": "incident_status_page_events",
"attributes": {
"incident_id": "033f6248-39e0-4704-a2dc-c116b58b26cd",
"status_page_id": "8f4b9490-e056-4182-80d3-36a9c7bf5bcf",
"status": "investigating",
"notify_subscribers": false,
"should_tweet": false,
"started_at": "2025-07-12T00:16:55.095-07:00",
"created_at": "2025-07-12T00:16:55.095-07:00",
"updated_at": "2025-07-12T00:16:56.629-07:00",
"event": "Event updated"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_status_page_event_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_status_page_event"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident status page event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentStatusPageEvents"
],
"description": "Delete a specific incident status page event by id",
"operationId": "deleteIncidentStatusPage",
"responses": {
"200": {
"description": "incident_status_page_event deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "8595d286-69a6-486f-9123-68fe157cdb37",
"type": "incident_status_page_events",
"attributes": {
"incident_id": "033f6248-39e0-4704-a2dc-c116b58b26cd",
"status_page_id": "8ae44a48-26f6-4183-bacb-350b86f77527",
"status": "investigating",
"notify_subscribers": false,
"should_tweet": false,
"started_at": "2025-07-12T00:16:55.095-07:00",
"created_at": "2025-07-12T00:16:55.095-07:00",
"updated_at": "2025-07-12T00:16:57.724-07:00",
"event": "Voluptatem consequatur minima eveniet."
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_status_page_event_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incidents/{incident_id}/sub_statuses": {
"parameters": [
{
"name": "incident_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a sub-status assignment",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentSubStatuses"
],
"description": "Creates a new sub-status assignment from provided data",
"operationId": "createIncidentSubStatus",
"parameters": [],
"responses": {
"201": {
"description": "incident_sub_status created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "d50d8190-f744-42d3-84be-33b44013dc7a",
"type": "incident_sub_statuses",
"attributes": {
"sub_status_id": "7ab707ea-6dd9-436f-bb52-8cdf69d02712",
"incident_id": "bcbe8cb9-42be-4369-a8e0-50023fe927f2",
"assigned_at": "2025-07-12T00:16:59.000-07:00",
"assigned_by_user_id": null
},
"relationships": {
"sub_status": {
"data": {
"id": "7ab707ea-6dd9-436f-bb52-8cdf69d02712",
"type": "sub_statuses"
}
},
"assigned_by_user": {
"data": null
}
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_sub_status_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_sub_status"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident_sub_statuses",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentSubStatuses"
],
"description": "List incident_sub_statuses",
"operationId": "listIncidentSubStatuses",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: sub_status,assigned_by_user",
"schema": {
"type": "string",
"enum": [
"sub_status",
"assigned_by_user"
]
},
"required": false
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at",
"assigned_at",
"-assigned_at"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[sub_status_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[assigned_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[assigned_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[assigned_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[assigned_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_sub_status_list"
}
}
}
}
}
}
},
"/v1/incident_sub_statuses/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves incident_sub_status",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentSubStatuses"
],
"description": "Retrieves a specific incident_sub_status by id",
"operationId": "getIncidentSubStatus",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: sub_status,assigned_by_user",
"schema": {
"type": "string",
"enum": [
"sub_status",
"assigned_by_user"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "sub_status found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "2d2bc226-be1f-49ec-9929-578f4d327aa9",
"type": "incident_sub_statuses",
"attributes": {
"sub_status_id": "485e483a-15da-432e-bbc5-891af108b288",
"incident_id": "bcbe8cb9-42be-4369-a8e0-50023fe927f2",
"assigned_at": "2025-07-12T00:16:59.233-07:00",
"assigned_by_user_id": 296
},
"relationships": {
"sub_status": {
"data": {
"id": "485e483a-15da-432e-bbc5-891af108b288",
"type": "sub_statuses"
}
},
"assigned_by_user": {
"data": {
"id": "296",
"type": "users"
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_sub_status_response"
}
}
}
}
}
},
"put": {
"summary": "Update incident_sub_status",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentSubStatuses"
],
"description": "Update a specific incident_sub_status by id",
"operationId": "updateIncidentSubStatus",
"parameters": [],
"responses": {
"200": {
"description": "incident_sub_status updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "2d2bc226-be1f-49ec-9929-578f4d327aa9",
"type": "incident_sub_statuses",
"attributes": {
"sub_status_id": "485e483a-15da-432e-bbc5-891af108b288",
"incident_id": "bcbe8cb9-42be-4369-a8e0-50023fe927f2",
"assigned_at": "2025-07-12T00:17:00.000-07:00",
"assigned_by_user_id": 296
},
"relationships": {
"sub_status": {
"data": {
"id": "485e483a-15da-432e-bbc5-891af108b288",
"type": "sub_statuses"
}
},
"assigned_by_user": {
"data": {
"id": "296",
"type": "users"
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_sub_status_response"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_sub_status"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident_sub_status",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentSubStatuses"
],
"description": "Delete a specific incident_sub_status by id",
"operationId": "deleteIncidentSubStatus",
"responses": {
"200": {
"description": "incident_sub_status deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "2d2bc226-be1f-49ec-9929-578f4d327aa9",
"type": "incident_sub_statuses",
"attributes": {
"sub_status_id": "485e483a-15da-432e-bbc5-891af108b288",
"incident_id": "bcbe8cb9-42be-4369-a8e0-50023fe927f2",
"assigned_at": "2025-07-12T00:16:59.233-07:00",
"assigned_by_user_id": 296
},
"relationships": {
"sub_status": {
"data": {
"id": "485e483a-15da-432e-bbc5-891af108b288",
"type": "sub_statuses"
}
},
"assigned_by_user": {
"data": {
"id": "296",
"type": "users"
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_sub_status_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incident_types": {
"post": {
"summary": "Creates an incident type",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentTypes"
],
"description": "Creates a new incident_type from provided data",
"operationId": "createIncidentType",
"parameters": [],
"responses": {
"201": {
"description": "incident_type created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "04f0e674-fc2b-4b13-81ec-388e9325a9d0",
"type": "incident_types",
"attributes": {
"slug": "bug",
"name": "Bug",
"description": "Bug caused by a human",
"color": "#FFF",
"position": 1,
"notify_emails": [
"hello@rootly.com",
"world@rootly.com"
],
"slack_channels": [
{
"id": "C03MKDSEJE8",
"name": "elastisearch"
}
],
"slack_aliases": [
{
"id": "S03F7QUV7F1",
"name": "leadership"
}
],
"created_at": "2025-07-12T00:17:04.000-07:00",
"updated_at": "2025-07-12T00:17:04.000-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_type_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_type"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident types",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentTypes"
],
"description": "List incident types",
"operationId": "listIncident Types",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_type_list"
}
}
}
}
}
}
},
"/v1/incident_types/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident type",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentTypes"
],
"description": "Retrieves a specific incident_type by id",
"operationId": "getIncidentType",
"responses": {
"200": {
"description": "incident_type found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "bbde8ea2-6113-4ffa-8861-f4b8b23be49b",
"type": "incident_types",
"attributes": {
"slug": "minus-laborum-voluptates-cumque",
"name": "Minus laborum voluptates cumque.",
"description": "Dolores mollitia pariatur iure.",
"color": "#FAEBB7",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-07-12T00:17:02.160-07:00",
"updated_at": "2025-07-12T00:17:02.160-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_type_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident type",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentTypes"
],
"description": "Update a specific incident_type by id",
"operationId": "updateIncidentType",
"parameters": [],
"responses": {
"200": {
"description": "incident_type updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "bbde8ea2-6113-4ffa-8861-f4b8b23be49b",
"type": "incident_types",
"attributes": {
"slug": "p1",
"name": "P1",
"description": "Medium Priority",
"color": "#000",
"position": 2,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-07-12T00:17:02.160-07:00",
"updated_at": "2025-07-12T00:17:05.038-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_type_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_type"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident type",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentTypes"
],
"description": "Delete a specific incident_type by id",
"operationId": "deleteIncidentType",
"responses": {
"200": {
"description": "incident_type deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "bbde8ea2-6113-4ffa-8861-f4b8b23be49b",
"type": "incident_types",
"attributes": {
"slug": "minus-laborum-voluptates-cumque",
"name": "Minus laborum voluptates cumque.",
"description": "Dolores mollitia pariatur iure.",
"color": "#FAEBB7",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-07-12T00:17:02.160-07:00",
"updated_at": "2025-07-12T00:17:05.523-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_type_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incidents": {
"post": {
"summary": "Creates an incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Creates a new incident from provided data",
"operationId": "createIncident",
"parameters": [],
"responses": {
"201": {
"description": "incident created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "9d51b389-0b28-4b1f-b0ef-519708ba6c9d",
"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": "299",
"type": "users",
"attributes": {
"name": "Krystin Adams",
"email": "vikki.ryan@heathcote.test",
"phone": null,
"phone_2": null,
"first_name": "Krystin",
"last_name": "Adams",
"full_name": "Krystin Adams",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Krystin Adams",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:18.387-07:00",
"created_at": "2025-07-12T00:17:05.857-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "138e3803-211a-412e-8dfd-cd00a4b89216",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"severity": {
"data": {
"id": "1ab79204-4bc5-4f0c-abec-69197df18eb0",
"type": "severities",
"attributes": {
"name": "7m2hx",
"slug": "7m2hx",
"description": "Temporibus sint autem dicta.",
"severity": "medium",
"color": "#E58A1F",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-07-12T00:17:12.601-07:00",
"updated_at": "2025-07-12T00:17:12.601-07:00"
}
}
},
"in_triage_by": null,
"started_by": {
"data": {
"id": "299",
"type": "users",
"attributes": {
"name": "Krystin Adams",
"email": "vikki.ryan@heathcote.test",
"phone": null,
"phone_2": null,
"first_name": "Krystin",
"last_name": "Adams",
"full_name": "Krystin Adams",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Krystin Adams",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:18.387-07:00",
"created_at": "2025-07-12T00:17:05.857-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "138e3803-211a-412e-8dfd-cd00a4b89216",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"mitigated_by": null,
"resolved_by": null,
"closed_by": null,
"cancelled_by": null,
"mitigation_message": null,
"resolution_message": null,
"cancellation_message": null,
"public_title": "Public incident notification",
"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": "incident-response",
"slack_channel_id": "C123456789",
"slack_channel_url": "https://team.slack.com/channels/incident-response",
"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": "https://docs.google.com/document/d/1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
"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-07-12T00:17:18.572-07:00",
"detected_at": null,
"acknowledged_at": null,
"mitigated_at": null,
"resolved_at": null,
"closed_at": null,
"cancelled_at": null,
"created_at": "2025-07-12T00:17:18.628-07:00",
"updated_at": "2025-07-12T00:17:18.774-07:00",
"labels": {
"platform": "windows",
"version": "1.12",
"CaseSensitive": "preserve"
}
},
"relationships": {
"causes": {
"data": [
{
"id": "eec5ca13-5dda-4557-9a7f-c046de1e2e13",
"type": "causes"
},
{
"id": "06c3c868-96b6-43a3-a910-c3521663041f",
"type": "causes"
}
]
},
"subscribers": {
"data": []
},
"roles": {
"data": [
{
"id": "6c3f0b9b-bcd7-4d66-9ec3-688dc9cd444a",
"type": "incident_role_assignments"
}
]
},
"environments": {
"data": [
{
"id": "a3e51ee9-812a-4f97-a174-350f1929295b",
"type": "environments"
},
{
"id": "9506b036-6628-4b67-94d0-cc406ffd7f53",
"type": "environments"
}
]
},
"incident_types": {
"data": [
{
"id": "e89d6aae-342d-4b62-9490-b4fd3ac8147f",
"type": "incident_types"
},
{
"id": "ce24deef-e682-4e5c-a61c-afc7c20ba504",
"type": "incident_types"
}
]
},
"services": {
"data": [
{
"id": "8f6ffbe4-5908-4704-9dc3-fbe64e11b29e",
"type": "services"
},
{
"id": "7251287e-63ad-4c7d-9857-7b9018e45f05",
"type": "services"
}
]
},
"functionalities": {
"data": [
{
"id": "acfd15b7-7502-4ea2-b63a-8f5f39e7c6d2",
"type": "functionalities"
},
{
"id": "d61b5504-f551-4dec-9819-37c796a128bf",
"type": "functionalities"
}
]
},
"groups": {
"data": [
{
"id": "77649dd2-9406-4c88-abbe-9df5b8a2f02c",
"type": "groups"
},
{
"id": "07c75078-ca8f-4dac-9f29-40ae6c3cfa17",
"type": "groups"
}
]
},
"events": {
"data": [
{
"id": "d89c47d5-8768-41a9-a04b-694b2484e327",
"type": "incident_events"
},
{
"id": "2393e57c-cfc3-49f8-8a6b-dd2d2a675f96",
"type": "incident_events"
},
{
"id": "e99851f9-571d-44ed-9bad-3fe26ed4f6f6",
"type": "incident_events"
},
{
"id": "aea8cc63-c8de-49f9-8a2c-0512d69d1504",
"type": "incident_events"
}
]
},
"action_items": {
"data": []
},
"custom_field_selections": {
"data": []
},
"feedbacks": {
"data": []
},
"attachments": {
"data": []
},
"slack_messages": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"422": {
"description": "invalid causes association",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Detected at can not be before Started time",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident"
}
}
},
"required": true
}
},
"get": {
"summary": "List incidents",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "List incidents",
"operationId": "listIncidents",
"parameters": [
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[status]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[private]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[user_id]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[severity]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[severity_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[labels]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[types]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[type_ids]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environments]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environment_ids]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[functionalities]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[functionality_ids]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[services]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[service_ids]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[teams]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[team_ids]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[cause]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[cause_ids]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[custom_field_selected_option_ids]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[updated_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[updated_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[updated_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[updated_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[detected_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[detected_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[detected_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[detected_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[acknowledged_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[acknowledged_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[acknowledged_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[acknowledged_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[mitigated_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[mitigated_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[mitigated_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[mitigated_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[resolved_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[resolved_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[resolved_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[resolved_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[closed_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[closed_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[closed_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[closed_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[in_triage_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[in_triage_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[in_triage_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[in_triage_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at"
]
},
"required": false
},
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: sub_statuses,causes,subscribers",
"schema": {
"type": "string",
"enum": [
"sub_statuses",
"causes",
"subscribers",
"roles",
"slack_messages",
"environments",
"incident_types",
"services",
"functionalities",
"groups",
"events",
"action_items",
"custom_field_selections",
"feedbacks",
"incident_post_mortem"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_list"
}
}
}
}
}
}
},
"/v1/incidents/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Retrieves a specific incident by id",
"operationId": "getIncident",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: sub_statuses,causes,subscribers",
"schema": {
"type": "string",
"enum": [
"sub_statuses",
"causes",
"subscribers",
"roles",
"slack_messages",
"environments",
"incident_types",
"services",
"functionalities",
"groups",
"events",
"action_items",
"custom_field_selections",
"feedbacks",
"incident_post_mortem"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "incident found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "8150262f-a6e3-4561-8751-42cddc5daf2a",
"type": "incidents",
"attributes": {
"parent_incident_id": null,
"sequential_id": 1,
"title": "Est tempora maxime placeat.",
"slug": "est-tempora-maxime-placeat",
"kind": "normal",
"private": false,
"summary": "Distinctio quis numquam. Voluptas quasi fuga. Et iure voluptatem.",
"status": "started",
"source": "web",
"url": "http://localhost:3001/account/incidents/1-est-tempora-maxime-placeat",
"short_url": null,
"user": {
"data": {
"id": "301",
"type": "users",
"attributes": {
"name": "Saul Beatty",
"email": "allan@senger.test",
"phone": null,
"phone_2": null,
"first_name": "Saul",
"last_name": "Beatty",
"full_name": "Saul Beatty",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Saul Beatty",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:07.074-07:00",
"created_at": "2025-07-12T00:17:06.659-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a7cbfb37-6519-4a7c-85f5-e5d38aa39aa6",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"severity": {
"data": {
"id": "41269138-eeb5-4555-acdd-f9940411fc9d",
"type": "severities",
"attributes": {
"name": "vzps3",
"slug": "vzps3",
"description": "Soluta deserunt ex dolorum.",
"severity": "medium",
"color": "#E58A1F",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-07-12T00:17:07.035-07:00",
"updated_at": "2025-07-12T00:17:07.035-07:00"
}
}
},
"in_triage_by": null,
"started_by": {
"data": {
"id": "301",
"type": "users",
"attributes": {
"name": "Saul Beatty",
"email": "allan@senger.test",
"phone": null,
"phone_2": null,
"first_name": "Saul",
"last_name": "Beatty",
"full_name": "Saul Beatty",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Saul Beatty",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:07.074-07:00",
"created_at": "2025-07-12T00:17:06.659-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a7cbfb37-6519-4a7c-85f5-e5d38aa39aa6",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_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-07-12T00:17:07.042-07:00",
"detected_at": null,
"acknowledged_at": null,
"mitigated_at": null,
"resolved_at": null,
"closed_at": null,
"cancelled_at": null,
"created_at": "2025-07-12T00:17:07.042-07:00",
"updated_at": "2025-07-12T00:17:07.124-07:00",
"labels": {}
},
"relationships": {
"causes": {
"data": []
},
"subscribers": {
"data": []
},
"roles": {
"data": []
},
"environments": {
"data": []
},
"incident_types": {
"data": []
},
"services": {
"data": []
},
"functionalities": {
"data": []
},
"groups": {
"data": []
},
"events": {
"data": [
{
"id": "7adaedaa-57e4-4d07-b5ef-46745ff3ccbf",
"type": "incident_events"
},
{
"id": "522cd81f-72ff-4edd-bba1-1b497f471f3c",
"type": "incident_events"
}
]
},
"action_items": {
"data": []
},
"custom_field_selections": {
"data": []
},
"feedbacks": {
"data": []
},
"attachments": {
"data": []
},
"slack_messages": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Update a specific incident by id",
"operationId": "updateIncident",
"parameters": [],
"responses": {
"200": {
"description": "incident updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "8150262f-a6e3-4561-8751-42cddc5daf2a",
"type": "incidents",
"attributes": {
"parent_incident_id": null,
"sequential_id": 1,
"title": "Oh no! Something is broken again",
"slug": "est-tempora-maxime-placeat",
"kind": "normal",
"private": true,
"summary": "What could it be again?",
"status": "started",
"source": "web",
"url": "http://localhost:3001/account/incidents/1-est-tempora-maxime-placeat",
"short_url": null,
"user": {
"data": {
"id": "301",
"type": "users",
"attributes": {
"name": "Saul Beatty",
"email": "allan@senger.test",
"phone": null,
"phone_2": null,
"first_name": "Saul",
"last_name": "Beatty",
"full_name": "Saul Beatty",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Saul Beatty",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:07.074-07:00",
"created_at": "2025-07-12T00:17:06.659-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a7cbfb37-6519-4a7c-85f5-e5d38aa39aa6",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"severity": {
"data": {
"id": "41269138-eeb5-4555-acdd-f9940411fc9d",
"type": "severities",
"attributes": {
"name": "vzps3",
"slug": "vzps3",
"description": "Soluta deserunt ex dolorum.",
"severity": "medium",
"color": "#E58A1F",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-07-12T00:17:07.035-07:00",
"updated_at": "2025-07-12T00:17:07.035-07:00"
}
}
},
"in_triage_by": null,
"started_by": {
"data": {
"id": "301",
"type": "users",
"attributes": {
"name": "Saul Beatty",
"email": "allan@senger.test",
"phone": null,
"phone_2": null,
"first_name": "Saul",
"last_name": "Beatty",
"full_name": "Saul Beatty",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Saul Beatty",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:07.074-07:00",
"created_at": "2025-07-12T00:17:06.659-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a7cbfb37-6519-4a7c-85f5-e5d38aa39aa6",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"mitigated_by": null,
"resolved_by": null,
"closed_by": null,
"cancelled_by": null,
"mitigation_message": null,
"resolution_message": null,
"cancellation_message": null,
"public_title": "Updated public title",
"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": "updated-incident-channel",
"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": "https://docs.google.com/document/d/updated",
"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-07-12T00:17:07.042-07:00",
"detected_at": null,
"acknowledged_at": null,
"mitigated_at": null,
"resolved_at": null,
"closed_at": null,
"cancelled_at": null,
"created_at": "2025-07-12T00:17:07.042-07:00",
"updated_at": "2025-07-12T00:17:22.979-07:00",
"labels": {}
},
"relationships": {
"causes": {
"data": []
},
"subscribers": {
"data": []
},
"roles": {
"data": []
},
"environments": {
"data": []
},
"incident_types": {
"data": []
},
"services": {
"data": []
},
"functionalities": {
"data": []
},
"groups": {
"data": []
},
"events": {
"data": [
{
"id": "2f9a48d3-a87b-42be-ab6f-412f6b1660ed",
"type": "incident_events"
},
{
"id": "a6910fee-7847-47ff-bd50-b2ac7a8ab6dc",
"type": "incident_events"
},
{
"id": "7adaedaa-57e4-4d07-b5ef-46745ff3ccbf",
"type": "incident_events"
},
{
"id": "522cd81f-72ff-4edd-bba1-1b497f471f3c",
"type": "incident_events"
}
]
},
"action_items": {
"data": []
},
"custom_field_selections": {
"data": []
},
"feedbacks": {
"data": []
},
"attachments": {
"data": []
},
"slack_messages": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Delete a specific incident by id",
"operationId": "deleteIncident",
"responses": {
"200": {
"description": "incident deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "8150262f-a6e3-4561-8751-42cddc5daf2a",
"type": "incidents",
"attributes": {
"parent_incident_id": null,
"sequential_id": 1,
"title": "Est tempora maxime placeat.",
"slug": "est-tempora-maxime-placeat",
"kind": "normal",
"private": false,
"summary": "Distinctio quis numquam. Voluptas quasi fuga. Et iure voluptatem.",
"status": "started",
"source": "web",
"url": "http://localhost:3001/account/incidents/1-est-tempora-maxime-placeat",
"short_url": null,
"user": {
"data": {
"id": "301",
"type": "users",
"attributes": {
"name": "Saul Beatty",
"email": "allan@senger.test",
"phone": null,
"phone_2": null,
"first_name": "Saul",
"last_name": "Beatty",
"full_name": "Saul Beatty",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Saul Beatty",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:07.074-07:00",
"created_at": "2025-07-12T00:17:06.659-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a7cbfb37-6519-4a7c-85f5-e5d38aa39aa6",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"severity": {
"data": {
"id": "41269138-eeb5-4555-acdd-f9940411fc9d",
"type": "severities",
"attributes": {
"name": "vzps3",
"slug": "vzps3",
"description": "Soluta deserunt ex dolorum.",
"severity": "medium",
"color": "#E58A1F",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-07-12T00:17:07.035-07:00",
"updated_at": "2025-07-12T00:17:07.035-07:00"
}
}
},
"in_triage_by": null,
"started_by": {
"data": {
"id": "301",
"type": "users",
"attributes": {
"name": "Saul Beatty",
"email": "allan@senger.test",
"phone": null,
"phone_2": null,
"first_name": "Saul",
"last_name": "Beatty",
"full_name": "Saul Beatty",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Saul Beatty",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:07.074-07:00",
"created_at": "2025-07-12T00:17:06.659-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a7cbfb37-6519-4a7c-85f5-e5d38aa39aa6",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_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-07-12T00:17:07.042-07:00",
"detected_at": null,
"acknowledged_at": null,
"mitigated_at": null,
"resolved_at": null,
"closed_at": null,
"cancelled_at": null,
"created_at": "2025-07-12T00:17:07.042-07:00",
"updated_at": "2025-07-12T00:17:23.909-07:00",
"labels": {}
},
"relationships": {
"causes": {
"data": []
},
"subscribers": {
"data": []
},
"roles": {
"data": []
},
"environments": {
"data": []
},
"incident_types": {
"data": []
},
"services": {
"data": []
},
"functionalities": {
"data": []
},
"groups": {
"data": []
},
"events": {
"data": [
{
"id": "7adaedaa-57e4-4d07-b5ef-46745ff3ccbf",
"type": "incident_events"
},
{
"id": "522cd81f-72ff-4edd-bba1-1b497f471f3c",
"type": "incident_events"
}
]
},
"action_items": {
"data": []
},
"custom_field_selections": {
"data": []
},
"feedbacks": {
"data": []
},
"attachments": {
"data": []
},
"slack_messages": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incidents/{id}/mitigate": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"put": {
"summary": "Mitigate an incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Mitigate a specific incident by id",
"operationId": "mitigateIncident",
"parameters": [],
"responses": {
"200": {
"description": "incident mitigated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "8150262f-a6e3-4561-8751-42cddc5daf2a",
"type": "incidents",
"attributes": {
"parent_incident_id": null,
"sequential_id": 1,
"title": "Est tempora maxime placeat.",
"slug": "est-tempora-maxime-placeat",
"kind": "normal",
"private": false,
"summary": "Distinctio quis numquam. Voluptas quasi fuga. Et iure voluptatem.",
"status": "mitigated",
"source": "web",
"url": "http://localhost:3001/account/incidents/1-est-tempora-maxime-placeat",
"short_url": null,
"user": {
"data": {
"id": "301",
"type": "users",
"attributes": {
"name": "Saul Beatty",
"email": "allan@senger.test",
"phone": null,
"phone_2": null,
"first_name": "Saul",
"last_name": "Beatty",
"full_name": "Saul Beatty",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Saul Beatty",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:07.074-07:00",
"created_at": "2025-07-12T00:17:06.659-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a7cbfb37-6519-4a7c-85f5-e5d38aa39aa6",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"severity": {
"data": {
"id": "41269138-eeb5-4555-acdd-f9940411fc9d",
"type": "severities",
"attributes": {
"name": "vzps3",
"slug": "vzps3",
"description": "Soluta deserunt ex dolorum.",
"severity": "medium",
"color": "#E58A1F",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-07-12T00:17:07.035-07:00",
"updated_at": "2025-07-12T00:17:07.035-07:00"
}
}
},
"in_triage_by": null,
"started_by": {
"data": {
"id": "301",
"type": "users",
"attributes": {
"name": "Saul Beatty",
"email": "allan@senger.test",
"phone": null,
"phone_2": null,
"first_name": "Saul",
"last_name": "Beatty",
"full_name": "Saul Beatty",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Saul Beatty",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:07.074-07:00",
"created_at": "2025-07-12T00:17:06.659-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a7cbfb37-6519-4a7c-85f5-e5d38aa39aa6",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"mitigated_by": {
"data": {
"id": "299",
"type": "users",
"attributes": {
"name": "Krystin Adams",
"email": "vikki.ryan@heathcote.test",
"phone": null,
"phone_2": null,
"first_name": "Krystin",
"last_name": "Adams",
"full_name": "Krystin Adams",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Krystin Adams",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:24.602-07:00",
"created_at": "2025-07-12T00:17:05.857-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "138e3803-211a-412e-8dfd-cd00a4b89216",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"resolved_by": null,
"closed_by": null,
"cancelled_by": null,
"mitigation_message": "Restart database fixed it!",
"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-07-12T00:17:07.042-07:00",
"detected_at": null,
"acknowledged_at": null,
"mitigated_at": "2025-07-12T00:17:24.764-07:00",
"resolved_at": null,
"closed_at": null,
"cancelled_at": null,
"created_at": "2025-07-12T00:17:07.042-07:00",
"updated_at": "2025-07-12T00:17:24.817-07:00",
"labels": {}
},
"relationships": {
"incident_post_mortem": {
"data": {
"id": "7b9e6e3a-8eee-488b-9dfa-65f55a3459fa",
"type": "incident_post_mortems"
}
},
"causes": {
"data": []
},
"subscribers": {
"data": []
},
"roles": {
"data": []
},
"environments": {
"data": []
},
"incident_types": {
"data": []
},
"services": {
"data": []
},
"functionalities": {
"data": []
},
"groups": {
"data": []
},
"events": {
"data": [
{
"id": "b383d0ed-3760-4350-84e1-e013cd652def",
"type": "incident_events"
},
{
"id": "419ab0c8-3381-45e2-a6f4-d2fdde566057",
"type": "incident_events"
},
{
"id": "7adaedaa-57e4-4d07-b5ef-46745ff3ccbf",
"type": "incident_events"
},
{
"id": "522cd81f-72ff-4edd-bba1-1b497f471f3c",
"type": "incident_events"
}
]
},
"action_items": {
"data": []
},
"custom_field_selections": {
"data": []
},
"feedbacks": {
"data": []
},
"attachments": {
"data": []
},
"slack_messages": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/mitigate_incident"
}
}
},
"required": true
}
}
},
"/v1/incidents/{id}/resolve": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"put": {
"summary": "Resolve an incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Resolve a specific incident by id",
"operationId": "resolveIncident",
"parameters": [],
"responses": {
"200": {
"description": "incident resolved",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "8150262f-a6e3-4561-8751-42cddc5daf2a",
"type": "incidents",
"attributes": {
"parent_incident_id": null,
"sequential_id": 1,
"title": "Est tempora maxime placeat.",
"slug": "est-tempora-maxime-placeat",
"kind": "normal",
"private": false,
"summary": "Distinctio quis numquam. Voluptas quasi fuga. Et iure voluptatem.",
"status": "resolved",
"source": "web",
"url": "http://localhost:3001/account/incidents/1-est-tempora-maxime-placeat",
"short_url": null,
"user": {
"data": {
"id": "301",
"type": "users",
"attributes": {
"name": "Saul Beatty",
"email": "allan@senger.test",
"phone": null,
"phone_2": null,
"first_name": "Saul",
"last_name": "Beatty",
"full_name": "Saul Beatty",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Saul Beatty",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:07.074-07:00",
"created_at": "2025-07-12T00:17:06.659-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a7cbfb37-6519-4a7c-85f5-e5d38aa39aa6",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"severity": {
"data": {
"id": "41269138-eeb5-4555-acdd-f9940411fc9d",
"type": "severities",
"attributes": {
"name": "vzps3",
"slug": "vzps3",
"description": "Soluta deserunt ex dolorum.",
"severity": "medium",
"color": "#E58A1F",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-07-12T00:17:07.035-07:00",
"updated_at": "2025-07-12T00:17:07.035-07:00"
}
}
},
"in_triage_by": null,
"started_by": {
"data": {
"id": "301",
"type": "users",
"attributes": {
"name": "Saul Beatty",
"email": "allan@senger.test",
"phone": null,
"phone_2": null,
"first_name": "Saul",
"last_name": "Beatty",
"full_name": "Saul Beatty",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Saul Beatty",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:07.074-07:00",
"created_at": "2025-07-12T00:17:06.659-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a7cbfb37-6519-4a7c-85f5-e5d38aa39aa6",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"mitigated_by": null,
"resolved_by": {
"data": {
"id": "299",
"type": "users",
"attributes": {
"name": "Krystin Adams",
"email": "vikki.ryan@heathcote.test",
"phone": null,
"phone_2": null,
"first_name": "Krystin",
"last_name": "Adams",
"full_name": "Krystin Adams",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Krystin Adams",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:25.545-07:00",
"created_at": "2025-07-12T00:17:05.857-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "138e3803-211a-412e-8dfd-cd00a4b89216",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"closed_by": null,
"cancelled_by": null,
"mitigation_message": null,
"resolution_message": "Restart database fixed it!",
"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-07-12T00:17:07.042-07:00",
"detected_at": null,
"acknowledged_at": null,
"mitigated_at": "2025-07-12T00:17:25.691-07:00",
"resolved_at": "2025-07-12T00:17:25.691-07:00",
"closed_at": null,
"cancelled_at": null,
"created_at": "2025-07-12T00:17:07.042-07:00",
"updated_at": "2025-07-12T00:17:25.801-07:00",
"labels": {}
},
"relationships": {
"incident_post_mortem": {
"data": {
"id": "7b9e6e3a-8eee-488b-9dfa-65f55a3459fa",
"type": "incident_post_mortems"
}
},
"causes": {
"data": []
},
"subscribers": {
"data": []
},
"roles": {
"data": []
},
"environments": {
"data": []
},
"incident_types": {
"data": []
},
"services": {
"data": []
},
"functionalities": {
"data": []
},
"groups": {
"data": []
},
"events": {
"data": [
{
"id": "73abe4f3-591e-4687-8980-6692a54edda7",
"type": "incident_events"
},
{
"id": "3279aa72-6586-4a09-ba3a-86c80ed196b3",
"type": "incident_events"
},
{
"id": "76696532-3547-44ca-9fe0-ba2f922eb5da",
"type": "incident_events"
},
{
"id": "7adaedaa-57e4-4d07-b5ef-46745ff3ccbf",
"type": "incident_events"
},
{
"id": "522cd81f-72ff-4edd-bba1-1b497f471f3c",
"type": "incident_events"
}
]
},
"action_items": {
"data": []
},
"custom_field_selections": {
"data": []
},
"feedbacks": {
"data": []
},
"attachments": {
"data": []
},
"slack_messages": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/resolve_incident"
}
}
},
"required": true
}
}
},
"/v1/incidents/{id}/cancel": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"put": {
"summary": "Cancel an incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Cancel a specific incident by id",
"operationId": "cancelIncident",
"parameters": [],
"responses": {
"200": {
"description": "incident cancel",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "8150262f-a6e3-4561-8751-42cddc5daf2a",
"type": "incidents",
"attributes": {
"parent_incident_id": null,
"sequential_id": 1,
"title": "Est tempora maxime placeat.",
"slug": "est-tempora-maxime-placeat",
"kind": "normal",
"private": false,
"summary": "Distinctio quis numquam. Voluptas quasi fuga. Et iure voluptatem.",
"status": "cancelled",
"source": "web",
"url": "http://localhost:3001/account/incidents/1-est-tempora-maxime-placeat",
"short_url": null,
"user": {
"data": {
"id": "301",
"type": "users",
"attributes": {
"name": "Saul Beatty",
"email": "allan@senger.test",
"phone": null,
"phone_2": null,
"first_name": "Saul",
"last_name": "Beatty",
"full_name": "Saul Beatty",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Saul Beatty",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:07.074-07:00",
"created_at": "2025-07-12T00:17:06.659-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a7cbfb37-6519-4a7c-85f5-e5d38aa39aa6",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"severity": {
"data": {
"id": "41269138-eeb5-4555-acdd-f9940411fc9d",
"type": "severities",
"attributes": {
"name": "vzps3",
"slug": "vzps3",
"description": "Soluta deserunt ex dolorum.",
"severity": "medium",
"color": "#E58A1F",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-07-12T00:17:07.035-07:00",
"updated_at": "2025-07-12T00:17:07.035-07:00"
}
}
},
"in_triage_by": null,
"started_by": {
"data": {
"id": "301",
"type": "users",
"attributes": {
"name": "Saul Beatty",
"email": "allan@senger.test",
"phone": null,
"phone_2": null,
"first_name": "Saul",
"last_name": "Beatty",
"full_name": "Saul Beatty",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Saul Beatty",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:07.074-07:00",
"created_at": "2025-07-12T00:17:06.659-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a7cbfb37-6519-4a7c-85f5-e5d38aa39aa6",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"mitigated_by": null,
"resolved_by": null,
"closed_by": null,
"cancelled_by": {
"data": {
"id": "299",
"type": "users",
"attributes": {
"name": "Krystin Adams",
"email": "vikki.ryan@heathcote.test",
"phone": null,
"phone_2": null,
"first_name": "Krystin",
"last_name": "Adams",
"full_name": "Krystin Adams",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Krystin Adams",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:26.543-07:00",
"created_at": "2025-07-12T00:17:05.857-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "138e3803-211a-412e-8dfd-cd00a4b89216",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"mitigation_message": null,
"resolution_message": null,
"cancellation_message": "Nevermind!",
"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-07-12T00:17:07.042-07:00",
"detected_at": null,
"acknowledged_at": null,
"mitigated_at": null,
"resolved_at": null,
"closed_at": null,
"cancelled_at": "2025-07-12T00:17:26.713-07:00",
"created_at": "2025-07-12T00:17:07.042-07:00",
"updated_at": "2025-07-12T00:17:26.768-07:00",
"labels": {}
},
"relationships": {
"incident_post_mortem": {
"data": {
"id": "7b9e6e3a-8eee-488b-9dfa-65f55a3459fa",
"type": "incident_post_mortems"
}
},
"causes": {
"data": []
},
"subscribers": {
"data": []
},
"roles": {
"data": []
},
"environments": {
"data": []
},
"incident_types": {
"data": []
},
"services": {
"data": []
},
"functionalities": {
"data": []
},
"groups": {
"data": []
},
"events": {
"data": [
{
"id": "ca85991f-d036-4db8-bcdf-df84d8c14107",
"type": "incident_events"
},
{
"id": "7adaedaa-57e4-4d07-b5ef-46745ff3ccbf",
"type": "incident_events"
},
{
"id": "522cd81f-72ff-4edd-bba1-1b497f471f3c",
"type": "incident_events"
}
]
},
"action_items": {
"data": []
},
"custom_field_selections": {
"data": []
},
"feedbacks": {
"data": []
},
"attachments": {
"data": []
},
"slack_messages": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/cancel_incident"
}
}
},
"required": true
}
}
},
"/v1/incidents/{id}/in_triage": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"put": {
"summary": "Triage an incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Set a specific incident by ID to triage state",
"operationId": "triageIncident",
"parameters": [],
"responses": {
"200": {
"description": "incident set to triage",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "3d19c233-78ca-44be-9c3d-74edcd3ec45c",
"type": "incidents",
"attributes": {
"parent_incident_id": null,
"sequential_id": 10,
"title": "Molestias ducimus nesciunt quam.",
"slug": "molestias-ducimus-nesciunt-quam",
"kind": "normal",
"private": false,
"summary": "Assumenda quod omnis. Et consectetur vitae. Sit similique qui.",
"status": "in_triage",
"source": "web",
"url": "http://localhost:3001/account/incidents/10-molestias-ducimus-nesciunt-quam",
"short_url": null,
"user": {
"data": {
"id": "311",
"type": "users",
"attributes": {
"name": "Blake Armstrong",
"email": "abraham@schultz-stehr.test",
"phone": null,
"phone_2": null,
"first_name": "Blake",
"last_name": "Armstrong",
"full_name": "Blake Armstrong",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Blake Armstrong",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:12.437-07:00",
"created_at": "2025-07-12T00:17:12.037-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "29b435bb-9cbc-45ec-b710-cc8d952e546f",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"severity": {
"data": {
"id": "398af253-8350-4e5f-a6b7-46f9564c0a1a",
"type": "severities",
"attributes": {
"name": "bxtdr",
"slug": "bxtdr",
"description": "Deleniti voluptate hic distinctio.",
"severity": "medium",
"color": "#E58A1F",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-07-12T00:17:12.400-07:00",
"updated_at": "2025-07-12T00:17:12.401-07:00"
}
}
},
"in_triage_by": {
"data": {
"id": "299",
"type": "users",
"attributes": {
"name": "Krystin Adams",
"email": "vikki.ryan@heathcote.test",
"phone": null,
"phone_2": null,
"first_name": "Krystin",
"last_name": "Adams",
"full_name": "Krystin Adams",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Krystin Adams",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:27.524-07:00",
"created_at": "2025-07-12T00:17:05.857-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "138e3803-211a-412e-8dfd-cd00a4b89216",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"started_by": {
"data": {
"id": "311",
"type": "users",
"attributes": {
"name": "Blake Armstrong",
"email": "abraham@schultz-stehr.test",
"phone": null,
"phone_2": null,
"first_name": "Blake",
"last_name": "Armstrong",
"full_name": "Blake Armstrong",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Blake Armstrong",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:12.437-07:00",
"created_at": "2025-07-12T00:17:12.037-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "29b435bb-9cbc-45ec-b710-cc8d952e546f",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_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": "2025-07-12T00:17:27.682-07:00",
"started_at": null,
"detected_at": null,
"acknowledged_at": null,
"mitigated_at": null,
"resolved_at": null,
"closed_at": null,
"cancelled_at": null,
"created_at": "2025-07-12T00:17:12.406-07:00",
"updated_at": "2025-07-12T00:17:27.739-07:00",
"labels": {}
},
"relationships": {
"incident_post_mortem": {
"data": {
"id": "1bab551c-8b03-481e-aa89-92c793cfcd5f",
"type": "incident_post_mortems"
}
},
"causes": {
"data": []
},
"subscribers": {
"data": []
},
"roles": {
"data": []
},
"environments": {
"data": []
},
"incident_types": {
"data": []
},
"services": {
"data": []
},
"functionalities": {
"data": []
},
"groups": {
"data": []
},
"events": {
"data": [
{
"id": "9ade7b95-f27d-4619-b2b4-6358939039f1",
"type": "incident_events"
},
{
"id": "1b03ab5e-2c5f-4b31-992a-2e45c8a5c25e",
"type": "incident_events"
},
{
"id": "70ce0ec6-5963-4a73-9abd-05ba99ab6466",
"type": "incident_events"
},
{
"id": "f9359e0c-b440-4d10-8220-4e669cd809d4",
"type": "incident_events"
},
{
"id": "2310bc88-e678-4fd0-b7f0-bff0e9a21eca",
"type": "incident_events"
},
{
"id": "f1b74c50-b24f-4449-b050-f8211980b378",
"type": "incident_events"
},
{
"id": "6f26d8c5-7dae-4f47-8f04-0450da66c564",
"type": "incident_events"
}
]
},
"action_items": {
"data": []
},
"custom_field_selections": {
"data": []
},
"feedbacks": {
"data": []
},
"attachments": {
"data": []
},
"slack_messages": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/in_triage_incident"
}
}
},
"required": true
}
}
},
"/v1/incidents/{id}/restart": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"put": {
"summary": "Restart an incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Restart a specific incident by id",
"operationId": "restartIncident",
"parameters": [],
"responses": {
"200": {
"description": "incident restarted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "3d19c233-78ca-44be-9c3d-74edcd3ec45c",
"type": "incidents",
"attributes": {
"parent_incident_id": null,
"sequential_id": 10,
"title": "Molestias ducimus nesciunt quam.",
"slug": "molestias-ducimus-nesciunt-quam",
"kind": "normal",
"private": false,
"summary": "Assumenda quod omnis. Et consectetur vitae. Sit similique qui.",
"status": "started",
"source": "web",
"url": "http://localhost:3001/account/incidents/10-molestias-ducimus-nesciunt-quam",
"short_url": null,
"user": {
"data": {
"id": "311",
"type": "users",
"attributes": {
"name": "Blake Armstrong",
"email": "abraham@schultz-stehr.test",
"phone": null,
"phone_2": null,
"first_name": "Blake",
"last_name": "Armstrong",
"full_name": "Blake Armstrong",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Blake Armstrong",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:12.437-07:00",
"created_at": "2025-07-12T00:17:12.037-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "29b435bb-9cbc-45ec-b710-cc8d952e546f",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"severity": {
"data": {
"id": "398af253-8350-4e5f-a6b7-46f9564c0a1a",
"type": "severities",
"attributes": {
"name": "bxtdr",
"slug": "bxtdr",
"description": "Deleniti voluptate hic distinctio.",
"severity": "medium",
"color": "#E58A1F",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-07-12T00:17:12.400-07:00",
"updated_at": "2025-07-12T00:17:12.401-07:00"
}
}
},
"in_triage_by": null,
"started_by": {
"data": {
"id": "299",
"type": "users",
"attributes": {
"name": "Krystin Adams",
"email": "vikki.ryan@heathcote.test",
"phone": null,
"phone_2": null,
"first_name": "Krystin",
"last_name": "Adams",
"full_name": "Krystin Adams",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Krystin Adams",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:28.467-07:00",
"created_at": "2025-07-12T00:17:05.857-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "138e3803-211a-412e-8dfd-cd00a4b89216",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_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-07-12T00:17:28.639-07:00",
"detected_at": null,
"acknowledged_at": null,
"mitigated_at": null,
"resolved_at": null,
"closed_at": null,
"cancelled_at": null,
"created_at": "2025-07-12T00:17:12.406-07:00",
"updated_at": "2025-07-12T00:17:28.689-07:00",
"labels": {}
},
"relationships": {
"causes": {
"data": []
},
"subscribers": {
"data": []
},
"roles": {
"data": []
},
"environments": {
"data": []
},
"incident_types": {
"data": []
},
"services": {
"data": []
},
"functionalities": {
"data": []
},
"groups": {
"data": []
},
"events": {
"data": [
{
"id": "4f54d1e3-ab59-46e6-9c20-d166a2d37367",
"type": "incident_events"
},
{
"id": "70ce0ec6-5963-4a73-9abd-05ba99ab6466",
"type": "incident_events"
},
{
"id": "f9359e0c-b440-4d10-8220-4e669cd809d4",
"type": "incident_events"
},
{
"id": "2310bc88-e678-4fd0-b7f0-bff0e9a21eca",
"type": "incident_events"
},
{
"id": "f1b74c50-b24f-4449-b050-f8211980b378",
"type": "incident_events"
},
{
"id": "6f26d8c5-7dae-4f47-8f04-0450da66c564",
"type": "incident_events"
}
]
},
"action_items": {
"data": []
},
"custom_field_selections": {
"data": []
},
"feedbacks": {
"data": []
},
"attachments": {
"data": []
},
"slack_messages": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/restart_incident"
}
}
},
"required": true
}
}
},
"/v1/incidents/{id}/duplicate": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"put": {
"summary": "Mark an incident as a duplicate",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Mark an incident as a duplicate",
"operationId": "markAsDuplicateIncident",
"parameters": [],
"responses": {
"200": {
"description": "incident marked as duplicated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "8150262f-a6e3-4561-8751-42cddc5daf2a",
"type": "incidents",
"attributes": {
"parent_incident_id": null,
"sequential_id": 1,
"title": "Est tempora maxime placeat.",
"slug": "est-tempora-maxime-placeat",
"kind": "normal",
"private": false,
"summary": "Distinctio quis numquam. Voluptas quasi fuga. Et iure voluptatem.",
"status": "cancelled",
"source": "web",
"url": "http://localhost:3001/account/incidents/1-est-tempora-maxime-placeat",
"short_url": null,
"user": {
"data": {
"id": "301",
"type": "users",
"attributes": {
"name": "Saul Beatty",
"email": "allan@senger.test",
"phone": null,
"phone_2": null,
"first_name": "Saul",
"last_name": "Beatty",
"full_name": "Saul Beatty",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Saul Beatty",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:07.074-07:00",
"created_at": "2025-07-12T00:17:06.659-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a7cbfb37-6519-4a7c-85f5-e5d38aa39aa6",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"severity": {
"data": {
"id": "41269138-eeb5-4555-acdd-f9940411fc9d",
"type": "severities",
"attributes": {
"name": "vzps3",
"slug": "vzps3",
"description": "Soluta deserunt ex dolorum.",
"severity": "medium",
"color": "#E58A1F",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-07-12T00:17:07.035-07:00",
"updated_at": "2025-07-12T00:17:07.035-07:00"
}
}
},
"in_triage_by": null,
"started_by": {
"data": {
"id": "301",
"type": "users",
"attributes": {
"name": "Saul Beatty",
"email": "allan@senger.test",
"phone": null,
"phone_2": null,
"first_name": "Saul",
"last_name": "Beatty",
"full_name": "Saul Beatty",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Saul Beatty",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:07.074-07:00",
"created_at": "2025-07-12T00:17:06.659-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a7cbfb37-6519-4a7c-85f5-e5d38aa39aa6",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"mitigated_by": null,
"resolved_by": null,
"closed_by": null,
"cancelled_by": null,
"mitigation_message": null,
"resolution_message": null,
"cancellation_message": "Duplicate !",
"public_title": null,
"duplicate_incident_id": "8c324da1-f533-477a-a108-a3edddd25b4d",
"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-07-12T00:17:07.042-07:00",
"detected_at": null,
"acknowledged_at": null,
"mitigated_at": null,
"resolved_at": null,
"closed_at": null,
"cancelled_at": "2025-07-12T00:17:29.627-07:00",
"created_at": "2025-07-12T00:17:07.042-07:00",
"updated_at": "2025-07-12T00:17:29.677-07:00",
"labels": {}
},
"relationships": {
"incident_post_mortem": {
"data": {
"id": "7b9e6e3a-8eee-488b-9dfa-65f55a3459fa",
"type": "incident_post_mortems"
}
},
"causes": {
"data": []
},
"subscribers": {
"data": []
},
"roles": {
"data": []
},
"environments": {
"data": []
},
"incident_types": {
"data": []
},
"services": {
"data": []
},
"functionalities": {
"data": []
},
"groups": {
"data": []
},
"events": {
"data": [
{
"id": "f7bb8be7-65e4-4f97-9235-cb01e20c9e84",
"type": "incident_events"
},
{
"id": "1efd6481-5106-4d24-9899-fc7a5104b510",
"type": "incident_events"
},
{
"id": "7adaedaa-57e4-4d07-b5ef-46745ff3ccbf",
"type": "incident_events"
},
{
"id": "522cd81f-72ff-4edd-bba1-1b497f471f3c",
"type": "incident_events"
}
]
},
"action_items": {
"data": []
},
"custom_field_selections": {
"data": []
},
"feedbacks": {
"data": []
},
"attachments": {
"data": []
},
"slack_messages": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/resolve_incident"
}
}
},
"required": true
}
}
},
"/v1/incidents/{id}/add_subscribers": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Add subscribers to incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Add subscribers to incident",
"operationId": "addSubscribersToIncident",
"parameters": [],
"responses": {
"200": {
"description": "add subscribers to incident",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "8150262f-a6e3-4561-8751-42cddc5daf2a",
"type": "incidents",
"attributes": {
"parent_incident_id": null,
"sequential_id": 1,
"title": "Est tempora maxime placeat.",
"slug": "est-tempora-maxime-placeat",
"kind": "normal",
"private": false,
"summary": "Distinctio quis numquam. Voluptas quasi fuga. Et iure voluptatem.",
"status": "started",
"source": "web",
"url": "http://localhost:3001/account/incidents/1-est-tempora-maxime-placeat",
"short_url": null,
"user": {
"data": {
"id": "301",
"type": "users",
"attributes": {
"name": "Saul Beatty",
"email": "allan@senger.test",
"phone": null,
"phone_2": null,
"first_name": "Saul",
"last_name": "Beatty",
"full_name": "Saul Beatty",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Saul Beatty",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:07.074-07:00",
"created_at": "2025-07-12T00:17:06.659-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a7cbfb37-6519-4a7c-85f5-e5d38aa39aa6",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"severity": {
"data": {
"id": "41269138-eeb5-4555-acdd-f9940411fc9d",
"type": "severities",
"attributes": {
"name": "vzps3",
"slug": "vzps3",
"description": "Soluta deserunt ex dolorum.",
"severity": "medium",
"color": "#E58A1F",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-07-12T00:17:07.035-07:00",
"updated_at": "2025-07-12T00:17:07.035-07:00"
}
}
},
"in_triage_by": null,
"started_by": {
"data": {
"id": "301",
"type": "users",
"attributes": {
"name": "Saul Beatty",
"email": "allan@senger.test",
"phone": null,
"phone_2": null,
"first_name": "Saul",
"last_name": "Beatty",
"full_name": "Saul Beatty",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Saul Beatty",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:07.074-07:00",
"created_at": "2025-07-12T00:17:06.659-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a7cbfb37-6519-4a7c-85f5-e5d38aa39aa6",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_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-07-12T00:17:07.042-07:00",
"detected_at": null,
"acknowledged_at": null,
"mitigated_at": null,
"resolved_at": null,
"closed_at": null,
"cancelled_at": null,
"created_at": "2025-07-12T00:17:07.042-07:00",
"updated_at": "2025-07-12T00:17:07.124-07:00",
"labels": {}
},
"relationships": {
"causes": {
"data": []
},
"subscribers": {
"data": [
{
"id": "4d67d2cf-3468-4467-abfd-bbc1d4c10f33",
"type": "incident_subscribers"
}
]
},
"roles": {
"data": []
},
"environments": {
"data": []
},
"incident_types": {
"data": []
},
"services": {
"data": []
},
"functionalities": {
"data": []
},
"groups": {
"data": []
},
"events": {
"data": [
{
"id": "7adaedaa-57e4-4d07-b5ef-46745ff3ccbf",
"type": "incident_events"
},
{
"id": "522cd81f-72ff-4edd-bba1-1b497f471f3c",
"type": "incident_events"
}
]
},
"action_items": {
"data": []
},
"custom_field_selections": {
"data": []
},
"feedbacks": {
"data": []
},
"attachments": {
"data": []
},
"slack_messages": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/add_subscribers"
}
}
},
"required": true
}
}
},
"/v1/incidents/{id}/remove_subscribers": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"delete": {
"summary": "Remove subscribers from incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Remove subscribers to incident",
"operationId": "removeSubscribersToIncident",
"parameters": [],
"responses": {
"200": {
"description": "remove subscribers from incident",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "8150262f-a6e3-4561-8751-42cddc5daf2a",
"type": "incidents",
"attributes": {
"parent_incident_id": null,
"sequential_id": 1,
"title": "Est tempora maxime placeat.",
"slug": "est-tempora-maxime-placeat",
"kind": "normal",
"private": false,
"summary": "Distinctio quis numquam. Voluptas quasi fuga. Et iure voluptatem.",
"status": "started",
"source": "web",
"url": "http://localhost:3001/account/incidents/1-est-tempora-maxime-placeat",
"short_url": null,
"user": {
"data": {
"id": "301",
"type": "users",
"attributes": {
"name": "Saul Beatty",
"email": "allan@senger.test",
"phone": null,
"phone_2": null,
"first_name": "Saul",
"last_name": "Beatty",
"full_name": "Saul Beatty",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Saul Beatty",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:07.074-07:00",
"created_at": "2025-07-12T00:17:06.659-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a7cbfb37-6519-4a7c-85f5-e5d38aa39aa6",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"severity": {
"data": {
"id": "41269138-eeb5-4555-acdd-f9940411fc9d",
"type": "severities",
"attributes": {
"name": "vzps3",
"slug": "vzps3",
"description": "Soluta deserunt ex dolorum.",
"severity": "medium",
"color": "#E58A1F",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-07-12T00:17:07.035-07:00",
"updated_at": "2025-07-12T00:17:07.035-07:00"
}
}
},
"in_triage_by": null,
"started_by": {
"data": {
"id": "301",
"type": "users",
"attributes": {
"name": "Saul Beatty",
"email": "allan@senger.test",
"phone": null,
"phone_2": null,
"first_name": "Saul",
"last_name": "Beatty",
"full_name": "Saul Beatty",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Saul Beatty",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:07.074-07:00",
"created_at": "2025-07-12T00:17:06.659-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a7cbfb37-6519-4a7c-85f5-e5d38aa39aa6",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_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-07-12T00:17:07.042-07:00",
"detected_at": null,
"acknowledged_at": null,
"mitigated_at": null,
"resolved_at": null,
"closed_at": null,
"cancelled_at": null,
"created_at": "2025-07-12T00:17:07.042-07:00",
"updated_at": "2025-07-12T00:17:07.124-07:00",
"labels": {}
},
"relationships": {
"causes": {
"data": []
},
"subscribers": {
"data": []
},
"roles": {
"data": []
},
"environments": {
"data": []
},
"incident_types": {
"data": []
},
"services": {
"data": []
},
"functionalities": {
"data": []
},
"groups": {
"data": []
},
"events": {
"data": [
{
"id": "7adaedaa-57e4-4d07-b5ef-46745ff3ccbf",
"type": "incident_events"
},
{
"id": "522cd81f-72ff-4edd-bba1-1b497f471f3c",
"type": "incident_events"
}
]
},
"action_items": {
"data": []
},
"custom_field_selections": {
"data": []
},
"feedbacks": {
"data": []
},
"attachments": {
"data": []
},
"slack_messages": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/remove_subscribers"
}
}
},
"required": true
}
}
},
"/v1/incidents/{id}/assign_role_to_user": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Assign user to incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Assign user to incident",
"operationId": "assignUserToIncident",
"parameters": [],
"responses": {
"200": {
"description": "assign user to incident",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "8150262f-a6e3-4561-8751-42cddc5daf2a",
"type": "incidents",
"attributes": {
"parent_incident_id": null,
"sequential_id": 1,
"title": "Est tempora maxime placeat.",
"slug": "est-tempora-maxime-placeat",
"kind": "normal",
"private": false,
"summary": "Distinctio quis numquam. Voluptas quasi fuga. Et iure voluptatem.",
"status": "started",
"source": "web",
"url": "http://localhost:3001/account/incidents/1-est-tempora-maxime-placeat",
"short_url": null,
"user": {
"data": {
"id": "301",
"type": "users",
"attributes": {
"name": "Saul Beatty",
"email": "allan@senger.test",
"phone": null,
"phone_2": null,
"first_name": "Saul",
"last_name": "Beatty",
"full_name": "Saul Beatty",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Saul Beatty",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:07.074-07:00",
"created_at": "2025-07-12T00:17:06.659-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a7cbfb37-6519-4a7c-85f5-e5d38aa39aa6",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"severity": {
"data": {
"id": "41269138-eeb5-4555-acdd-f9940411fc9d",
"type": "severities",
"attributes": {
"name": "vzps3",
"slug": "vzps3",
"description": "Soluta deserunt ex dolorum.",
"severity": "medium",
"color": "#E58A1F",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-07-12T00:17:07.035-07:00",
"updated_at": "2025-07-12T00:17:07.035-07:00"
}
}
},
"in_triage_by": null,
"started_by": {
"data": {
"id": "301",
"type": "users",
"attributes": {
"name": "Saul Beatty",
"email": "allan@senger.test",
"phone": null,
"phone_2": null,
"first_name": "Saul",
"last_name": "Beatty",
"full_name": "Saul Beatty",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Saul Beatty",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:07.074-07:00",
"created_at": "2025-07-12T00:17:06.659-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a7cbfb37-6519-4a7c-85f5-e5d38aa39aa6",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_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-07-12T00:17:07.042-07:00",
"detected_at": null,
"acknowledged_at": null,
"mitigated_at": null,
"resolved_at": null,
"closed_at": null,
"cancelled_at": null,
"created_at": "2025-07-12T00:17:07.042-07:00",
"updated_at": "2025-07-12T00:17:32.298-07:00",
"labels": {}
},
"relationships": {
"causes": {
"data": []
},
"subscribers": {
"data": [
{
"id": "d7934ee8-3182-4ba8-bd90-192fb8bb3d12",
"type": "incident_subscribers"
}
]
},
"roles": {
"data": [
{
"id": "ea8dbeee-d3a3-4aa5-8689-238f1e70b66f",
"type": "incident_role_assignments"
}
]
},
"environments": {
"data": []
},
"incident_types": {
"data": []
},
"services": {
"data": []
},
"functionalities": {
"data": []
},
"groups": {
"data": []
},
"events": {
"data": [
{
"id": "565b11a5-dd51-4d51-92c3-2146d0b7cfb3",
"type": "incident_events"
},
{
"id": "7adaedaa-57e4-4d07-b5ef-46745ff3ccbf",
"type": "incident_events"
},
{
"id": "522cd81f-72ff-4edd-bba1-1b497f471f3c",
"type": "incident_events"
}
]
},
"action_items": {
"data": []
},
"custom_field_selections": {
"data": []
},
"feedbacks": {
"data": []
},
"attachments": {
"data": []
},
"slack_messages": {
"data": []
}
}
},
"included": [
{
"id": "ea8dbeee-d3a3-4aa5-8689-238f1e70b66f",
"type": "incident_role_assignments",
"attributes": {
"incident_role": {
"data": {
"id": "c15de9a1-2c37-42eb-99ee-47f3c1677cb2",
"type": "incident_roles",
"attributes": {
"slug": "expedita-quia-dolore-quidem",
"name": "Expedita quia dolore quidem.",
"summary": null,
"description": null,
"position": 1,
"optional": false,
"enabled": true,
"allow_multi_user_assignment": false,
"created_at": "2025-07-12T00:17:12.707-07:00",
"updated_at": "2025-07-12T00:17:12.707-07:00"
}
}
},
"user": {
"data": {
"id": "299",
"type": "users",
"attributes": {
"name": "Krystin Adams",
"email": "vikki.ryan@heathcote.test",
"phone": null,
"phone_2": null,
"first_name": "Krystin",
"last_name": "Adams",
"full_name": "Krystin Adams",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Krystin Adams",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:32.172-07:00",
"created_at": "2025-07-12T00:17:05.857-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "138e3803-211a-412e-8dfd-cd00a4b89216",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
}
}
}
]
},
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/assign_role_to_user"
}
}
},
"required": true
}
}
},
"/v1/incidents/{id}/unassign_role_from_user": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"delete": {
"summary": "Remove assigned user from incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Remove assigned user from incident",
"operationId": "removeAssignedUserFromIncident",
"parameters": [],
"responses": {
"200": {
"description": "remove assigned user from incident",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "8150262f-a6e3-4561-8751-42cddc5daf2a",
"type": "incidents",
"attributes": {
"parent_incident_id": null,
"sequential_id": 1,
"title": "Est tempora maxime placeat.",
"slug": "est-tempora-maxime-placeat",
"kind": "normal",
"private": false,
"summary": "Distinctio quis numquam. Voluptas quasi fuga. Et iure voluptatem.",
"status": "started",
"source": "web",
"url": "http://localhost:3001/account/incidents/1-est-tempora-maxime-placeat",
"short_url": null,
"user": {
"data": {
"id": "301",
"type": "users",
"attributes": {
"name": "Saul Beatty",
"email": "allan@senger.test",
"phone": null,
"phone_2": null,
"first_name": "Saul",
"last_name": "Beatty",
"full_name": "Saul Beatty",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Saul Beatty",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:07.074-07:00",
"created_at": "2025-07-12T00:17:06.659-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a7cbfb37-6519-4a7c-85f5-e5d38aa39aa6",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_permissions": []
}
}
}
}
},
"severity": {
"data": {
"id": "41269138-eeb5-4555-acdd-f9940411fc9d",
"type": "severities",
"attributes": {
"name": "vzps3",
"slug": "vzps3",
"description": "Soluta deserunt ex dolorum.",
"severity": "medium",
"color": "#E58A1F",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-07-12T00:17:07.035-07:00",
"updated_at": "2025-07-12T00:17:07.035-07:00"
}
}
},
"in_triage_by": null,
"started_by": {
"data": {
"id": "301",
"type": "users",
"attributes": {
"name": "Saul Beatty",
"email": "allan@senger.test",
"phone": null,
"phone_2": null,
"first_name": "Saul",
"last_name": "Beatty",
"full_name": "Saul Beatty",
"full_name_with_team": "[O'Connell, Toy and Wilderman] Saul Beatty",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:17:07.074-07:00",
"created_at": "2025-07-12T00:17:06.659-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a7cbfb37-6519-4a7c-85f5-e5d38aa39aa6",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "0f133b25-49d2-4bbe-84c6-14ccfd9e2d14",
"created_at": "2025-07-12T00:17:06.020-07:00",
"updated_at": "2025-07-12T00:17:06.020-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": 270,
"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": "629d3c16-99d0-4193-bdd5-44aa6ed375d9",
"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": "3e186d9e-b718-4e09-8ad0-245cae36aded",
"team_id": 270,
"name": "None",
"slug": "none",
"system_role": "no_access",
"deleted_at": null,
"created_at": "2025-07-12T00:17:06.037-07:00",
"updated_at": "2025-07-12T00:17:06.037-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": [],
"alert_fields_permissions": [],
"alert_groups_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-07-12T00:17:07.042-07:00",
"detected_at": null,
"acknowledged_at": null,
"mitigated_at": null,
"resolved_at": null,
"closed_at": null,
"cancelled_at": null,
"created_at": "2025-07-12T00:17:07.042-07:00",
"updated_at": "2025-07-12T00:17:34.750-07:00",
"labels": {}
},
"relationships": {
"causes": {
"data": []
},
"subscribers": {
"data": [
{
"id": "c5918a94-8a14-4d37-b624-9e0c22dae384",
"type": "incident_subscribers"
}
]
},
"roles": {
"data": []
},
"environments": {
"data": []
},
"incident_types": {
"data": []
},
"services": {
"data": []
},
"functionalities": {
"data": []
},
"groups": {
"data": []
},
"events": {
"data": [
{
"id": "d3f8001e-b812-4a80-9ced-11b8d8126d17",
"type": "incident_events"
},
{
"id": "7adaedaa-57e4-4d07-b5ef-46745ff3ccbf",
"type": "incident_events"
},
{
"id": "522cd81f-72ff-4edd-bba1-1b497f471f3c",
"type": "incident_events"
}
]
},
"action_items": {
"data": []
},
"custom_field_selections": {
"data": []
},
"feedbacks": {
"data": []
},
"attachments": {
"data": []
},
"slack_messages": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/unassign_role_from_user"
}
}
},
"required": true
}
}
},
"/v1/ip_ranges": {
"get": {
"summary": "Retrieves IP ranges",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IpRanges"
],
"description": "Retrieves the IP ranges for rootly.com services",
"operationId": "getIpRanges",
"responses": {
"200": {
"description": "ip_ranges found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "ip_ranges",
"type": "ip_ranges",
"attributes": {
"integrations_ipv4": [
"34.232.217.139",
"18.213.181.255"
],
"integrations_ipv6": [],
"webhooks_ipv4": [
"34.232.217.139",
"18.213.181.255"
],
"webhooks_ipv6": []
}
}
},
"schema": {
"$ref": "#/components/schemas/ip_ranges_response"
}
}
}
}
}
}
},
"/v1/live_call_routers": {
"post": {
"summary": "Creates a Live Call Router",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"LiveCallRouters"
],
"description": "Creates a new Live Call Router from provided data",
"operationId": "createLiveCallRouter",
"parameters": [],
"responses": {
"201": {
"description": "live_call_router created with multiple notification targets",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "391169dd-6039-4e7f-8e39-f1eb51172f68",
"type": "live_call_routers",
"attributes": {
"kind": "voicemail",
"name": "live_call_router-prod",
"country_code": "US",
"phone_type": "toll_free",
"phone_number": "+14155552344",
"voicemail_greeting": "hello",
"slug": "live_call_router-prod",
"enabled": true,
"created_at": "2025-07-12T00:17:39.048-07:00",
"updated_at": "2025-07-12T00:17:39.061-07:00",
"alert_urgency_id": "b212d10d-5ce9-4c34-9863-397f32bca2e5",
"escalation_policy_trigger": {
"id": "bd0550f9-e957-449a-a94f-e513516aaca8",
"type": "service"
},
"calling_tree_prompt": "Press 1 for service, Press 2 for escalation policy",
"paging_targets": [
{
"id": "bd0550f9-e957-449a-a94f-e513516aaca8",
"type": "service",
"alert_urgency_id": "5e47e0c0-d672-4e73-9341-dda849e25afb"
},
{
"id": "c81e37bc-7ca0-4d17-9051-faf907d011df",
"type": "escalation_policy",
"alert_urgency_id": "aebfa4d6-dbb3-4de7-b4ea-e7991b4c9b2b"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/live_call_router_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_live_call_router"
}
}
},
"required": true
}
},
"get": {
"summary": "List Live Call Routers",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"LiveCallRouters"
],
"description": "List Live Call Routers",
"operationId": "listLiveCallRouters",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/live_call_router_list"
}
}
}
}
}
}
},
"/v1/live_call_routers/generate_phone_number": {
"get": {
"summary": "Generates a phone number for Live Call Router",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"LiveCallRouters"
],
"description": "Generates a phone number for Live Call Router",
"operationId": "generatePhoneNumberLiveCallRouter",
"parameters": [
{
"name": "country_code",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"AU",
"CA",
"NL",
"NZ",
"GB",
"US"
]
}
},
{
"name": "phone_type",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"local",
"toll_free",
"mobile"
]
}
}
],
"responses": {
"200": {
"description": "live_call_router phone number",
"content": {
"application/vnd.api+json": {
"example": {
"phone_number": "+18001000052"
}
}
}
},
"422": {
"description": "live_call_router without required params",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid params",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/live_call_routers/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a Live Call Router",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"LiveCallRouters"
],
"description": "Retrieves a specific Live Call Router by id",
"operationId": "getLiveCallRouter",
"responses": {
"200": {
"description": "live_call_router found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "03919260-b4e7-47ea-b828-7ccaed007a0e",
"type": "live_call_routers",
"attributes": {
"kind": "voicemail",
"name": "Dolorem facilis sit tenetur.",
"country_code": "US",
"phone_type": "local",
"phone_number": "14155551234",
"voicemail_greeting": "Odio eum beatae est.",
"slug": "dolorem-facilis-sit-tenetur",
"enabled": true,
"created_at": "2025-07-12T00:17:40.718-07:00",
"updated_at": "2025-07-12T00:17:40.718-07:00",
"alert_urgency_id": "5da9d02e-5b9d-46fe-8417-8b0ed2448627",
"escalation_policy_trigger": {
"id": "53492546-1c51-48ae-96d7-87ae1eeca8bc",
"type": "service"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/live_call_router_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a Live Call Router",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"LiveCallRouters"
],
"description": "Update a specific Live Call Router by id",
"operationId": "updateLiveCallRouter",
"parameters": [],
"responses": {
"200": {
"description": "live_call_router updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "95b87e02-09be-46ec-95af-b62b14545ac3",
"type": "live_call_routers",
"attributes": {
"kind": "voicemail",
"name": "live_call_router_staging",
"country_code": "US",
"phone_type": "local",
"phone_number": "14155551234",
"voicemail_greeting": "Dolor perspiciatis accusantium et.",
"slug": "eum-delectus-doloribus-asperiores",
"enabled": true,
"created_at": "2025-07-12T00:17:44.228-07:00",
"updated_at": "2025-07-12T00:17:44.374-07:00",
"alert_urgency_id": "72559e54-5ebd-4acd-b6bb-e157d5a082e8",
"escalation_policy_trigger": {
"id": "86d64a3d-c2db-48bd-a860-fb11f1e37ad6",
"type": "service"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/live_call_router_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_live_call_router"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a Live Call Router",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"LiveCallRouters"
],
"description": "Delete a specific Live Call Router by id",
"operationId": "deleteLiveCallRouter",
"responses": {
"200": {
"description": "live_call_router deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "5ea57f40-71fb-48e7-ab4d-eaeab47badcc",
"type": "live_call_routers",
"attributes": {
"kind": "voicemail",
"name": "Nobis qui quibusdam possimus.",
"country_code": "US",
"phone_type": "local",
"phone_number": "14155551234",
"voicemail_greeting": "Quasi eaque ipsum sit.",
"slug": "nobis-qui-quibusdam-possimus",
"enabled": true,
"created_at": "2025-07-12T00:17:47.124-07:00",
"updated_at": "2025-07-12T00:17:47.261-07:00",
"alert_urgency_id": "4d95af0e-23ef-4e6b-a93c-8f3832ef1be4",
"escalation_policy_trigger": {
"id": "6e2ffc08-96d2-4452-bb85-f4ddac0e196b",
"type": "service"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/live_call_router_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/on_call_roles": {
"post": {
"summary": "Creates an On-Call Role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCallRoles"
],
"description": "Creates a new On-Call Role from provided data",
"operationId": "createOnCallRole",
"parameters": [],
"responses": {
"201": {
"description": "on_call_role created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "6f9a83c0-17f8-44f5-9a2a-c22e7b35fbd3",
"type": "on_call_roles",
"attributes": {
"team_id": 304,
"name": "Infrastructure",
"slug": "infrastructure",
"system_role": "custom",
"alert_sources_permissions": [],
"alert_urgency_permissions": [],
"alerts_permissions": [],
"api_keys_permissions": [],
"audits_permissions": [],
"contacts_permissions": [],
"escalation_policies_permissions": [],
"groups_permissions": [],
"heartbeats_permissions": [],
"integrations_permissions": [],
"invitations_permissions": [],
"live_call_routing_permissions": [],
"schedule_override_permissions": [],
"schedules_permissions": [],
"services_permissions": [],
"webhooks_permissions": [],
"workflows_permissions": [],
"updated_at": "2025-07-12T00:17:51.337-07:00",
"created_at": "2025-07-12T00:17:51.337-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/on_call_role_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_on_call_role"
}
}
},
"required": true
}
},
"get": {
"summary": "List On-Call Roles",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCallRoles"
],
"description": "List On-Call Roles",
"operationId": "listOnCallRoles",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/on_call_role_list"
}
}
}
}
}
}
},
"/v1/on_call_roles/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an On-Call Role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCallRoles"
],
"description": "Retrieves a specific On-Call Role by id",
"operationId": "getOnCallRole",
"responses": {
"200": {
"description": "on_call_role found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "944d3e7c-9282-4008-9f4c-f8ded0ea679e",
"type": "on_call_roles",
"attributes": {
"team_id": 304,
"name": "On-Call Role 11",
"slug": "on-call-role-11",
"system_role": "admin",
"alert_sources_permissions": [],
"alert_urgency_permissions": [],
"alerts_permissions": [],
"api_keys_permissions": [],
"audits_permissions": [],
"contacts_permissions": [],
"escalation_policies_permissions": [],
"groups_permissions": [],
"heartbeats_permissions": [],
"integrations_permissions": [],
"invitations_permissions": [],
"live_call_routing_permissions": [],
"schedule_override_permissions": [],
"schedules_permissions": [],
"services_permissions": [],
"webhooks_permissions": [],
"workflows_permissions": [],
"updated_at": "2025-07-12T00:17:51.803-07:00",
"created_at": "2025-07-12T00:17:51.803-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/on_call_role_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an On-Call Role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCallRoles"
],
"description": "Update a specific On-Call Role by id",
"operationId": "updateOnCallRole",
"parameters": [],
"responses": {
"200": {
"description": "on_call_role updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "8acca28e-3d27-41a4-8b93-31a3140c229d",
"type": "on_call_roles",
"attributes": {
"team_id": 304,
"name": "Security",
"slug": "on-call-role-13",
"system_role": "custom",
"alert_sources_permissions": [],
"alert_urgency_permissions": [],
"alerts_permissions": [],
"api_keys_permissions": [],
"audits_permissions": [],
"contacts_permissions": [],
"escalation_policies_permissions": [],
"groups_permissions": [],
"heartbeats_permissions": [],
"integrations_permissions": [],
"invitations_permissions": [],
"live_call_routing_permissions": [],
"schedule_override_permissions": [],
"schedules_permissions": [],
"services_permissions": [],
"webhooks_permissions": [],
"workflows_permissions": [],
"updated_at": "2025-07-12T00:17:52.906-07:00",
"created_at": "2025-07-12T00:17:52.768-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/on_call_role_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_on_call_role"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an On-Call Role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCallRoles"
],
"description": "Delete a specific On-Call Role by id",
"operationId": "deleteOnCallRole",
"responses": {
"200": {
"description": "on_call_role deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "be27d454-2ee3-417a-ab9b-b115b2e895e6",
"type": "on_call_roles",
"attributes": {
"team_id": 304,
"name": "On-Call Role 15",
"slug": "on-call-role-15",
"system_role": "custom",
"alert_sources_permissions": [],
"alert_urgency_permissions": [],
"alerts_permissions": [],
"api_keys_permissions": [],
"audits_permissions": [],
"contacts_permissions": [],
"escalation_policies_permissions": [],
"groups_permissions": [],
"heartbeats_permissions": [],
"integrations_permissions": [],
"invitations_permissions": [],
"live_call_routing_permissions": [],
"schedule_override_permissions": [],
"schedules_permissions": [],
"services_permissions": [],
"webhooks_permissions": [],
"workflows_permissions": [],
"updated_at": "2025-07-12T00:17:53.792-07:00",
"created_at": "2025-07-12T00:17:53.657-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/on_call_role_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/schedules/{schedule_id}/on_call_shadows": {
"parameters": [
{
"name": "schedule_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "creates an shadow configuration",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCallShadows"
],
"description": "Creates a new on call shadow configuration from provided data",
"operationId": "createOnCallShadow",
"parameters": [],
"responses": {
"201": {
"description": "shadow shift is created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "6c2de0c7-5ffd-496c-92b2-81d390ffc506",
"type": "on_call_shadows",
"attributes": {
"schedule_id": "0dc71e6a-301a-4c00-935c-39cbbb804a5d",
"shadowable_type": "User",
"shadowable_id": "342",
"shadow_user_id": 341,
"starts_at": "2025-07-14T00:17:55.845-07:00",
"ends_at": "2025-07-15T00:17:55.845-07:00",
"created_at": "2025-07-12T00:17:55.975-07:00",
"updated_at": "2025-07-12T00:17:55.975-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/on_call_shadow_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Shadow user must exist",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_on_call_shadow"
}
}
},
"required": true
}
},
"get": {
"summary": "List On Call Shadows for Shift",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCallShadows"
],
"description": "List shadow shifts for schedule",
"operationId": "listOnCallShadows",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/on_call_shadows_list"
}
}
}
}
}
}
},
"/v1/on_call_shadows/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an On Call Shadow configuration by ID",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCallShadows"
],
"description": "Retrieves a specific On Call Shadow configuration by ID",
"operationId": "getOnCallShadow",
"responses": {
"200": {
"description": "override shift found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "505b3f47-a71a-4836-b1e6-ea5f8bba2056",
"type": "on_call_shadows",
"attributes": {
"schedule_id": "0dc71e6a-301a-4c00-935c-39cbbb804a5d",
"shadowable_type": "User",
"shadowable_id": "342",
"shadow_user_id": 341,
"starts_at": "2025-07-12T02:17:55.000-07:00",
"ends_at": "2025-07-13T00:17:55.000-07:00",
"created_at": "2025-07-12T00:17:55.738-07:00",
"updated_at": "2025-07-12T00:17:55.738-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/on_call_shadow_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an On Call Shadow configuration",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCallShadows"
],
"description": "Update a specific on call shadow configuration by id",
"operationId": "updateOnCallShadow",
"parameters": [],
"responses": {
"200": {
"description": "on call shadows configuration is is updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "505b3f47-a71a-4836-b1e6-ea5f8bba2056",
"type": "on_call_shadows",
"attributes": {
"schedule_id": "0dc71e6a-301a-4c00-935c-39cbbb804a5d",
"shadowable_type": "Schedule",
"shadowable_id": "0dc71e6a-301a-4c00-935c-39cbbb804a5d",
"shadow_user_id": 341,
"starts_at": "2025-07-12T02:17:55.000-07:00",
"ends_at": "2025-07-13T00:17:55.000-07:00",
"created_at": "2025-07-12T00:17:55.738-07:00",
"updated_at": "2025-07-12T00:17:57.070-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/on_call_shadow_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_on_call_shadow"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an on call shadow configuration",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OverrideShifts"
],
"description": "Delete a specific on call shadow configuration by id",
"operationId": "deleteOnCallShadow",
"responses": {
"200": {
"description": "override shift deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "505b3f47-a71a-4836-b1e6-ea5f8bba2056",
"type": "on_call_shadows",
"attributes": {
"schedule_id": "0dc71e6a-301a-4c00-935c-39cbbb804a5d",
"shadowable_type": "User",
"shadowable_id": "342",
"shadow_user_id": 341,
"starts_at": "2025-07-12T02:17:55.000-07:00",
"ends_at": "2025-07-13T00:17:55.000-07:00",
"created_at": "2025-07-12T00:17:55.738-07:00",
"updated_at": "2025-07-12T00:17:55.738-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/on_call_shadow_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/schedules/{schedule_id}/override_shifts": {
"parameters": [
{
"name": "schedule_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "creates an override shift",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OverrideShifts"
],
"description": "Creates a new override shift from provided data",
"operationId": "createOverrideShift",
"parameters": [],
"responses": {
"201": {
"description": "override_shift created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "0a284ed2-d648-4194-ba8a-43642cd94c00",
"type": "shifts",
"attributes": {
"schedule_id": "7c7fbff5-464b-4e30-8ec6-bb5c76a1da13",
"rotation_id": null,
"starts_at": "2025-07-12T02:17:59.000-07:00",
"ends_at": "2025-07-13T00:17:59.000-07:00",
"is_override": true
},
"relationships": {
"shift_override": {
"data": {
"id": "db13db6b-09d0-49ba-8c31-5b6a92f1f269",
"type": "shift_overrides"
}
},
"user": {
"data": {
"id": "346",
"type": "users"
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/override_shift_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "User must exist",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_override_shift"
}
}
},
"required": true
}
},
"get": {
"summary": "List override shifts",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OverrideShifts"
],
"description": "List override shifts",
"operationId": "listOverrideShifts",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/override_shift_list"
}
}
}
}
}
}
},
"/v1/override_shifts/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an override shift",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OverrideShifts"
],
"description": "Retrieves a specific override shift by id",
"operationId": "getOverrideShift",
"responses": {
"200": {
"description": "override shift found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "48d79384-c7af-4ba9-a203-957f8acc65c7",
"type": "shifts",
"attributes": {
"schedule_id": "7c7fbff5-464b-4e30-8ec6-bb5c76a1da13",
"rotation_id": "ab860145-4d0b-4fbd-b1b7-44b22c007f9a",
"starts_at": "2025-07-11T18:17:59.000-07:00",
"ends_at": "2025-07-12T02:17:59.000-07:00",
"is_override": true
},
"relationships": {
"shift_override": {
"data": null
},
"user": {
"data": {
"id": "354",
"type": "users"
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/override_shift_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an override shift",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OverrideShifts"
],
"description": "Update a specific override shift by id",
"operationId": "updateOverrideShift",
"parameters": [],
"responses": {
"200": {
"description": "override shift updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "48d79384-c7af-4ba9-a203-957f8acc65c7",
"type": "shifts",
"attributes": {
"schedule_id": "7c7fbff5-464b-4e30-8ec6-bb5c76a1da13",
"rotation_id": "ab860145-4d0b-4fbd-b1b7-44b22c007f9a",
"starts_at": "2025-07-11T18:17:59.000-07:00",
"ends_at": "2025-07-12T02:17:59.000-07:00",
"is_override": true
},
"relationships": {
"shift_override": {
"data": {
"id": "adf47ad7-b0a2-4705-b971-e99a3f2cfce1",
"type": "shift_overrides"
}
},
"user": {
"data": {
"id": "355",
"type": "users"
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/override_shift_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_override_shift"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an override shift",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OverrideShifts"
],
"description": "Delete a specific override shift by id",
"operationId": "deleteOverrideShift",
"responses": {
"200": {
"description": "override shift deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "48d79384-c7af-4ba9-a203-957f8acc65c7",
"type": "shifts",
"attributes": {
"schedule_id": "7c7fbff5-464b-4e30-8ec6-bb5c76a1da13",
"rotation_id": "ab860145-4d0b-4fbd-b1b7-44b22c007f9a",
"starts_at": "2025-07-11T18:17:59.000-07:00",
"ends_at": "2025-07-12T02:17:59.000-07:00",
"is_override": true
},
"relationships": {
"shift_override": {
"data": null
},
"user": {
"data": {
"id": "354",
"type": "users"
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/override_shift_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/playbooks/{playbook_id}/playbook_tasks": {
"parameters": [
{
"name": "playbook_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a playbook task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"PlaybookTasks"
],
"description": "Creates a new task from provided data",
"operationId": "createPlaybookTask",
"parameters": [],
"responses": {
"201": {
"description": "playbook_task created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "967dd26e-d9c5-4a12-8fc8-1f9eba8fc297",
"type": "playbook_tasks",
"attributes": {
"playbook_id": "951b1c16-2989-4091-8ef6-320fc3e20728",
"task": "New task",
"description": "New task description",
"position": 1,
"created_at": "2025-07-12T00:18:04.940-07:00",
"updated_at": "2025-07-12T00:18:04.940-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/playbook_task_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Task can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_playbook_task"
}
}
},
"required": true
}
},
"get": {
"summary": "List playbook tasks",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"PlaybookTasks"
],
"description": "List playbook tasks",
"operationId": "listPlaybookTasks",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/playbook_task_list"
}
}
}
}
}
}
},
"/v1/playbook_tasks/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a playbook task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"PlaybookTasks"
],
"description": "Retrieves a specific playbook_task by id",
"operationId": "getPlaybookTask",
"responses": {
"200": {
"description": "playbook_task found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "2edaed76-b2b7-42f0-8aed-9959ccdce45b",
"type": "playbook_tasks",
"attributes": {
"playbook_id": "951b1c16-2989-4091-8ef6-320fc3e20728",
"task": "Sed natus qui consequuntur.",
"description": "Necessitatibus nihil consectetur dolores.",
"position": 3,
"created_at": "2025-07-12T00:18:04.717-07:00",
"updated_at": "2025-07-12T00:18:04.725-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/playbook_task_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a playbook task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"PlaybookTasks"
],
"description": "Update a specific playbook task by id",
"operationId": "updatePlaybookTask",
"parameters": [],
"responses": {
"200": {
"description": "playbook_task updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "2edaed76-b2b7-42f0-8aed-9959ccdce45b",
"type": "playbook_tasks",
"attributes": {
"playbook_id": "951b1c16-2989-4091-8ef6-320fc3e20728",
"task": "Task updated",
"description": "Task description updated",
"position": 2,
"created_at": "2025-07-12T00:18:04.717-07:00",
"updated_at": "2025-07-12T00:18:06.442-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/playbook_task_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_playbook_task"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a playbook task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"PlaybookTasks"
],
"description": "Delete a specific playbook task by id",
"operationId": "deletePlaybookTask",
"responses": {
"200": {
"description": "playbook_task deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "2edaed76-b2b7-42f0-8aed-9959ccdce45b",
"type": "playbook_tasks",
"attributes": {
"playbook_id": "951b1c16-2989-4091-8ef6-320fc3e20728",
"task": "Sed natus qui consequuntur.",
"description": "Necessitatibus nihil consectetur dolores.",
"position": 3,
"created_at": "2025-07-12T00:18:04.717-07:00",
"updated_at": "2025-07-12T00:18:07.142-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/playbook_task_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/playbooks": {
"post": {
"summary": "Creates a playbook",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Playbooks"
],
"description": "Creates a new playbook from provided data",
"operationId": "createPlaybook",
"parameters": [],
"responses": {
"201": {
"description": "playbook created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "b4d3819e-5460-400a-a1cd-ad7c62c0b1ff",
"type": "playbooks",
"attributes": {
"title": "How to handle customer-facing incident?",
"summary": "This is a summary",
"external_url": null,
"severity_ids": [],
"environment_ids": [
"1516015b-5b83-4355-af65-7013cbf48e88",
"b5b96fb1-d257-44ee-bed1-b547ecbf99dd"
],
"service_ids": [
"bd4ab3b8-861a-4157-9c70-7f18ddc4357c",
"22117947-362e-47d9-acd8-0ddc7c364ed3"
],
"functionality_ids": [
"18a797b0-4b6b-47c4-ba5f-18d3b3d1e6ae",
"eacd1fa7-2cc4-41c8-a8ce-f591a2074949"
],
"group_ids": [],
"incident_type_ids": [],
"cause_ids": [],
"created_at": "2025-07-12T00:18:12.027-07:00",
"updated_at": "2025-07-12T00:18:12.027-07:00"
},
"relationships": {
"severities": {
"data": []
},
"environments": {
"data": [
{
"id": "1516015b-5b83-4355-af65-7013cbf48e88",
"type": "environments"
},
{
"id": "b5b96fb1-d257-44ee-bed1-b547ecbf99dd",
"type": "environments"
}
]
},
"services": {
"data": [
{
"id": "bd4ab3b8-861a-4157-9c70-7f18ddc4357c",
"type": "services"
},
{
"id": "22117947-362e-47d9-acd8-0ddc7c364ed3",
"type": "services"
}
]
},
"functionalities": {
"data": [
{
"id": "18a797b0-4b6b-47c4-ba5f-18d3b3d1e6ae",
"type": "functionalities"
},
{
"id": "eacd1fa7-2cc4-41c8-a8ce-f591a2074949",
"type": "functionalities"
}
]
},
"groups": {
"data": []
},
"causes": {
"data": []
},
"incident_types": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/playbook_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Title can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_playbook"
}
}
},
"required": true
}
},
"get": {
"summary": "List playbooks",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Playbooks"
],
"description": "List playbooks",
"operationId": "listPlaybooks",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: severities,environments,services",
"schema": {
"type": "string",
"enum": [
"severities",
"environments",
"services",
"functionalities",
"groups",
"causes",
"incident_types"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/playbook_list"
}
}
}
}
}
}
},
"/v1/playbooks/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a playbook",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Playbooks"
],
"description": "Retrieves a specific playbook by id",
"operationId": "getPlaybook",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: severities,environments,services",
"schema": {
"type": "string",
"enum": [
"severities",
"environments",
"services",
"functionalities",
"groups",
"causes",
"incident_types"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "playbook found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "0f072d5e-2737-4ee9-9a42-07d9847cabe7",
"type": "playbooks",
"attributes": {
"title": "Maiores et saepe ut.",
"summary": null,
"external_url": null,
"severity_ids": [],
"environment_ids": [],
"service_ids": [],
"functionality_ids": [],
"group_ids": [],
"incident_type_ids": [],
"cause_ids": [],
"created_at": "2025-07-12T00:18:09.096-07:00",
"updated_at": "2025-07-12T00:18:09.096-07:00"
},
"relationships": {
"severities": {
"data": []
},
"environments": {
"data": []
},
"services": {
"data": []
},
"functionalities": {
"data": []
},
"groups": {
"data": []
},
"causes": {
"data": []
},
"incident_types": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/playbook_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a playbook",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Playbooks"
],
"description": "Update a specific playbook by id",
"operationId": "updatePlaybook",
"parameters": [],
"responses": {
"200": {
"description": "playbook updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "0f072d5e-2737-4ee9-9a42-07d9847cabe7",
"type": "playbooks",
"attributes": {
"title": "How to handle security incident?",
"summary": "This is a summary",
"external_url": null,
"severity_ids": [],
"environment_ids": [],
"service_ids": [],
"functionality_ids": [],
"group_ids": [],
"incident_type_ids": [],
"cause_ids": [],
"created_at": "2025-07-12T00:18:09.096-07:00",
"updated_at": "2025-07-12T00:18:13.664-07:00"
},
"relationships": {
"severities": {
"data": []
},
"environments": {
"data": []
},
"services": {
"data": []
},
"functionalities": {
"data": []
},
"groups": {
"data": []
},
"causes": {
"data": []
},
"incident_types": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/playbook_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_playbook"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a playbook",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Playbooks"
],
"description": "Delete a specific playbook by id",
"operationId": "deletePlaybook",
"responses": {
"200": {
"description": "playbook deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "0f072d5e-2737-4ee9-9a42-07d9847cabe7",
"type": "playbooks",
"attributes": {
"title": "Maiores et saepe ut.",
"summary": null,
"external_url": null,
"severity_ids": [],
"environment_ids": [],
"service_ids": [],
"functionality_ids": [],
"group_ids": [],
"incident_type_ids": [],
"cause_ids": [],
"created_at": "2025-07-12T00:18:09.096-07:00",
"updated_at": "2025-07-12T00:18:14.428-07:00"
},
"relationships": {
"severities": {
"data": []
},
"environments": {
"data": []
},
"services": {
"data": []
},
"functionalities": {
"data": []
},
"groups": {
"data": []
},
"causes": {
"data": []
},
"incident_types": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/playbook_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/post_mortem_templates": {
"post": {
"summary": "Creates a retrospective template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveTemplates"
],
"description": "Creates a new Retrospective Template from provided data",
"operationId": "createPostmortemTemplate",
"parameters": [],
"responses": {
"201": {
"description": "post_mortem_template created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "77406875-7df4-4c93-8870-bdf537eb06b6",
"type": "post_mortem_templates",
"attributes": {
"name": "My Retrospective Template",
"slug": "my-retrospective-template",
"format": "markdown",
"default": false,
"content": "<div class=\"trix-content\">\n <h2>Test template</h2>\n\n<h3>Test new line</h3>\n</div>\n",
"created_at": "2025-07-12T00:18:17.568-07:00",
"updated_at": "2025-07-12T00:18:17.571-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/post_mortem_template_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_post_mortem_template"
}
}
},
"required": true
}
},
"get": {
"summary": "List Retrospective Templates",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveTemplates"
],
"description": "List Retrospective Templates",
"operationId": "listPostmortemTemplates",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/post_mortem_template_list"
}
}
}
}
}
}
},
"/v1/post_mortem_templates/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a Retrospective Template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveTemplates"
],
"description": "Retrieves a specific Retrospective Template by id",
"operationId": "getPostmortemTemplate",
"responses": {
"200": {
"description": "Retrospective Template found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "7c047213-cd26-4124-a446-988d0c2ab3ad",
"type": "post_mortem_templates",
"attributes": {
"name": "Architecto modi non quo.",
"slug": "architecto-modi-non-quo",
"format": "html",
"default": false,
"content": "",
"created_at": "2025-07-12T00:18:15.774-07:00",
"updated_at": "2025-07-12T00:18:15.782-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/post_mortem_template_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a Retrospective Template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveTemplates"
],
"description": "Update a specific Retrospective Template by id",
"operationId": "updatePostmortemTemplate",
"parameters": [],
"responses": {
"200": {
"description": "Retrospective Template updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "7c047213-cd26-4124-a446-988d0c2ab3ad",
"type": "post_mortem_templates",
"attributes": {
"name": "My Retrospective Template Updated",
"slug": "architecto-modi-non-quo",
"format": "markdown",
"default": false,
"content": "<div class=\"trix-content\">\n <h2>Test update template</h2>\n\n<h3>Test new line</h3>\n</div>\n",
"created_at": "2025-07-12T00:18:15.774-07:00",
"updated_at": "2025-07-12T00:18:18.640-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/post_mortem_template_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_post_mortem_template"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a Retrospective Template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveTemplates"
],
"description": "Delete a specific Retrospective Template by id",
"operationId": "deletePostmortemTemplate",
"responses": {
"200": {
"description": "Retrospective Template deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "7c047213-cd26-4124-a446-988d0c2ab3ad",
"type": "post_mortem_templates",
"attributes": {
"name": "Architecto modi non quo.",
"slug": "architecto-modi-non-quo",
"format": "html",
"default": false,
"content": "",
"created_at": "2025-07-12T00:18:15.774-07:00",
"updated_at": "2025-07-12T00:18:19.070-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/post_mortem_template_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/pulses": {
"post": {
"summary": "Creates a pulse",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Pulses"
],
"description": "Creates a new pulse from provided data",
"operationId": "createPulse",
"parameters": [],
"responses": {
"201": {
"description": "pulse created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "053d8e95-4439-4290-bcfd-ec6bca3cde59",
"type": "pulses",
"attributes": {
"short_id": null,
"source": "k8s",
"summary": "Deploy k8s",
"labels": [
{
"key": "status",
"value": "succeeded"
}
],
"refs": [
{
"key": "sha",
"value": "cd62148cbc5eb42168fe99fdb50a364e12b206ac"
},
{
"key": "image",
"value": "registry.rootly.com/rootly/my-service:cd6214"
}
],
"services": [
{
"id": "23060b7a-b168-4901-a271-c3d6ace50dd0",
"team_id": 321,
"name": "Provident molestiae alias nam.",
"slug": "provident-molestiae-alias-nam",
"description": "Qui hic recusandae vero.",
"deleted_at": null,
"created_at": "2025-07-12T00:18:20.347-07:00",
"updated_at": "2025-07-12T00:18:20.347-07:00",
"opsgenie_id": null,
"pagerduty_id": null,
"public_description": null,
"github_repository_branch": "master",
"github_repository_name": null,
"color": "#D7F5E1",
"heroku_app_name": null,
"gitlab_repository_name": null,
"gitlab_repository_branch": "master",
"kubernetes_deployment_name": null,
"incidents_count": 0,
"position": 1,
"slack_channels": [],
"slack_aliases": [],
"backstage_id": null,
"show_uptime": true,
"show_uptime_last_days": 60,
"status": "operational",
"external_id": null,
"notify_emails": [],
"cortex_id": null,
"alerts_email_enabled": false,
"alerts_email_address": "service-116679e23a52a244d09f8fc9941ca979@email.rootly.com",
"opsgenie_team_id": null,
"service_now_ci_sys_id": null,
"alert_urgency_id": null,
"opslevel_id": null,
"datadog_id": null
}
],
"environments": [
{
"id": "8d734062-af60-4484-ad5a-bf1e38ce205f",
"team_id": 321,
"name": "In non veniam iste.",
"slug": "in-non-veniam-iste",
"description": "Fugiat magnam occaecati laboriosam.",
"color": "#141514",
"deleted_at": null,
"created_at": "2025-07-12T00:18:20.359-07:00",
"updated_at": "2025-07-12T00:18:20.359-07:00",
"incidents_count": 0,
"position": 1,
"slack_channels": [],
"slack_aliases": [],
"external_id": null,
"notify_emails": []
}
],
"data": {
"url": "https://additionaldata.com"
},
"external_url": "https://external-url.com",
"started_at": "2025-07-12T00:09:32.000-07:00",
"ended_at": "2025-07-12T00:11:32.000-07:00",
"created_at": "2025-07-12T00:18:22.278-07:00",
"updated_at": "2025-07-12T00:18:22.278-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/pulse_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Summary can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_pulse"
}
}
},
"required": true
}
},
"get": {
"summary": "List pulses",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Pulses"
],
"description": "List pulses",
"operationId": "listPulses",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[source]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[services]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environments]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[labels]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[refs]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[ended_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[ended_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[ended_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[ended_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/pulse_list"
}
}
}
}
}
}
},
"/v1/pulses/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a pulse",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Pulses"
],
"description": "Retrieves a specific pulse by id",
"operationId": "getPulse",
"responses": {
"200": {
"description": "pulse found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "fbea9901-a0d7-4769-9daf-fcd15926bb38",
"type": "pulses",
"attributes": {
"short_id": null,
"source": "unknown",
"summary": "Corporis ut minus qui.",
"labels": [],
"refs": [],
"services": [],
"environments": [],
"data": {},
"external_url": null,
"started_at": "2025-07-12T00:18:20.301-07:00",
"ended_at": null,
"created_at": "2025-07-12T00:18:20.301-07:00",
"updated_at": "2025-07-12T00:18:20.301-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/pulse_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a pulse",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Pulses"
],
"description": "Update a specific pulse by id",
"operationId": "updatePulse",
"parameters": [],
"responses": {
"200": {
"description": "pulse updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "fbea9901-a0d7-4769-9daf-fcd15926bb38",
"type": "pulses",
"attributes": {
"short_id": null,
"source": "unknown",
"summary": "Deploy k8s",
"labels": [],
"refs": [],
"services": [
{
"id": "4a7d2a93-066a-43bb-b977-cd7e889b12ac",
"team_id": 321,
"name": "Velit ex non sint.",
"slug": "velit-ex-non-sint",
"description": "Animi sequi fuga aut.",
"deleted_at": null,
"created_at": "2025-07-12T00:18:20.367-07:00",
"updated_at": "2025-07-12T00:18:20.367-07:00",
"opsgenie_id": null,
"pagerduty_id": null,
"public_description": null,
"github_repository_branch": "master",
"github_repository_name": null,
"color": "#F5D9C4",
"heroku_app_name": null,
"gitlab_repository_name": null,
"gitlab_repository_branch": "master",
"kubernetes_deployment_name": null,
"incidents_count": 0,
"position": 2,
"slack_channels": [],
"slack_aliases": [],
"backstage_id": null,
"show_uptime": true,
"show_uptime_last_days": 60,
"status": "operational",
"external_id": null,
"notify_emails": [],
"cortex_id": null,
"alerts_email_enabled": false,
"alerts_email_address": "service-c7ed8e2b84df1ce3b5bc54b794403410@email.rootly.com",
"opsgenie_team_id": null,
"service_now_ci_sys_id": null,
"alert_urgency_id": null,
"opslevel_id": null,
"datadog_id": null
}
],
"environments": [
{
"id": "6f532fbe-87a1-4062-93cb-7649790113f2",
"team_id": 321,
"name": "Voluptatibus eius quis voluptas.",
"slug": "voluptatibus-eius-quis-voluptas",
"description": "Reiciendis recusandae amet eos.",
"color": "#afb6b6",
"deleted_at": null,
"created_at": "2025-07-12T00:18:20.379-07:00",
"updated_at": "2025-07-12T00:18:20.379-07:00",
"incidents_count": 0,
"position": 2,
"slack_channels": [],
"slack_aliases": [],
"external_id": null,
"notify_emails": []
}
],
"data": {},
"external_url": null,
"started_at": "2025-07-12T00:18:20.301-07:00",
"ended_at": null,
"created_at": "2025-07-12T00:18:20.301-07:00",
"updated_at": "2025-07-12T00:18:23.983-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/pulse_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_pulse"
}
}
},
"required": true
}
}
},
"/v1/retrospective_configurations": {
"get": {
"summary": "List retrospective configurations",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveConfigurations"
],
"description": "List retrospective configurations",
"operationId": "listRetrospectiveConfigurations",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: severities,groups",
"schema": {
"type": "string",
"enum": [
"severities",
"groups",
"incident_types"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_configuration_list"
}
}
}
}
}
}
},
"/v1/retrospective_configurations/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a Retrospective Configuration",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveConfigurations"
],
"description": "Retrieves a specific retrospective_configuration by id",
"operationId": "getRetrospectiveConfiguration",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: severities,groups",
"schema": {
"type": "string",
"enum": [
"severities",
"groups",
"incident_types"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "retrospective_configuration found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "3734b4e6-1d19-4124-a9de-3f6a6ff0ed59",
"type": "retrospective_configurations",
"attributes": {
"kind": "skip",
"severity_ids": [
"729d3709-3490-49a3-8cb4-c580778e783a"
],
"incident_type_ids": [],
"group_ids": [],
"created_at": "2025-07-12T00:18:25.402-07:00",
"updated_at": "2025-07-12T00:18:25.402-07:00"
},
"relationships": {
"severities": {
"data": [
{
"id": "729d3709-3490-49a3-8cb4-c580778e783a",
"type": "severities"
}
]
},
"groups": {
"data": []
},
"incident_types": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/retrospective_configuration_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a retrospective configuration",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveConfigurations"
],
"description": "Update a specific retrospective configuration by id",
"operationId": "updateRetrospectiveConfiguration",
"parameters": [],
"responses": {
"200": {
"description": "retrospective configuration updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "01ad4d4d-f059-4ea1-a7d2-942a3ccfae72",
"type": "retrospective_configurations",
"attributes": {
"kind": "skip",
"severity_ids": [],
"incident_type_ids": [],
"group_ids": [
"1b41c61d-8dec-4a9b-a0c0-61f9b75e51f6"
],
"created_at": "2025-07-12T00:18:27.721-07:00",
"updated_at": "2025-07-12T00:18:27.721-07:00"
},
"relationships": {
"severities": {
"data": []
},
"groups": {
"data": [
{
"id": "1b41c61d-8dec-4a9b-a0c0-61f9b75e51f6",
"type": "groups"
}
]
},
"incident_types": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/retrospective_configuration_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_retrospective_configuration"
}
}
},
"required": true
}
}
},
"/v1/retrospective_process_groups/{retrospective_process_group_id}/steps": {
"parameters": [
{
"name": "retrospective_process_group_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a retrospective process group step",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcessGroupSteps"
],
"description": "Creates a new retrospective process group step from provided data",
"operationId": "createRetrospectiveProcessGroupStep",
"parameters": [],
"responses": {
"201": {
"description": "retrospective_process_group_step created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "e93e09be-871d-419a-bd23-ab420f6739f5",
"type": "retrospective_process_group_steps",
"attributes": {
"retrospective_process_group_id": "2c2fc91f-a4f5-4c09-ae73-c1824c7ca091",
"retrospective_step_id": "03f60afc-dd9e-4fce-a970-9f2dabcd1972",
"position": 1,
"updated_at": "2025-07-12T00:18:31.359-07:00",
"created_at": "2025-07-12T00:18:31.359-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/retrospective_process_group_step_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_retrospective_process_group_step"
}
}
},
"required": true
}
},
"get": {
"summary": "List RetrospectiveProcessGroup Steps",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcessGroupSteps"
],
"description": "List RetrospectiveProcessGroup Steps",
"operationId": "listRetrospectiveProcessGroupSteps",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[retrospective_step_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_process_group_step_list"
}
}
}
}
}
}
},
"/v1/retrospective_process_group_steps/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a RetrospectiveProcessGroup Step",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcessGroupSteps"
],
"description": "Retrieves a specific RetrospectiveProcessGroup Step by id",
"operationId": "getRetrospectiveProcessGroupStep",
"responses": {
"200": {
"description": "sub_status found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "fce1ae1b-dd80-4622-8445-0a0b372db86d",
"type": "retrospective_process_group_steps",
"attributes": {
"retrospective_process_group_id": "2c2fc91f-a4f5-4c09-ae73-c1824c7ca091",
"retrospective_step_id": "b5c2db20-1e75-4729-af17-c8d29ccf365d",
"position": 1,
"updated_at": "2025-07-12T00:18:32.036-07:00",
"created_at": "2025-07-12T00:18:32.036-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/retrospective_process_group_step_response"
}
}
}
}
}
},
"put": {
"summary": "Update RetrospectiveProcessGroup Step",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcessGroupSteps"
],
"description": "Update a specific RetrospectiveProcessGroup Step by id",
"operationId": "updateRetrospectiveProcessGroupStep",
"parameters": [],
"responses": {
"200": {
"description": "retrospective_process_group_step updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "606ab3bc-bee9-46c1-840d-a3dac0940893",
"type": "retrospective_process_group_steps",
"attributes": {
"retrospective_process_group_id": "2c2fc91f-a4f5-4c09-ae73-c1824c7ca091",
"retrospective_step_id": "20448f33-05d9-46c0-90d6-b78c7ee808e3",
"position": 2,
"updated_at": "2025-07-12T00:18:32.853-07:00",
"created_at": "2025-07-12T00:18:32.622-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/retrospective_process_group_step_response"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_retrospective_process_group_step"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a RetrospectiveProcessGroup Step",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcessGroupSteps"
],
"description": "Delete a specific RetrospectiveProcessGroup Step by id",
"operationId": "deleteRetrospectiveProcessGroupStep",
"responses": {
"200": {
"description": "retrospective_process_group_step deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "403cabd6-bf69-4077-97bc-be8638cf0e89",
"type": "retrospective_process_group_steps",
"attributes": {
"retrospective_process_group_id": "2c2fc91f-a4f5-4c09-ae73-c1824c7ca091",
"retrospective_step_id": "993949d2-682f-4d40-824e-2e86c83e1922",
"position": 1,
"updated_at": "2025-07-12T00:18:33.776-07:00",
"created_at": "2025-07-12T00:18:33.649-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/retrospective_process_group_step_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/retrospective_processes/{retrospective_process_id}/groups": {
"parameters": [
{
"name": "retrospective_process_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a retrospective process group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcessGroups"
],
"description": "Creates a new retrospective process group from provided data",
"operationId": "createRetrospectiveProcessGroup",
"parameters": [],
"responses": {
"201": {
"description": "retrospective_process_group created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "6552f258-87c3-4df4-9277-63a954d8a315",
"type": "retrospective_process_groups",
"attributes": {
"retrospective_process_id": "c52733d2-d99d-441f-8d9f-7d2176e6430c",
"sub_status_id": "e20f5ee0-3bd1-4da1-ae99-1fb33ea3b496",
"position": 3,
"updated_at": "2025-07-12T00:18:35.960-07:00",
"created_at": "2025-07-12T00:18:35.960-07:00"
},
"relationships": {
"retrospective_process_group_steps": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/retrospective_process_group_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_retrospective_process_group"
}
}
},
"required": true
}
},
"get": {
"summary": "List Retrospective Process Groups",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcessGroups"
],
"description": "List Retrospective Process Groups",
"operationId": "listRetrospectiveProcessGroups",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: retrospective_process_group_steps",
"schema": {
"type": "string",
"enum": [
"retrospective_process_group_steps"
]
},
"required": false
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at",
"position",
"-position"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[sub_status_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_process_group_list"
}
}
}
}
}
}
},
"/v1/retrospective_process_groups/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a Retrospective Process Group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcessGroups"
],
"description": "Retrieves a specific Retrospective Process Group by id",
"operationId": "getRetrospectiveProcessGroup",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: retrospective_process_group_steps",
"schema": {
"type": "string",
"enum": [
"retrospective_process_group_steps"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "sub_status found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "54ace574-bc15-457e-9b59-d6c095ee4f3a",
"type": "retrospective_process_groups",
"attributes": {
"retrospective_process_id": "c52733d2-d99d-441f-8d9f-7d2176e6430c",
"sub_status_id": "e419da44-bc0f-4e67-88da-374d3edfdd42",
"position": 1,
"updated_at": "2025-07-12T00:18:35.485-07:00",
"created_at": "2025-07-12T00:18:35.485-07:00"
},
"relationships": {
"retrospective_process_group_steps": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/retrospective_process_group_response"
}
}
}
}
}
},
"put": {
"summary": "Update a Retrospective Process Group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcessGroups"
],
"description": "Update a specific Retrospective Process Group by id",
"operationId": "updateRetrospectiveProcessGroup",
"parameters": [],
"responses": {
"200": {
"description": "retrospective_process_group updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "54ace574-bc15-457e-9b59-d6c095ee4f3a",
"type": "retrospective_process_groups",
"attributes": {
"retrospective_process_id": "c52733d2-d99d-441f-8d9f-7d2176e6430c",
"sub_status_id": "e419da44-bc0f-4e67-88da-374d3edfdd42",
"position": 1,
"updated_at": "2025-07-12T00:18:35.485-07:00",
"created_at": "2025-07-12T00:18:35.485-07:00"
},
"relationships": {
"retrospective_process_group_steps": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/retrospective_process_group_response"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_retrospective_process_group"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a Retrospective Process Group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcessGroups"
],
"description": "Delete a specific Retrospective Process Group by id",
"operationId": "deleteRetrospectiveProcessGroup",
"responses": {
"200": {
"description": "retrospective_process_group deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "54ace574-bc15-457e-9b59-d6c095ee4f3a",
"type": "retrospective_process_groups",
"attributes": {
"retrospective_process_id": "c52733d2-d99d-441f-8d9f-7d2176e6430c",
"sub_status_id": "e419da44-bc0f-4e67-88da-374d3edfdd42",
"position": 1,
"updated_at": "2025-07-12T00:18:36.737-07:00",
"created_at": "2025-07-12T00:18:35.485-07:00"
},
"relationships": {
"retrospective_process_group_steps": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/retrospective_process_group_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/retrospective_processes": {
"post": {
"summary": "Creates a retrospective process",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcesses"
],
"description": "Creates a new retrospective process from provided data",
"operationId": "createRetrospectiveProcess",
"parameters": [],
"responses": {
"201": {
"description": "retrospective_process created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "e3ffd0ed-f8bc-4364-ba7f-fe5089b099b0",
"type": "retrospective_processes",
"attributes": {
"name": "Retrospective Process 1",
"description": "Retrospective Process 1 Description",
"is_default": false,
"created_at": "2025-07-12T00:18:39.855-07:00",
"updated_at": "2025-07-12T00:18:39.855-07:00",
"retrospective_process_matching_criteria": {
"severity_ids": [
"39d4122f-d10f-4b35-a172-1dd91570370a"
]
}
},
"relationships": {
"retrospective_steps": {
"data": [
{
"id": "5e9cc7dc-ebb1-449c-93c4-3c40fb35037d",
"type": "retrospective_steps"
},
{
"id": "e6abf8b4-f81a-4719-9c18-31044994b9f9",
"type": "retrospective_steps"
}
]
},
"severities": {
"data": [
{
"id": "39d4122f-d10f-4b35-a172-1dd91570370a",
"type": "severities"
}
]
}
}
}
},
"schema": {
"$ref": "#/components/schemas/retrospective_process_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"name": [
"can't be blank"
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_retrospective_process"
}
}
},
"required": true
}
},
"get": {
"summary": "List retrospective processes",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcesses"
],
"description": "List retrospective processes",
"operationId": "listRetrospectiveProcesses",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: retrospective_steps,severities",
"schema": {
"type": "string",
"enum": [
"retrospective_steps",
"severities",
"incident_types",
"groups"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_process_list"
}
}
}
}
}
}
},
"/v1/retrospective_processes/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a retrospective process",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcesses"
],
"description": "Retrieves a specific retrospective process by id",
"operationId": "getRetrospectiveProcess",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: retrospective_steps,severities",
"schema": {
"type": "string",
"enum": [
"retrospective_steps",
"severities",
"incident_types",
"groups"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "retrospective_process found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "0aaa33ce-dc29-46ab-9695-c6fbced566c4",
"type": "retrospective_processes",
"attributes": {
"name": "Aliquam dolorem eos neque.",
"description": "Eum tenetur aut. Impedit sit qui. Eum tempore perferendis.",
"is_default": false,
"created_at": "2025-07-12T00:18:38.005-07:00",
"updated_at": "2025-07-12T00:18:38.005-07:00",
"retrospective_process_matching_criteria": {
"incident_type_ids": [
"6f90754a-f375-4e7c-94ca-4efb59f696b2"
]
}
},
"relationships": {
"retrospective_steps": {
"data": [
{
"id": "701a4c0f-0d6c-4217-85c8-0d5f0c6463e8",
"type": "retrospective_steps"
},
{
"id": "6db5f017-1faa-4b2e-b713-f0825fd3c013",
"type": "retrospective_steps"
}
]
},
"incident_types": {
"data": [
{
"id": "6f90754a-f375-4e7c-94ca-4efb59f696b2",
"type": "incident_types"
}
]
}
}
}
},
"schema": {
"$ref": "#/components/schemas/retrospective_process_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a retrospective process",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcesses"
],
"description": "Updates a specific retrospective process by id",
"operationId": "updateRetrospectiveProcess",
"parameters": [],
"responses": {
"200": {
"description": "retrospective_process updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "0aaa33ce-dc29-46ab-9695-c6fbced566c4",
"type": "retrospective_processes",
"attributes": {
"name": "Retrospective Process 2",
"description": "Retrospective Process 2 description",
"is_default": false,
"created_at": "2025-07-12T00:18:38.005-07:00",
"updated_at": "2025-07-12T00:18:41.683-07:00",
"retrospective_process_matching_criteria": {
"group_ids": [
"a7af374d-8cc1-4ab9-860f-7179e06871a3"
]
}
},
"relationships": {
"retrospective_steps": {
"data": [
{
"id": "701a4c0f-0d6c-4217-85c8-0d5f0c6463e8",
"type": "retrospective_steps"
},
{
"id": "6db5f017-1faa-4b2e-b713-f0825fd3c013",
"type": "retrospective_steps"
}
]
},
"groups": {
"data": [
{
"id": "a7af374d-8cc1-4ab9-860f-7179e06871a3",
"type": "groups"
}
]
}
}
}
},
"schema": {
"$ref": "#/components/schemas/retrospective_process_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_retrospective_process"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a retrospective process",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcesses"
],
"description": "Delete a specific retrospective process by id",
"operationId": "deleteRetrospectiveProcess",
"responses": {
"200": {
"description": "retrospective_process deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "0aaa33ce-dc29-46ab-9695-c6fbced566c4",
"type": "retrospective_processes",
"attributes": {
"name": "Aliquam dolorem eos neque.",
"description": "Eum tenetur aut. Impedit sit qui. Eum tempore perferendis.",
"is_default": false,
"created_at": "2025-07-12T00:18:38.005-07:00",
"updated_at": "2025-07-12T00:18:42.141-07:00",
"retrospective_process_matching_criteria": {
"incident_type_ids": [
"6f90754a-f375-4e7c-94ca-4efb59f696b2"
]
}
},
"relationships": {
"retrospective_steps": {
"data": [
{
"id": "701a4c0f-0d6c-4217-85c8-0d5f0c6463e8",
"type": "retrospective_steps"
},
{
"id": "6db5f017-1faa-4b2e-b713-f0825fd3c013",
"type": "retrospective_steps"
}
]
},
"incident_types": {
"data": [
{
"id": "6f90754a-f375-4e7c-94ca-4efb59f696b2",
"type": "incident_types"
}
]
}
}
}
},
"schema": {
"$ref": "#/components/schemas/retrospective_process_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/retrospective_processes/{retrospective_process_id}/retrospective_steps": {
"parameters": [
{
"name": "retrospective_process_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a retrospective step",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveSteps"
],
"description": "Creates a new retrospective step from provided data",
"operationId": "createRetrospectiveStep",
"parameters": [],
"responses": {
"201": {
"description": "retrospective_step created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "e0a005bc-2388-4238-88e8-2c34b01c81c7",
"type": "retrospective_steps",
"attributes": {
"retrospective_process_id": "a3503efb-4236-4d28-9c00-db3e10889604",
"title": "Step 1",
"description": "Step 1 description",
"incident_role_id": "7c1ccb7e-3183-4c96-8315-4297d497665b",
"due_after_days": 5,
"position": 1,
"skippable": false,
"created_at": "2025-07-12T00:18:43.530-07:00",
"updated_at": "2025-07-12T00:18:43.530-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/retrospective_step_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Title can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_retrospective_step"
}
}
},
"required": true
}
},
"get": {
"summary": "List retrospective steps",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveSteps"
],
"description": "List retrospective steps",
"operationId": "listRetrospectiveSteps",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_step_list"
}
}
}
}
}
}
},
"/v1/retrospective_steps/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a retrospective step",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveSteps"
],
"description": "Retrieves a specific retrospective step by id",
"operationId": "getRetrospectiveStep",
"responses": {
"200": {
"description": "retrospective_step found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "a345d715-4fbe-49e5-9ee3-9d7264b0b8e1",
"type": "retrospective_steps",
"attributes": {
"retrospective_process_id": "a3503efb-4236-4d28-9c00-db3e10889604",
"title": "Step 11",
"description": "Bar",
"incident_role_id": "7c1ccb7e-3183-4c96-8315-4297d497665b",
"due_after_days": null,
"position": 1,
"skippable": true,
"created_at": "2025-07-12T00:18:43.376-07:00",
"updated_at": "2025-07-12T00:18:43.376-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/retrospective_step_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a retrospective step",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveSteps"
],
"description": "Update a specific retrospective step by id",
"operationId": "updateRetrospectiveStep",
"parameters": [],
"responses": {
"200": {
"description": "retrospective_step updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "a345d715-4fbe-49e5-9ee3-9d7264b0b8e1",
"type": "retrospective_steps",
"attributes": {
"retrospective_process_id": "a3503efb-4236-4d28-9c00-db3e10889604",
"title": "Step 2",
"description": "Step 2 description",
"incident_role_id": "40b62a78-60ef-4255-a660-e069eef7fba4",
"due_after_days": 7,
"position": 2,
"skippable": true,
"created_at": "2025-07-12T00:18:43.376-07:00",
"updated_at": "2025-07-12T00:18:44.517-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/retrospective_step_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_retrospective_step"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a retrospective step",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveSteps"
],
"description": "Delete a specific retrospective step by id",
"operationId": "deleteRetrospectiveStep",
"responses": {
"200": {
"description": "retrospective_step deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "a345d715-4fbe-49e5-9ee3-9d7264b0b8e1",
"type": "retrospective_steps",
"attributes": {
"retrospective_process_id": "a3503efb-4236-4d28-9c00-db3e10889604",
"title": "Step 11",
"description": "Bar",
"incident_role_id": "7c1ccb7e-3183-4c96-8315-4297d497665b",
"due_after_days": null,
"position": 1,
"skippable": true,
"created_at": "2025-07-12T00:18:43.376-07:00",
"updated_at": "2025-07-12T00:18:45.085-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/retrospective_step_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/roles": {
"post": {
"summary": "Creates a role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Roles"
],
"description": "Creates a new role from provided data",
"operationId": "createRole",
"parameters": [],
"responses": {
"201": {
"description": "role created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "482f7e91-b6d8-4e25-aaf2-261a8c545f63",
"type": "roles",
"attributes": {
"team_id": 348,
"name": "Infrastructure",
"slug": "infrastructure",
"is_deletable": true,
"is_editable": true,
"alerts_permissions": [
"create",
"read"
],
"api_keys_permissions": [
"read"
],
"audits_permissions": [],
"billing_permissions": [
"update"
],
"environments_permissions": [
"read"
],
"form_fields_permissions": [
"read"
],
"functionalities_permissions": [
"read"
],
"groups_permissions": [
"read"
],
"incident_causes_permissions": [
"read"
],
"incident_feedbacks_permissions": [
"read",
"create",
"update"
],
"incident_permission_set_id": "94621060-0709-4b38-a146-53129a881e83",
"incident_roles_permissions": [
"read"
],
"incident_types_permissions": [
"read"
],
"incidents_permissions": [
"read"
],
"integrations_permissions": [],
"invitations_permissions": [
"read"
],
"playbooks_permissions": [
"read"
],
"private_incidents_permissions": [],
"pulses_permissions": [
"create",
"update",
"read"
],
"retrospective_permissions": [
"read"
],
"roles_permissions": [
"read"
],
"secrets_permissions": [
"create"
],
"services_permissions": [
"read"
],
"severities_permissions": [
"read"
],
"status_pages_permissions": [
"read"
],
"webhooks_permissions": [
"read"
],
"workflows_permissions": [
"read"
],
"updated_at": "2025-07-12T00:18:48.739-07:00",
"created_at": "2025-07-12T00:18:48.739-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/role_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_role"
}
}
},
"required": true
}
},
"get": {
"summary": "List roles",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Roles"
],
"description": "List roles",
"operationId": "listRoles",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/role_list"
}
}
}
}
}
}
},
"/v1/roles/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Roles"
],
"description": "Retrieves a specific role by id",
"operationId": "getRole",
"responses": {
"200": {
"description": "role found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "05109a99-f501-4e09-90ee-859795e7e1eb",
"type": "roles",
"attributes": {
"team_id": 351,
"name": "Role 11",
"slug": "role-11",
"is_deletable": true,
"is_editable": true,
"alerts_permissions": [
"create",
"read"
],
"api_keys_permissions": [
"read"
],
"audits_permissions": [],
"billing_permissions": [
"update"
],
"environments_permissions": [
"read"
],
"form_fields_permissions": [
"read"
],
"functionalities_permissions": [
"read"
],
"groups_permissions": [
"read"
],
"incident_causes_permissions": [
"read"
],
"incident_feedbacks_permissions": [
"read",
"create",
"update"
],
"incident_permission_set_id": "8e39d46e-c472-487e-a972-1bd8e4dffc95",
"incident_roles_permissions": [
"read"
],
"incident_types_permissions": [
"read"
],
"incidents_permissions": [
"read"
],
"integrations_permissions": [],
"invitations_permissions": [
"read"
],
"playbooks_permissions": [
"read"
],
"private_incidents_permissions": [],
"pulses_permissions": [
"create",
"update",
"read"
],
"retrospective_permissions": [
"read"
],
"roles_permissions": [
"read"
],
"secrets_permissions": [
"create"
],
"services_permissions": [
"read"
],
"severities_permissions": [
"read"
],
"status_pages_permissions": [
"read"
],
"webhooks_permissions": [
"read"
],
"workflows_permissions": [
"read"
],
"updated_at": "2025-07-12T00:18:50.400-07:00",
"created_at": "2025-07-12T00:18:50.400-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/role_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Roles"
],
"description": "Update a specific role by id",
"operationId": "updateRole",
"parameters": [],
"responses": {
"200": {
"description": "role updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "169ef66f-2ed5-4d43-a3a2-645097d72616",
"type": "roles",
"attributes": {
"team_id": 355,
"name": "Security",
"slug": "role-13",
"is_deletable": true,
"is_editable": true,
"alerts_permissions": [
"create",
"read"
],
"api_keys_permissions": [
"read"
],
"audits_permissions": [],
"billing_permissions": [
"update"
],
"environments_permissions": [
"read"
],
"form_fields_permissions": [
"read"
],
"functionalities_permissions": [
"read"
],
"groups_permissions": [
"read"
],
"incident_causes_permissions": [
"read"
],
"incident_feedbacks_permissions": [
"read",
"create",
"update"
],
"incident_permission_set_id": "78fd8e12-a781-40d5-a048-255f587cb36b",
"incident_roles_permissions": [
"read"
],
"incident_types_permissions": [
"read"
],
"incidents_permissions": [
"read"
],
"integrations_permissions": [],
"invitations_permissions": [
"read"
],
"playbooks_permissions": [
"read"
],
"private_incidents_permissions": [],
"pulses_permissions": [
"create",
"update",
"read"
],
"retrospective_permissions": [
"read"
],
"roles_permissions": [
"read"
],
"secrets_permissions": [
"create"
],
"services_permissions": [
"read"
],
"severities_permissions": [
"read"
],
"status_pages_permissions": [
"read"
],
"webhooks_permissions": [
"read"
],
"workflows_permissions": [
"read"
],
"updated_at": "2025-07-12T00:18:52.750-07:00",
"created_at": "2025-07-12T00:18:52.596-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/role_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_role"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Roles"
],
"description": "Delete a specific role by id",
"operationId": "deleteRole",
"responses": {
"200": {
"description": "role deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "949c78d4-abe5-4617-bd6a-f9da62f58794",
"type": "roles",
"attributes": {
"team_id": 359,
"name": "Role 15",
"slug": "role-15",
"is_deletable": true,
"is_editable": true,
"alerts_permissions": [
"create",
"read"
],
"api_keys_permissions": [
"read"
],
"audits_permissions": [],
"billing_permissions": [
"update"
],
"environments_permissions": [
"read"
],
"form_fields_permissions": [
"read"
],
"functionalities_permissions": [
"read"
],
"groups_permissions": [
"read"
],
"incident_causes_permissions": [
"read"
],
"incident_feedbacks_permissions": [
"read",
"create",
"update"
],
"incident_permission_set_id": "432e4e83-7154-48ba-b91e-9a697a4abf44",
"incident_roles_permissions": [
"read"
],
"incident_types_permissions": [
"read"
],
"incidents_permissions": [
"read"
],
"integrations_permissions": [],
"invitations_permissions": [
"read"
],
"playbooks_permissions": [
"read"
],
"private_incidents_permissions": [],
"pulses_permissions": [
"create",
"update",
"read"
],
"retrospective_permissions": [
"read"
],
"roles_permissions": [
"read"
],
"secrets_permissions": [
"create"
],
"services_permissions": [
"read"
],
"severities_permissions": [
"read"
],
"status_pages_permissions": [
"read"
],
"webhooks_permissions": [
"read"
],
"workflows_permissions": [
"read"
],
"updated_at": "2025-07-12T00:18:54.893-07:00",
"created_at": "2025-07-12T00:18:54.742-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/role_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/schedule_rotations/{schedule_rotation_id}/schedule_rotation_active_days": {
"parameters": [
{
"name": "schedule_rotation_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a schedule rotation active day",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotationActiveDays"
],
"description": "Creates a new schedule rotation active day from provided data",
"operationId": "createScheduleRotationActiveDay",
"parameters": [],
"responses": {
"201": {
"description": "schedule_rotation_active_day created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "983c0439-2290-4410-89c1-c6d23c346964",
"type": "schedule_rotation_active_days",
"attributes": {
"schedule_rotation_id": "997b4f58-a2e0-4504-a84b-898a72003d28",
"day_name": "M",
"created_at": "2025-07-12T00:18:58.530-07:00",
"updated_at": "2025-07-12T00:18:58.530-07:00",
"active_time_attributes": [
{
"start_time": "07:30",
"end_time": "16:30"
},
{
"start_time": "17:00",
"end_time": "20:00"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/schedule_rotation_active_day_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Day name can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_schedule_rotation_active_day"
}
}
},
"required": true
}
},
"get": {
"summary": "List schedule rotation active days",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotationActiveDays"
],
"description": "List schedule rotation active days",
"operationId": "listScheduleRotationActiveDays",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_rotation_active_day_list"
}
}
}
}
}
}
},
"/v1/schedule_rotation_active_days/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a schedule rotation active day",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotationActiveDays"
],
"description": "Retrieves a specific schedule rotation active day by id",
"operationId": "getScheduleRotationActiveDay",
"responses": {
"200": {
"description": "schedule_rotation_active_day found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "be794e7b-ccd9-4bd0-a0b5-b3546333d34f",
"type": "schedule_rotation_active_days",
"attributes": {
"schedule_rotation_id": "997b4f58-a2e0-4504-a84b-898a72003d28",
"day_name": "S",
"created_at": "2025-07-12T00:18:58.390-07:00",
"updated_at": "2025-07-12T00:18:58.390-07:00",
"active_time_attributes": []
}
}
},
"schema": {
"$ref": "#/components/schemas/schedule_rotation_active_day_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a schedule rotation active day",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotationActiveDays"
],
"description": "Update a specific schedule rotation active day by id",
"operationId": "updateScheduleRotationActiveDay",
"parameters": [],
"responses": {
"200": {
"description": "schedule_rotation_active_day updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "be794e7b-ccd9-4bd0-a0b5-b3546333d34f",
"type": "schedule_rotation_active_days",
"attributes": {
"schedule_rotation_id": "997b4f58-a2e0-4504-a84b-898a72003d28",
"day_name": "M",
"created_at": "2025-07-12T00:18:58.390-07:00",
"updated_at": "2025-07-12T00:18:59.547-07:00",
"active_time_attributes": [
{
"start_time": "10:30",
"end_time": "03:30"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/schedule_rotation_active_day_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_schedule_rotation_active_day"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a schedule rotation active day",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotationActiveDays"
],
"description": "Delete a specific schedule rotation active day",
"operationId": "deleteScheduleRotationActiveDay",
"responses": {
"200": {
"description": "schedule_rotation_active_day deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "be794e7b-ccd9-4bd0-a0b5-b3546333d34f",
"type": "schedule_rotation_active_days",
"attributes": {
"schedule_rotation_id": "997b4f58-a2e0-4504-a84b-898a72003d28",
"day_name": "S",
"created_at": "2025-07-12T00:18:58.390-07:00",
"updated_at": "2025-07-12T00:19:00.131-07:00",
"active_time_attributes": []
}
}
},
"schema": {
"$ref": "#/components/schemas/schedule_rotation_active_day_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/schedule_rotations/{schedule_rotation_id}/schedule_rotation_users": {
"parameters": [
{
"name": "schedule_rotation_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a schedule rotation user",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotationUsers"
],
"description": "Creates a new schedule rotation user from provided data",
"operationId": "createScheduleRotationUser",
"parameters": [],
"responses": {
"201": {
"description": "schedule_rotation_user created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "8ef35fb1-5f74-4798-a288-64640c56e325",
"type": "schedule_rotation_users",
"attributes": {
"schedule_rotation_id": "9b7c5bdb-8335-4eb1-aeb2-3af2db32f49a",
"user_id": 408,
"position": 2,
"created_at": "2025-07-12T00:19:01.684-07:00",
"updated_at": "2025-07-12T00:19:01.684-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/schedule_rotation_user_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "User must exist",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_schedule_rotation_user"
}
}
},
"required": true
}
},
"get": {
"summary": "List schedule rotation users",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotationUsers"
],
"operationId": "listScheduleRotationUsers",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_rotation_user_list"
}
}
}
}
}
}
},
"/v1/schedule_rotation_users/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a schedule rotation user",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotationUsers"
],
"description": "Retrieves a specific schedule rotation user by id",
"operationId": "getScheduleRotationUser",
"responses": {
"200": {
"description": "schedule_rotation_user found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "489f3d5b-bd2b-458d-bfcf-4fd23623e341",
"type": "schedule_rotation_users",
"attributes": {
"schedule_rotation_id": "9b7c5bdb-8335-4eb1-aeb2-3af2db32f49a",
"user_id": 408,
"position": 2,
"created_at": "2025-07-12T00:19:01.542-07:00",
"updated_at": "2025-07-12T00:19:01.547-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/schedule_rotation_user_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update schedule rotation user",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotationUsers"
],
"description": "Update a specific schedule rotation user by id",
"operationId": "updateScheduleRotationUser",
"parameters": [],
"responses": {
"200": {
"description": "schedule_rotation_user updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "489f3d5b-bd2b-458d-bfcf-4fd23623e341",
"type": "schedule_rotation_users",
"attributes": {
"schedule_rotation_id": "9b7c5bdb-8335-4eb1-aeb2-3af2db32f49a",
"user_id": 408,
"position": 2,
"created_at": "2025-07-12T00:19:01.542-07:00",
"updated_at": "2025-07-12T00:19:01.547-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/schedule_rotation_user_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_schedule_rotation_user"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a schedule rotation user",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotationUsers"
],
"description": "Delete a specific schedule rotation user by id",
"operationId": "deleteScheduleRotationUser",
"responses": {
"200": {
"description": "schedule_rotation_user deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "489f3d5b-bd2b-458d-bfcf-4fd23623e341",
"type": "schedule_rotation_users",
"attributes": {
"schedule_rotation_id": "9b7c5bdb-8335-4eb1-aeb2-3af2db32f49a",
"user_id": 408,
"position": 2,
"created_at": "2025-07-12T00:19:01.542-07:00",
"updated_at": "2025-07-12T00:19:03.274-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/schedule_rotation_user_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/schedules/{schedule_id}/schedule_rotations": {
"parameters": [
{
"name": "schedule_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a schedule rotation",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotations"
],
"description": "Creates a new schedule rotation from provided data",
"operationId": "createScheduleRotation",
"parameters": [],
"responses": {
"201": {
"description": "schedule_rotation created with custom active times",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "0e203a0d-3db3-47ec-8eca-27d8c20f3298",
"type": "schedule_rotations",
"attributes": {
"schedule_id": "921a2266-e982-4e90-9ac7-05e330132266",
"name": "Schedule Rotation Name",
"position": 1,
"schedule_rotationable_type": "ScheduleWeeklyRotation",
"active_all_week": false,
"active_days": [
"M",
"T"
],
"active_time_type": "same_time",
"time_zone": "American Samoa",
"start_time": null,
"end_time": null,
"schedule_rotationable_attributes": {
"handoff_time": "21:30",
"handoff_day": "T"
},
"active_time_attributes": [
{
"start_time": "07:30",
"end_time": "16:30"
},
{
"start_time": "17:00",
"end_time": "21:00"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/schedule_rotation_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_schedule_rotation"
}
}
},
"required": true
}
},
"get": {
"summary": "List schedule rotations",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotations"
],
"description": "List schedule rotations",
"operationId": "listScheduleRotations",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_rotation_list"
}
}
}
}
}
}
},
"/v1/schedule_rotations/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a schedule rotation",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotations"
],
"description": "Retrieves a specific schedule rotation by id",
"operationId": "getScheduleRotation",
"responses": {
"200": {
"description": "schedule_rotation found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "b6c5fe10-18df-4a56-94dd-54a2bd569a78",
"type": "schedule_rotations",
"attributes": {
"schedule_id": "921a2266-e982-4e90-9ac7-05e330132266",
"name": "Schedule Rotation 13",
"position": 1,
"schedule_rotationable_type": "ScheduleDailyRotation",
"active_all_week": true,
"active_days": [],
"active_time_type": "all_day",
"time_zone": "UTC",
"start_time": null,
"end_time": null,
"schedule_rotationable_attributes": {
"handoff_time": "17:00"
},
"active_time_attributes": []
}
}
},
"schema": {
"$ref": "#/components/schemas/schedule_rotation_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a schedule rotation",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotations"
],
"description": "Update a specific schedule rotation by id",
"operationId": "updateScheduleRotation",
"parameters": [],
"responses": {
"200": {
"description": "schedule_rotation updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "b6c5fe10-18df-4a56-94dd-54a2bd569a78",
"type": "schedule_rotations",
"attributes": {
"schedule_id": "921a2266-e982-4e90-9ac7-05e330132266",
"name": "Updated Schedule Rotation Name",
"position": 1,
"schedule_rotationable_type": "ScheduleWeeklyRotation",
"active_all_week": false,
"active_days": [
"M",
"T"
],
"active_time_type": "same_time",
"time_zone": "American Samoa",
"start_time": null,
"end_time": null,
"schedule_rotationable_attributes": {
"handoff_time": "22:30",
"handoff_day": "T"
},
"active_time_attributes": [
{
"start_time": "07:30",
"end_time": "20:30"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/schedule_rotation_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_schedule_rotation"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a schedule rotation",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotations"
],
"description": "Delete a specific schedule rotation by id",
"operationId": "deleteScheduleRotation",
"responses": {
"200": {
"description": "schedule_rotation deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "b6c5fe10-18df-4a56-94dd-54a2bd569a78",
"type": "schedule_rotations",
"attributes": {
"schedule_id": "921a2266-e982-4e90-9ac7-05e330132266",
"name": "Schedule Rotation 13",
"position": 1,
"schedule_rotationable_type": "ScheduleDailyRotation",
"active_all_week": true,
"active_days": [],
"active_time_type": "all_day",
"time_zone": "UTC",
"start_time": null,
"end_time": null,
"schedule_rotationable_attributes": {
"handoff_time": "17:00"
},
"active_time_attributes": []
}
}
},
"schema": {
"$ref": "#/components/schemas/schedule_rotation_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/schedules": {
"post": {
"summary": "Creates a schedule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Schedules"
],
"description": "Creates a new schedule from provided data",
"operationId": "createSchedule",
"parameters": [],
"responses": {
"201": {
"description": "schedule created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "020b3e58-349e-48da-9e7c-bcbf83845bc3",
"type": "schedules",
"attributes": {
"name": "Schedule Name",
"description": "Schedule Description",
"all_time_coverage": true,
"slack_user_group": {},
"owner_user_id": 423,
"owner_group_ids": [
"504b457f-9611-40a9-9863-efb895f8f23f"
],
"created_at": "2025-07-12T00:19:16.467-07:00",
"updated_at": "2025-07-12T00:19:16.467-07:00"
},
"relationships": {
"owner_user": {
"data": {
"id": "423",
"type": "users"
}
},
"escalation_policies": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/schedule_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"name": [
"can't be blank"
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_schedule"
}
}
},
"required": true
}
},
"get": {
"summary": "List schedules",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Schedules"
],
"description": "List schedules",
"operationId": "listSchedules",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_list"
}
}
}
}
}
}
},
"/v1/schedules/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a schedule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Schedules"
],
"description": "Retrieves a specific schedule by id",
"operationId": "getSchedule",
"responses": {
"200": {
"description": "schedule found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "553c83bc-d635-49cf-ae0c-53783db07751",
"type": "schedules",
"attributes": {
"name": "Schedule 10",
"description": "Schedule description",
"all_time_coverage": false,
"slack_user_group": {},
"owner_user_id": 423,
"owner_group_ids": [
"504b457f-9611-40a9-9863-efb895f8f23f"
],
"created_at": "2025-07-12T00:19:11.485-07:00",
"updated_at": "2025-07-12T00:19:11.485-07:00"
},
"relationships": {
"owner_user": {
"data": {
"id": "423",
"type": "users"
}
},
"escalation_policies": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/schedule_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a schedule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Schedules"
],
"description": "Updates a specific schedule by id",
"operationId": "updateSchedule",
"parameters": [],
"responses": {
"200": {
"description": "schedule updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "553c83bc-d635-49cf-ae0c-53783db07751",
"type": "schedules",
"attributes": {
"name": "Updated schedule name",
"description": "Updated schedule description",
"all_time_coverage": true,
"slack_user_group": {},
"owner_user_id": 423,
"owner_group_ids": [
"504b457f-9611-40a9-9863-efb895f8f23f"
],
"created_at": "2025-07-12T00:19:11.485-07:00",
"updated_at": "2025-07-12T00:19:18.237-07:00"
},
"relationships": {
"owner_user": {
"data": {
"id": "423",
"type": "users"
}
},
"escalation_policies": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/schedule_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_schedule"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a schedule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Schedules"
],
"description": "Delete a specific schedule by id",
"operationId": "deleteSchedule",
"responses": {
"200": {
"description": "schedule deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "553c83bc-d635-49cf-ae0c-53783db07751",
"type": "schedules",
"attributes": {
"name": "Schedule 10",
"description": "Schedule description",
"all_time_coverage": false,
"slack_user_group": {},
"owner_user_id": 423,
"owner_group_ids": [
"504b457f-9611-40a9-9863-efb895f8f23f"
],
"created_at": "2025-07-12T00:19:11.485-07:00",
"updated_at": "2025-07-12T00:19:18.789-07:00"
},
"relationships": {
"owner_user": {
"data": {
"id": "423",
"type": "users"
}
},
"escalation_policies": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/schedule_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/schedules/{id}/shifts": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a schedule shifts",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Shifts"
],
"description": "Retrieves schedule shifts",
"operationId": "getScheduleShifts",
"parameters": [
{
"name": "to",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "schedule shifts found",
"content": {
"application/vnd.api+json": {
"example": {
"data": [
{
"id": "e9a9ef64-3297-4305-8946-751bc10097e0",
"type": "shifts",
"attributes": {
"schedule_id": "553c83bc-d635-49cf-ae0c-53783db07751",
"rotation_id": "f53ae7ad-804a-432b-bb47-6dc0bcebdfed",
"starts_at": "2025-07-11T22:19:13.000-07:00",
"ends_at": "2025-07-12T02:19:13.000-07:00",
"is_override": true
},
"relationships": {
"shift_override": {
"data": null
},
"user": {
"data": {
"id": "448",
"type": "users"
}
}
}
},
{
"id": "86b2b72b-97c6-4da1-930e-c8b1211a9e16",
"type": "shifts",
"attributes": {
"schedule_id": "553c83bc-d635-49cf-ae0c-53783db07751",
"rotation_id": "c640eb93-fea3-42ac-b404-d9dd9e01df90",
"starts_at": "2025-07-12T03:19:13.000-07:00",
"ends_at": "2025-07-12T07:19:13.000-07:00",
"is_override": false
},
"relationships": {
"shift_override": {
"data": null
},
"user": {
"data": {
"id": "452",
"type": "users"
}
}
}
}
]
},
"schema": {
"$ref": "#/components/schemas/shift_list"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/secrets": {
"post": {
"summary": "Creates a secret",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Secrets"
],
"description": "Creates a new secret from provided data",
"operationId": "createSecret",
"parameters": [],
"responses": {
"201": {
"description": "secret created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "38c493a5-1526-48e4-8d75-83b798c1aebe",
"type": "secrets",
"attributes": {
"kind": "built_in",
"name": "rhthedhsgy",
"secret": "[REDACTED]",
"hashicorp_vault_mount": "secret",
"hashicorp_vault_path": null,
"hashicorp_vault_version": 0,
"created_at": "2025-07-12T00:19:22.161-07:00",
"updated_at": "2025-07-12T00:19:22.161-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/secret_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name only allows letters, numbers, and underscore",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_secret"
}
}
},
"required": true
}
},
"get": {
"summary": "List secrets",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Secrets"
],
"description": "List secrets",
"operationId": "listSecrets",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/secret_list"
}
}
}
}
}
}
},
"/v1/secrets/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a secret",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Secrets"
],
"description": "Retrieve a specific secret by id",
"operationId": "getSecret",
"responses": {
"200": {
"description": "secret found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "6f0a734f-9c61-4f86-a6df-a794b54e2d31",
"type": "secrets",
"attributes": {
"kind": "built_in",
"name": "nogowfnqrd",
"secret": "[REDACTED]",
"hashicorp_vault_mount": "secret",
"hashicorp_vault_path": null,
"hashicorp_vault_version": 0,
"created_at": "2025-07-12T00:19:20.456-07:00",
"updated_at": "2025-07-12T00:19:20.456-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/secret_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a secret",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Secrets"
],
"description": "Update a specific secret by id",
"operationId": "updateSecret",
"parameters": [],
"responses": {
"200": {
"description": "secret updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "6f0a734f-9c61-4f86-a6df-a794b54e2d31",
"type": "secrets",
"attributes": {
"kind": "built_in",
"name": "foo_bar",
"secret": "[REDACTED]",
"hashicorp_vault_mount": "secret",
"hashicorp_vault_path": null,
"hashicorp_vault_version": 0,
"created_at": "2025-07-12T00:19:20.456-07:00",
"updated_at": "2025-07-12T00:19:23.230-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/secret_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_secret"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a secret",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Secrets"
],
"description": "Delete a specific secret by id",
"operationId": "deleteSecret",
"responses": {
"200": {
"description": "secret deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "6f0a734f-9c61-4f86-a6df-a794b54e2d31",
"type": "secrets",
"attributes": {
"kind": "built_in",
"name": "nogowfnqrd",
"secret": "[REDACTED]",
"hashicorp_vault_mount": "secret",
"hashicorp_vault_path": null,
"hashicorp_vault_version": 0,
"created_at": "2025-07-12T00:19:20.456-07:00",
"updated_at": "2025-07-12T00:19:23.664-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/secret_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/services": {
"post": {
"summary": "Creates a service",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Services"
],
"description": "Creates a new service from provided data",
"operationId": "createService",
"parameters": [],
"responses": {
"201": {
"description": "service created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "5547ffe9-fac8-4154-af4b-5e96e0536ec2",
"type": "services",
"attributes": {
"name": "elasticsearch-prod",
"slug": "elasticsearch-prod",
"description": "Elastisearch",
"public_description": "Public description",
"notify_emails": [
"john@rootly.com",
"doe@rootly.com"
],
"color": "#FFF",
"status": "operational",
"position": 1,
"show_uptime": true,
"show_uptime_last_days": 60,
"slack_channels": [
{
"id": "C03MKDSEJE8",
"name": "elastisearch"
}
],
"slack_aliases": [
{
"id": "S03F7QUV7F1",
"name": "engineering"
}
],
"github_repository_name": "rootlyhq/my-github-service",
"github_repository_branch": "main",
"gitlab_repository_name": "rootlyhq/my-gitlab-service",
"gitlab_repository_branch": "main",
"opsgenie_id": "8743a1b2-11da-480e-8493-744660987bef",
"pagerduty_id": "PQ9K7I8",
"backstage_id": null,
"external_id": "d795fe69-acc2-4b30-92c9-3c25cbb92056",
"cortex_id": null,
"service_now_ci_sys_id": null,
"environment_ids": [
"a1f14365-53f0-4e97-b322-8e50df6cd6d7"
],
"service_ids": [
"8dcbb428-a5b1-488a-b929-0f5c3a4738e9"
],
"owner_group_ids": [
"da6a04b3-2908-4f9f-be59-529121ed9a8d"
],
"owners_group_ids": [
"da6a04b3-2908-4f9f-be59-529121ed9a8d"
],
"owner_user_ids": [
455
],
"owners_user_ids": [
455
],
"incidents_count": 0,
"alert_urgency_id": null,
"alerts_email_enabled": true,
"alerts_email_address": "service-9adbe23f69c08fde09672e73027e1a51@test.email.rootly.com",
"created_at": "2025-07-12T00:19:30.616-07:00",
"updated_at": "2025-07-12T00:19:30.616-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/service_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_service"
}
}
},
"required": true
}
},
"get": {
"summary": "List services",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Services"
],
"description": "List services",
"operationId": "listServices",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[backstage_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[cortex_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[opslevel_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[external_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/service_list"
}
}
}
}
}
}
},
"/v1/services/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a service",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Services"
],
"description": "Retrieves a specific service by id",
"operationId": "getService",
"responses": {
"200": {
"description": "service found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "8dcbb428-a5b1-488a-b929-0f5c3a4738e9",
"type": "services",
"attributes": {
"name": "Voluptatem quis ex dolores.",
"slug": "voluptatem-quis-ex-dolores",
"description": "Labore veritatis debitis accusamus.",
"public_description": null,
"notify_emails": [],
"color": "#FAEBB7",
"status": "partial_outage",
"position": 1,
"show_uptime": true,
"show_uptime_last_days": 60,
"slack_channels": [],
"slack_aliases": [],
"github_repository_name": null,
"github_repository_branch": "master",
"gitlab_repository_name": null,
"gitlab_repository_branch": "master",
"opsgenie_id": null,
"pagerduty_id": null,
"backstage_id": null,
"external_id": null,
"cortex_id": null,
"service_now_ci_sys_id": null,
"environment_ids": [],
"service_ids": [],
"owner_group_ids": [],
"owners_group_ids": [],
"owner_user_ids": [],
"owners_user_ids": [],
"incidents_count": 1,
"alert_urgency_id": null,
"alerts_email_enabled": false,
"alerts_email_address": "service-3f6e29fe3de9f9a26284b053d37dc33e@email.rootly.com",
"created_at": "2025-07-12T00:19:24.884-07:00",
"updated_at": "2025-07-12T00:19:25.109-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/service_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a service",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Services"
],
"description": "Update a specific service by id",
"operationId": "updateService",
"parameters": [],
"responses": {
"200": {
"description": "service updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "8dcbb428-a5b1-488a-b929-0f5c3a4738e9",
"type": "services",
"attributes": {
"name": "elasticsearch-staging",
"slug": "voluptatem-quis-ex-dolores",
"description": "Elastisearch",
"public_description": "Public description updated",
"notify_emails": [
"hello@rootly.com",
"world@rootly.com"
],
"color": "#FFF",
"status": "partial_outage",
"position": 2,
"show_uptime": true,
"show_uptime_last_days": 60,
"slack_channels": [
{
"id": "C03MKDSEJE8",
"name": "elastisearch"
}
],
"slack_aliases": [
{
"id": "S03F7QUV7F1",
"name": "leadership"
}
],
"github_repository_name": "rootlyhq/my-another-github-service",
"github_repository_branch": "master",
"gitlab_repository_name": "rootlyhq/my-another-gitlab-service",
"gitlab_repository_branch": "master",
"opsgenie_id": "8743a1b2-11da-480e-8493-744660987bec",
"pagerduty_id": "PQ9K7I9",
"backstage_id": null,
"external_id": "33bfcc62-cc35-46e6-a270-8c52a56fb358",
"cortex_id": null,
"service_now_ci_sys_id": null,
"environment_ids": [
"a1f14365-53f0-4e97-b322-8e50df6cd6d7"
],
"service_ids": [
"8dcbb428-a5b1-488a-b929-0f5c3a4738e9"
],
"owner_group_ids": [],
"owners_group_ids": [],
"owner_user_ids": [],
"owners_user_ids": [],
"incidents_count": 1,
"alert_urgency_id": null,
"alerts_email_enabled": false,
"alerts_email_address": "service-3f6e29fe3de9f9a26284b053d37dc33e@email.rootly.com",
"created_at": "2025-07-12T00:19:24.884-07:00",
"updated_at": "2025-07-12T00:19:32.423-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/service_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_service"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a service",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Services"
],
"description": "Delete a specific service by id",
"operationId": "deleteService",
"responses": {
"200": {
"description": "service deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "8dcbb428-a5b1-488a-b929-0f5c3a4738e9",
"type": "services",
"attributes": {
"name": "Voluptatem quis ex dolores.",
"slug": "voluptatem-quis-ex-dolores",
"description": "Labore veritatis debitis accusamus.",
"public_description": null,
"notify_emails": [],
"color": "#FAEBB7",
"status": "partial_outage",
"position": 1,
"show_uptime": true,
"show_uptime_last_days": 60,
"slack_channels": [],
"slack_aliases": [],
"github_repository_name": null,
"github_repository_branch": "master",
"gitlab_repository_name": null,
"gitlab_repository_branch": "master",
"opsgenie_id": null,
"pagerduty_id": null,
"backstage_id": null,
"external_id": null,
"cortex_id": null,
"service_now_ci_sys_id": null,
"environment_ids": [],
"service_ids": [],
"owner_group_ids": [],
"owners_group_ids": [],
"owner_user_ids": [],
"owners_user_ids": [],
"incidents_count": 1,
"alert_urgency_id": null,
"alerts_email_enabled": false,
"alerts_email_address": "service-3f6e29fe3de9f9a26284b053d37dc33e@email.rootly.com",
"created_at": "2025-07-12T00:19:24.884-07:00",
"updated_at": "2025-07-12T00:19:33.223-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/service_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/services/{id}/incidents_chart": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Get service incidents chart",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Services"
],
"description": "Get service incidents chart",
"operationId": "getServiceIncidentsChart",
"parameters": [
{
"name": "period",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"2025-05-13 00:00:00 UTC": 0,
"2025-05-20 00:00:00 UTC": 0,
"2025-05-27 00:00:00 UTC": 0,
"2025-06-03 00:00:00 UTC": 0,
"2025-06-10 00:00:00 UTC": 0,
"2025-06-17 00:00:00 UTC": 0,
"2025-06-24 00:00:00 UTC": 0,
"2025-07-01 00:00:00 UTC": 0,
"2025-07-08 00:00:00 UTC": 1
}
},
"schema": {
"$ref": "#/components/schemas/incidents_chart_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/services/{id}/uptime_chart": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Get service uptime chart",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Services"
],
"description": "Get service uptime chart",
"operationId": "getServiceUptimeChart",
"parameters": [
{
"name": "period",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"2025-06-27": 100.0,
"2025-06-28": 100.0,
"2025-06-29": 100.0,
"2025-06-30": 100.0,
"2025-07-01": 100.0,
"2025-07-02": 100.0,
"2025-07-03": 100.0,
"2025-07-04": 100.0,
"2025-07-05": 100.0,
"2025-07-06": 100.0,
"2025-07-07": 100.0,
"2025-07-08": 100.0,
"2025-07-09": 50.0,
"2025-07-10": 0.0,
"2025-07-11": 100.0,
"2025-07-12": 100.0
}
},
"schema": {
"$ref": "#/components/schemas/uptime_chart_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/severities": {
"post": {
"summary": "Creates a severity",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Severities"
],
"description": "Creates a new severity from provided data",
"operationId": "createSeverity",
"parameters": [],
"responses": {
"201": {
"description": "severity created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "238e5bfb-311d-4dcc-8a61-7fc4829958c1",
"type": "severities",
"attributes": {
"name": "P0",
"slug": "p0",
"description": "High Priority",
"severity": "medium",
"color": "#E58A1F",
"position": 1,
"notify_emails": [
"hello@rootly.com",
"world@rootly.com"
],
"slack_channels": [
{
"id": "C03MKDSEJE8",
"name": "elastisearch"
}
],
"slack_aliases": [
{
"id": "S03F7QUV7F1",
"name": "leadership"
}
],
"created_at": "2025-07-12T00:19:38.069-07:00",
"updated_at": "2025-07-12T00:19:38.069-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/severity_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_severity"
}
}
},
"required": true
}
},
"get": {
"summary": "List severities",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Severities"
],
"description": "List severities",
"operationId": "listSeverities",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[severity]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/severity_list"
}
}
}
}
}
}
},
"/v1/severities/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a severity",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Severities"
],
"description": "Retrieves a specific severity by id",
"operationId": "getSeverity",
"responses": {
"200": {
"description": "severity found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "10e22237-aca0-458f-9e86-cd021ba8c9f5",
"type": "severities",
"attributes": {
"name": "dhxfr",
"slug": "dhxfr",
"description": "Cum repellat id et.",
"severity": "medium",
"color": "#E58A1F",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-07-12T00:19:36.197-07:00",
"updated_at": "2025-07-12T00:19:36.197-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/severity_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a severity",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Severities"
],
"description": "Update a specific severity by id",
"operationId": "updateSeverity",
"parameters": [],
"responses": {
"200": {
"description": "severity updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "10e22237-aca0-458f-9e86-cd021ba8c9f5",
"type": "severities",
"attributes": {
"name": "P1",
"slug": "p1",
"description": "Medium Priority",
"severity": "medium",
"color": "#000",
"position": 2,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-07-12T00:19:36.197-07:00",
"updated_at": "2025-07-12T00:19:39.440-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/severity_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_severity"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a severity",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Severities"
],
"description": "Delete a specific severity by id",
"operationId": "deleteSeverity",
"responses": {
"200": {
"description": "severity deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "10e22237-aca0-458f-9e86-cd021ba8c9f5",
"type": "severities",
"attributes": {
"name": "dhxfr",
"slug": "dhxfr",
"description": "Cum repellat id et.",
"severity": "medium",
"color": "#E58A1F",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-07-12T00:19:36.197-07:00",
"updated_at": "2025-07-12T00:19:40.344-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/severity_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/shifts": {
"get": {
"summary": "List shifts",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Shifts"
],
"description": "List shifts",
"operationId": "listShifts",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: shift_override,user",
"schema": {
"type": "string",
"enum": [
"shift_override",
"user"
]
},
"required": false
},
{
"name": "to",
"in": "query",
"description": "Start range for shifts",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "End range for shifts",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "user_ids[]",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"style": "form",
"explode": true,
"required": false
},
{
"name": "schedule_ids[]",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"required": false
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"example": {
"data": [
{
"id": "3752daae-c22f-4ad3-9f9e-324d9904ff27",
"type": "shifts",
"attributes": {
"schedule_id": "117fcd39-2f66-4231-8108-87a5f46b7bc8",
"rotation_id": "d7a2b1d5-63db-4670-82e1-4b7d93e27e71",
"starts_at": "2024-07-02T21:00:00.000-07:00",
"ends_at": "2024-07-02T23:00:00.000-07:00",
"is_override": true
},
"relationships": {
"shift_override": {
"data": null
},
"user": {
"data": {
"id": "461",
"type": "users"
}
}
}
},
{
"id": "f1d44ffd-1e44-4a1a-87ec-faa3e4ce70e3",
"type": "shifts",
"attributes": {
"schedule_id": "117fcd39-2f66-4231-8108-87a5f46b7bc8",
"rotation_id": "9d9eca0a-9a7a-4a9a-8f3c-7792c23d772e",
"starts_at": "2024-07-02T19:00:00.000-07:00",
"ends_at": "2024-07-02T21:00:00.000-07:00",
"is_override": false
},
"relationships": {
"shift_override": {
"data": null
},
"user": {
"data": {
"id": "461",
"type": "users"
}
}
}
}
]
},
"schema": {
"$ref": "#/components/schemas/shift_list"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/status-pages/{status_page_id}/templates": {
"parameters": [
{
"name": "status_page_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a status page template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"StatusPageTemplates"
],
"description": "Creates a new template from provided data",
"operationId": "createStatusPageTemplate",
"parameters": [],
"responses": {
"201": {
"description": "incident_event created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "ef26a3a3-8f85-498e-89c5-72ab1feae2a7",
"type": "status_page_templates",
"attributes": {
"status_page_id": "98d2c182-5de1-43cb-bf19-ff033711030d",
"title": "Created from API",
"body": "This was created from API.",
"update_status": null,
"should_notify_subscribers": false,
"position": 4,
"enabled": true,
"created_at": "2025-07-12T00:19:44.825-07:00",
"updated_at": "2025-07-12T00:19:44.825-07:00",
"kind": "normal"
}
}
},
"schema": {
"$ref": "#/components/schemas/status_page_template_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Title can't be blank",
"status": "422"
},
{
"title": "Body can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/status_page_template"
}
}
},
"required": true
}
},
"get": {
"summary": "List status page templates",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"StatusPageTemplates"
],
"description": "List status page templates",
"operationId": "listStatusPageTemplates",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/status_page_template_list"
}
}
}
}
}
}
},
"/v1/templates/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a status page template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"StatusPageTemplates"
],
"description": "Retrieves a specific status_page_template by id",
"operationId": "getStatusPageTemplate",
"responses": {
"200": {
"description": "status page template found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "5ace66bd-c965-4af9-ab4e-cbe41992ba2f",
"type": "status_page_templates",
"attributes": {
"status_page_id": "98d2c182-5de1-43cb-bf19-ff033711030d",
"title": "Culpa",
"body": "Voluptatibus aut asperiores porro.",
"update_status": null,
"should_notify_subscribers": false,
"position": 1,
"enabled": true,
"created_at": "2025-07-12T00:19:44.555-07:00",
"updated_at": "2025-07-12T00:19:44.555-07:00",
"kind": "normal"
}
}
},
"schema": {
"$ref": "#/components/schemas/status_page_template_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update status page template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"StatusPageTemplates"
],
"description": "Update a specific template event by id",
"operationId": "updateStatusPageTemplate",
"parameters": [],
"responses": {
"200": {
"description": "incident_event updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "5ace66bd-c965-4af9-ab4e-cbe41992ba2f",
"type": "status_page_templates",
"attributes": {
"status_page_id": "98d2c182-5de1-43cb-bf19-ff033711030d",
"title": "Update template title",
"body": "Update template body",
"update_status": null,
"should_notify_subscribers": false,
"position": 1,
"enabled": true,
"created_at": "2025-07-12T00:19:44.555-07:00",
"updated_at": "2025-07-12T00:19:46.397-07:00",
"kind": "normal"
}
}
},
"schema": {
"$ref": "#/components/schemas/status_page_template_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/status_page_template"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a incident event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"StatusPageTemplates"
],
"description": "Delete a specific template event by id",
"operationId": "deleteStatusPageTemplate",
"responses": {
"200": {
"description": "incident_event deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "5ace66bd-c965-4af9-ab4e-cbe41992ba2f",
"type": "status_page_templates",
"attributes": {
"status_page_id": "98d2c182-5de1-43cb-bf19-ff033711030d",
"title": "Culpa",
"body": "Voluptatibus aut asperiores porro.",
"update_status": null,
"should_notify_subscribers": false,
"position": 1,
"enabled": true,
"created_at": "2025-07-12T00:19:44.555-07:00",
"updated_at": "2025-07-12T00:19:47.368-07:00",
"kind": "normal"
}
}
},
"schema": {
"$ref": "#/components/schemas/status_page_template_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/status-pages": {
"post": {
"summary": "Creates a status page",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"StatusPages"
],
"description": "Creates a new status page from provided data",
"operationId": "createStatusPage",
"parameters": [],
"responses": {
"201": {
"description": "status_page created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "40fb6952-c112-49e7-b892-59ca08869639",
"type": "status_pages",
"attributes": {
"title": "My Status Page",
"slug": "my-status-page",
"public_title": null,
"description": "My Status Page description",
"public_description": null,
"header_color": "#0061F2",
"footer_color": "#1F2F41",
"allow_search_engine_index": true,
"public": false,
"website_url": null,
"website_privacy_url": null,
"website_support_url": null,
"ga_tracking_id": null,
"time_zone": "Etc/UTC",
"success_message": "All Systems Operational",
"failure_message": "Something's not quite right",
"authentication_enabled": false,
"authentication_password": "[REDACTED]",
"enabled": true,
"functionality_ids": [
"f59e21b8-0a60-4ef5-bc75-2d066f2ba387"
],
"service_ids": [
"daba7397-2c9a-4ec3-aa6f-7184cd904088"
],
"allow_email_subscribers": true,
"allow_sms_subscribers": true,
"allow_rss_atom_feeds": true,
"show_uptime": true,
"show_uptime_last_days": 30,
"external_domain_names": [],
"created_at": "2025-07-12T00:19:52.094-07:00",
"updated_at": "2025-07-12T00:19:52.094-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/status_page_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Title can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_status_page"
}
}
},
"required": true
}
},
"get": {
"summary": "List status pages",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"StatusPages"
],
"description": "List status pages",
"operationId": "listStatusPages",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/status_page_list"
}
}
}
}
}
}
},
"/v1/status-pages/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a status page",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"StatusPages"
],
"description": "Retrieves a specific status page by id",
"operationId": "getStatusPage",
"responses": {
"200": {
"description": "status_page found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "9f2b946d-1ef7-4ec4-b94f-7fd9f162b1e1",
"type": "status_pages",
"attributes": {
"title": "Cupiditate velit nulla necessitatibus.",
"slug": "cupiditate-velit-nulla-necessitatibus",
"public_title": null,
"description": null,
"public_description": null,
"header_color": "#0061F2",
"footer_color": "#1F2F41",
"allow_search_engine_index": true,
"public": false,
"website_url": null,
"website_privacy_url": null,
"website_support_url": null,
"ga_tracking_id": null,
"time_zone": "Etc/UTC",
"success_message": "All Systems Operational",
"failure_message": "Something's not quite right",
"authentication_enabled": false,
"authentication_password": "[REDACTED]",
"enabled": true,
"functionality_ids": [],
"service_ids": [],
"allow_email_subscribers": true,
"allow_sms_subscribers": true,
"allow_rss_atom_feeds": true,
"show_uptime": true,
"show_uptime_last_days": 60,
"external_domain_names": [],
"created_at": "2025-07-12T00:19:49.034-07:00",
"updated_at": "2025-07-12T00:19:49.034-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/status_page_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a status page",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"StatusPages"
],
"description": "Update a specific status page by id",
"operationId": "updateStatusPage",
"parameters": [],
"responses": {
"200": {
"description": "status_page updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "9f2b946d-1ef7-4ec4-b94f-7fd9f162b1e1",
"type": "status_pages",
"attributes": {
"title": "My Status Page Updated",
"slug": "my-status-page-updated",
"public_title": null,
"description": "My Status Page Description Updated",
"public_description": null,
"header_color": "#0061F2",
"footer_color": "#1F2F41",
"allow_search_engine_index": true,
"public": false,
"website_url": null,
"website_privacy_url": null,
"website_support_url": null,
"ga_tracking_id": null,
"time_zone": "Etc/UTC",
"success_message": "All Systems Operational",
"failure_message": "Something's not quite right",
"authentication_enabled": false,
"authentication_password": "[REDACTED]",
"enabled": true,
"functionality_ids": [],
"service_ids": [],
"allow_email_subscribers": true,
"allow_sms_subscribers": true,
"allow_rss_atom_feeds": true,
"show_uptime": true,
"show_uptime_last_days": 60,
"external_domain_names": [],
"created_at": "2025-07-12T00:19:49.034-07:00",
"updated_at": "2025-07-12T00:19:53.733-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/status_page_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_status_page"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a status page",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"StatusPages"
],
"description": "Delete a specific status page by id",
"operationId": "deleteStatusPage",
"responses": {
"200": {
"description": "status_page deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "9f2b946d-1ef7-4ec4-b94f-7fd9f162b1e1",
"type": "status_pages",
"attributes": {
"title": "Cupiditate velit nulla necessitatibus.",
"slug": "cupiditate-velit-nulla-necessitatibus",
"public_title": null,
"description": null,
"public_description": null,
"header_color": "#0061F2",
"footer_color": "#1F2F41",
"allow_search_engine_index": true,
"public": false,
"website_url": null,
"website_privacy_url": null,
"website_support_url": null,
"ga_tracking_id": null,
"time_zone": "Etc/UTC",
"success_message": "All Systems Operational",
"failure_message": "Something's not quite right",
"authentication_enabled": false,
"authentication_password": "[REDACTED]",
"enabled": true,
"functionality_ids": [],
"service_ids": [],
"allow_email_subscribers": true,
"allow_sms_subscribers": true,
"allow_rss_atom_feeds": true,
"show_uptime": true,
"show_uptime_last_days": 60,
"external_domain_names": [],
"created_at": "2025-07-12T00:19:49.034-07:00",
"updated_at": "2025-07-12T00:19:54.449-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/status_page_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/sub_statuses": {
"post": {
"summary": "Creates a Sub-Status",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"SubStatuses"
],
"description": "Creates a new Sub-Status from provided data",
"operationId": "createSubStatus",
"parameters": [],
"responses": {
"201": {
"description": "sub_status created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "f7b592ec-1b3e-4378-a2d5-7c2b44632794",
"type": "sub_statuses",
"attributes": {
"name": "Test",
"description": "This is a description",
"slug": "test",
"parent_status": "started",
"position": 13,
"deleted_at": null,
"updated_at": "2025-07-12T00:19:57.465-07:00",
"created_at": "2025-07-12T00:19:57.465-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/sub_status_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
},
{
"title": "Name is too short (minimum is 1 character)",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_sub_status"
}
}
},
"required": true
}
},
"get": {
"summary": "List Sub-Statuses",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"SubStatuses"
],
"description": "List Sub-Statuses",
"operationId": "listSubStatuses",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[parent_status]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/sub_status_list"
}
}
}
}
}
}
},
"/v1/sub_statuses/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a Sub-Status",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"SubStatuses"
],
"description": "Retrieves a specific Sub-Status by id",
"operationId": "getSubStatus",
"responses": {
"200": {
"description": "sub_status found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "a93b3d04-fe09-4ebc-9324-3c78c16013f7",
"type": "sub_statuses",
"attributes": {
"name": "5kxqx",
"description": "Amet distinctio alias quo.",
"slug": "5kxqx",
"parent_status": "started",
"position": 3,
"deleted_at": null,
"updated_at": "2025-07-12T00:19:55.851-07:00",
"created_at": "2025-07-12T00:19:55.851-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/sub_status_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a Sub-Status",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"SubStatuses"
],
"description": "Update a specific Sub-Status by id",
"operationId": "updateSubStatus",
"parameters": [],
"responses": {
"200": {
"description": "sub_status updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "a93b3d04-fe09-4ebc-9324-3c78c16013f7",
"type": "sub_statuses",
"attributes": {
"name": "5kxqx",
"description": "Updated description",
"slug": "5kxqx",
"parent_status": "started",
"position": 3,
"deleted_at": null,
"updated_at": "2025-07-12T00:19:58.468-07:00",
"created_at": "2025-07-12T00:19:55.851-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/sub_status_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_sub_status"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a Sub-Status",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"SubStatuses"
],
"description": "Delete a specific Sub-Status by id",
"operationId": "deleteSubStatus",
"responses": {
"200": {
"description": "sub_status deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "a93b3d04-fe09-4ebc-9324-3c78c16013f7",
"type": "sub_statuses",
"attributes": {
"name": "5kxqx",
"description": "Amet distinctio alias quo.",
"slug": "5kxqx",
"parent_status": "started",
"position": 3,
"deleted_at": "2025-07-12T00:19:58.953-07:00",
"updated_at": "2025-07-12T00:19:58.953-07:00",
"created_at": "2025-07-12T00:19:55.851-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/sub_status_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/teams": {
"post": {
"summary": "Creates a team",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Teams"
],
"description": "Creates a new team from provided data",
"operationId": "createTeam",
"parameters": [],
"responses": {
"201": {
"description": "team created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "73f9488f-36a9-46cb-b722-ccb329fc0067",
"type": "groups",
"attributes": {
"slug": "infrastructure",
"name": "Infrastructure",
"description": "Everything infrastructure related",
"color": "#FFF",
"position": 1,
"notify_emails": [
"john@rootly.com",
"doe@rootly.com"
],
"slack_channels": [
{
"id": "C03MKDSEJE8",
"name": "infrastructure"
}
],
"slack_aliases": [
{
"id": "S03F7QUV7F1",
"name": "infrastructure"
}
],
"pagerduty_id": "PQ9K7I8",
"pagerduty_service_id": null,
"backstage_id": null,
"external_id": "d795fe69-acc2-4b30-92c9-3c25cbb92056",
"opsgenie_id": "8743a1b2-11da-480e-8493-744660987bef",
"victor_ops_id": "e877c558-12e2-44d2-8723-5c86f7473c54",
"pagertree_id": "daa8bcd6-bf4a-4716-976c-812832ae115e",
"cortex_id": null,
"service_now_ci_sys_id": null,
"user_ids": [
482,
483
],
"admin_ids": [],
"incidents_count": 0,
"alert_urgency_id": null,
"alerts_email_enabled": true,
"alerts_email_address": "group-927b6688676f0a83f971c03bd490a995@test.email.rootly.com",
"created_at": "2025-07-12T00:20:06.261-07:00",
"updated_at": "2025-07-12T00:20:06.271-07:00"
},
"relationships": {
"users": {
"data": [
{
"id": "482",
"type": "users"
},
{
"id": "483",
"type": "users"
}
]
}
}
}
},
"schema": {
"$ref": "#/components/schemas/team_response"
}
}
}
},
"422": {
"description": "invalid association",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_team"
}
}
},
"required": true
}
},
"get": {
"summary": "List teams",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Teams"
],
"description": "List teams",
"operationId": "listTeams",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: users",
"schema": {
"type": "string",
"enum": [
"users"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[backstage_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[cortex_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[opslevel_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[external_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/team_list"
}
}
}
}
}
}
},
"/v1/teams/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a team",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Teams"
],
"description": "Retrieves a specific team by id",
"operationId": "getTeam",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: users",
"schema": {
"type": "string",
"enum": [
"users"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "team found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "d3e9aac3-e91e-4843-8aed-dd1c4a4a669a",
"type": "groups",
"attributes": {
"slug": "omnis-aliquam-sit-voluptatem",
"name": "Omnis aliquam sit voluptatem.",
"description": null,
"color": "#F4CFD1",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"pagerduty_id": null,
"pagerduty_service_id": null,
"backstage_id": null,
"external_id": null,
"opsgenie_id": null,
"victor_ops_id": null,
"pagertree_id": null,
"cortex_id": null,
"service_now_ci_sys_id": null,
"user_ids": [],
"admin_ids": [],
"incidents_count": 1,
"alert_urgency_id": null,
"alerts_email_enabled": false,
"alerts_email_address": "group-d2f6f6c0a987963502144908e9eb7f79@email.rootly.com",
"created_at": "2025-07-12T00:20:00.292-07:00",
"updated_at": "2025-07-12T00:20:00.292-07:00"
},
"relationships": {
"users": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/team_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a team",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Teams"
],
"description": "Update a specific team by id",
"operationId": "updateTeam",
"parameters": [],
"responses": {
"200": {
"description": "team updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "d3e9aac3-e91e-4843-8aed-dd1c4a4a669a",
"type": "groups",
"attributes": {
"slug": "security",
"name": "Security",
"description": "Everything security related",
"color": "#000",
"position": 2,
"notify_emails": [
"hello@rootly.com",
"world@rootly.com"
],
"slack_channels": [
{
"id": "C03MKDSEJE8",
"name": "infrastructure"
}
],
"slack_aliases": [
{
"id": "S03F7QUV7F1",
"name": "infrastructure"
}
],
"pagerduty_id": "PQ9K7I9",
"pagerduty_service_id": null,
"backstage_id": null,
"external_id": "95ee00ee-4b35-40f7-bd0f-a919f9b8008d",
"opsgenie_id": "a6edf90f-1a61-4592-99a7-bcf101c81bca",
"victor_ops_id": "0ae4de13-145a-4214-9cd5-c982ef95a740",
"pagertree_id": "c4378a92-505c-49e4-a46e-c44c830bbc99",
"cortex_id": null,
"service_now_ci_sys_id": null,
"user_ids": [
482
],
"admin_ids": [],
"incidents_count": 1,
"alert_urgency_id": null,
"alerts_email_enabled": false,
"alerts_email_address": "group-d2f6f6c0a987963502144908e9eb7f79@email.rootly.com",
"created_at": "2025-07-12T00:20:00.292-07:00",
"updated_at": "2025-07-12T00:20:08.101-07:00"
},
"relationships": {
"users": {
"data": [
{
"id": "482",
"type": "users"
}
]
}
}
}
},
"schema": {
"$ref": "#/components/schemas/team_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_team"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a team",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Teams"
],
"description": "Delete a specific team by id",
"operationId": "deleteTeam",
"responses": {
"200": {
"description": "team deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "d3e9aac3-e91e-4843-8aed-dd1c4a4a669a",
"type": "groups",
"attributes": {
"slug": "omnis-aliquam-sit-voluptatem",
"name": "Omnis aliquam sit voluptatem.",
"description": null,
"color": "#F4CFD1",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"pagerduty_id": null,
"pagerduty_service_id": null,
"backstage_id": null,
"external_id": null,
"opsgenie_id": null,
"victor_ops_id": null,
"pagertree_id": null,
"cortex_id": null,
"service_now_ci_sys_id": null,
"user_ids": [],
"admin_ids": [],
"incidents_count": 1,
"alert_urgency_id": null,
"alerts_email_enabled": false,
"alerts_email_address": "group-d2f6f6c0a987963502144908e9eb7f79@email.rootly.com",
"created_at": "2025-07-12T00:20:00.292-07:00",
"updated_at": "2025-07-12T00:20:08.700-07:00"
},
"relationships": {
"users": {
"data": []
}
}
}
},
"schema": {
"$ref": "#/components/schemas/team_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/teams/{id}/incidents_chart": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Get team incidents chart",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Teams"
],
"description": "Get team incidents chart",
"operationId": "getTeamIncidentsChart",
"parameters": [
{
"name": "period",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"2025-06-11": 0,
"2025-06-12": 0,
"2025-06-13": 0,
"2025-06-14": 0,
"2025-06-15": 0,
"2025-06-16": 0,
"2025-06-17": 0,
"2025-06-18": 0,
"2025-06-19": 0,
"2025-06-20": 0,
"2025-06-21": 0,
"2025-06-22": 0,
"2025-06-23": 0,
"2025-06-24": 0,
"2025-06-25": 0,
"2025-06-26": 0,
"2025-06-27": 0,
"2025-06-28": 0,
"2025-06-29": 0,
"2025-06-30": 0,
"2025-07-01": 0,
"2025-07-02": 0,
"2025-07-03": 0,
"2025-07-04": 0,
"2025-07-05": 0,
"2025-07-06": 0,
"2025-07-07": 0,
"2025-07-08": 0,
"2025-07-09": 1,
"2025-07-10": 0,
"2025-07-11": 0,
"2025-07-12": 0
}
},
"schema": {
"$ref": "#/components/schemas/incidents_chart_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/users/{user_id}/email_addresses": {
"parameters": [
{
"name": "user_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a user email address",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserEmailAddresses"
],
"description": "Creates a new user email address from provided data",
"operationId": "createUserEmailAddress",
"parameters": [],
"responses": {
"201": {
"description": "user_email_address created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "562ffb1b-e3be-48ab-8aa2-5b254a3deb6a",
"type": "user_email_addresses",
"attributes": {
"user_id": 487,
"email": "test@example.com",
"primary": false,
"created_at": "2025-07-12T00:20:11.879-07:00",
"updated_at": "2025-07-12T00:20:11.879-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/user_email_address_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "responds with not found when accessing other user's resources",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_user_email_address"
}
}
},
"required": true
}
},
"get": {
"summary": "Retrieves user email addresses",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserEmailAddresses"
],
"description": "Retrieves all email addresses for the specified user",
"operationId": "getUserEmailAddresses",
"responses": {
"200": {
"description": "user_email_addresses found",
"content": {
"application/vnd.api+json": {
"example": {
"data": [
{
"id": "3d627321-c951-4f5b-ad6b-030e6083f8f8",
"type": "user_email_addresses",
"attributes": {
"user_id": 487,
"email": "dominica.schuster@crist-lueilwitz.test",
"primary": true,
"created_at": "2025-07-12T00:20:09.575-07:00",
"updated_at": "2025-07-12T00:20:09.575-07:00"
}
},
{
"id": "fd54edf3-e2bc-47e6-bef6-f1276ade7760",
"type": "user_email_addresses",
"attributes": {
"user_id": 487,
"email": "clarence.runte@murphy-watsica.example",
"primary": false,
"created_at": "2025-07-12T00:20:12.302-07:00",
"updated_at": "2025-07-12T00:20:12.302-07:00"
}
},
{
"id": "e5a824cb-dabe-4d52-ac48-620fb080e63f",
"type": "user_email_addresses",
"attributes": {
"user_id": 487,
"email": "gregg@stark.example",
"primary": false,
"created_at": "2025-07-12T00:20:12.322-07:00",
"updated_at": "2025-07-12T00:20:12.322-07:00"
}
}
],
"links": {
"self": "http://www.example.com/v1/users/487/email_addresses?page%5Bnumber%5D=1&page%5Bsize%5D=50",
"first": "http://www.example.com/v1/users/487/email_addresses?page%5Bnumber%5D=1&page%5Bsize%5D=50",
"prev": null,
"next": null,
"last": "http://www.example.com/v1/users/487/email_addresses?page%5Bnumber%5D=1&page%5Bsize%5D=50"
},
"meta": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_count": 3,
"total_pages": 1
}
},
"schema": {
"$ref": "#/components/schemas/user_email_address_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "responds with not found when accessing other user's resources",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/email_addresses/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Show user email address",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserEmailAddresses"
],
"description": "Retrieves a specific user email address",
"operationId": "showUserEmailAddress",
"responses": {
"200": {
"description": "user_email_address found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "33dcd235-5ab0-4e6a-9815-eead5c1c4743",
"type": "user_email_addresses",
"attributes": {
"user_id": 487,
"email": "america@wintheiser.example",
"primary": false,
"created_at": "2025-07-12T00:20:12.864-07:00",
"updated_at": "2025-07-12T00:20:12.864-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/user_email_address_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "responds with not found when accessing other user's resources",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update user email address",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserEmailAddresses"
],
"description": "Updates a user email address",
"operationId": "updateUserEmailAddress",
"parameters": [],
"responses": {
"200": {
"description": "user_email_address updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "41bf7991-1afb-4041-95ed-fbf9846f741f",
"type": "user_email_addresses",
"attributes": {
"user_id": 487,
"email": "updated@example.com",
"primary": false,
"created_at": "2025-07-12T00:20:13.346-07:00",
"updated_at": "2025-07-12T00:20:13.496-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/user_email_address_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "responds with not found when accessing other user's resources",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_user_email_address"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete user email address",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserEmailAddresses"
],
"description": "Deletes a user email address",
"operationId": "deleteUserEmailAddress",
"responses": {
"200": {
"description": "user_email_address deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "a22d026a-0e84-48fa-9eaa-5cc8452f8213",
"type": "user_email_addresses",
"attributes": {
"user_id": 487,
"email": "mora@bartoletti-terry.test",
"primary": false,
"created_at": "2025-07-12T00:20:13.995-07:00",
"updated_at": "2025-07-12T00:20:14.133-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/user_email_address_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "responds with not found when accessing other user's resources",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/users/{user_id}/notification_rules": {
"parameters": [
{
"name": "user_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an user notification rule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserNotificationRules"
],
"description": "Creates a new user notification rule from provided data",
"operationId": "createUserNotificationRule",
"parameters": [],
"responses": {
"201": {
"description": "user_notification_rule created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "b91ff3d3-7119-4a9c-b07a-684af420c41c",
"type": "user_notification_rules",
"attributes": {
"user_id": 492,
"delay": 2,
"position": 1,
"user_email_address_id": "630fe241-42f2-4b9e-9980-31dab7e6e63f",
"user_call_number_id": "29112d57-1a5a-4c18-8a75-6375776b962c",
"user_sms_number_id": "29112d57-1a5a-4c18-8a75-6375776b962c",
"user_device_id": "eff7c736-0326-42a6-8c1a-3c091d1c2352",
"enabled_contact_types": [
"email"
],
"created_at": "2025-07-12T00:20:16.331-07:00",
"updated_at": "2025-07-12T00:20:16.331-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/user_notification_rule_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Enabled contact types You must select at least 1 contact type",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_user_notification_rule"
}
}
},
"required": true
}
},
"get": {
"summary": "List user notification rules",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserNotificationRules"
],
"description": "List user notification rules",
"operationId": "listUserNotificationRules",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/user_notification_rule_list"
}
}
}
}
}
}
},
"/v1/notification_rules/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an user notification rule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserNotificationRules"
],
"description": "Retrieves a specific user notification rule by id",
"operationId": "getUserNotificationRule",
"responses": {
"200": {
"description": "user_notification_rule found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "10a1c948-a3cd-4f91-aa36-cb0951cae76e",
"type": "user_notification_rules",
"attributes": {
"user_id": 492,
"delay": 1,
"position": 2,
"user_email_address_id": null,
"user_call_number_id": null,
"user_sms_number_id": null,
"user_device_id": null,
"enabled_contact_types": [
"email"
],
"created_at": "2025-07-12T00:20:16.155-07:00",
"updated_at": "2025-07-12T00:20:16.163-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/user_notification_rule_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an user notification rule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserNotificationRules"
],
"description": "Update a specific user notification rule by id",
"operationId": "updateUserNotificationRule",
"parameters": [],
"responses": {
"200": {
"description": "user_notification_rule updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "10a1c948-a3cd-4f91-aa36-cb0951cae76e",
"type": "user_notification_rules",
"attributes": {
"user_id": 492,
"delay": 2,
"position": 1,
"user_email_address_id": "630fe241-42f2-4b9e-9980-31dab7e6e63f",
"user_call_number_id": "29112d57-1a5a-4c18-8a75-6375776b962c",
"user_sms_number_id": null,
"user_device_id": "eff7c736-0326-42a6-8c1a-3c091d1c2352",
"enabled_contact_types": [
"device"
],
"created_at": "2025-07-12T00:20:16.155-07:00",
"updated_at": "2025-07-12T00:20:17.461-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/user_notification_rule_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_user_notification_rule"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an user notification rule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserNotificationRules"
],
"description": "Delete a specific user notification rule by id",
"operationId": "deleteUserNotificationRule",
"responses": {
"200": {
"description": "user_notification_rule deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "10a1c948-a3cd-4f91-aa36-cb0951cae76e",
"type": "user_notification_rules",
"attributes": {
"user_id": 492,
"delay": 1,
"position": 2,
"user_email_address_id": null,
"user_call_number_id": null,
"user_sms_number_id": null,
"user_device_id": null,
"enabled_contact_types": [
"email"
],
"created_at": "2025-07-12T00:20:16.155-07:00",
"updated_at": "2025-07-12T00:20:16.163-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/user_notification_rule_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/users/{user_id}/phone_numbers": {
"parameters": [
{
"name": "user_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a user phone number",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserPhoneNumbers"
],
"description": "Creates a new user phone number from provided data",
"operationId": "createUserPhoneNumber",
"parameters": [],
"responses": {
"201": {
"description": "user_phone_number created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "7a477f47-0b83-477f-ae83-d56b20e3ff99",
"type": "user_phone_numbers",
"attributes": {
"user_id": 494,
"phone": "+14155552671",
"primary": true,
"created_at": "2025-07-12T00:20:20.258-07:00",
"updated_at": "2025-07-12T00:20:20.258-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/user_phone_number_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_user_phone_number"
}
}
},
"required": true
}
},
"get": {
"summary": "Retrieves user phone numbers",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserPhoneNumbers"
],
"description": "Retrieves all phone numbers for the specified user",
"operationId": "getUserPhoneNumbers",
"responses": {
"200": {
"description": "user_phone_numbers found",
"content": {
"application/vnd.api+json": {
"example": {
"data": [
{
"id": "5212000e-51bf-4176-8a41-1adce8ecbc08",
"type": "user_phone_numbers",
"attributes": {
"user_id": 494,
"phone": "+19099719430 x4310",
"primary": true,
"created_at": "2025-07-12T00:20:20.771-07:00",
"updated_at": "2025-07-12T00:20:20.771-07:00"
}
},
{
"id": "19a35967-b213-48a5-b198-f6c4e67270f0",
"type": "user_phone_numbers",
"attributes": {
"user_id": 494,
"phone": "+14355808207",
"primary": false,
"created_at": "2025-07-12T00:20:20.807-07:00",
"updated_at": "2025-07-12T00:20:20.807-07:00"
}
}
],
"links": {
"self": "http://www.example.com/v1/users/494/phone_numbers?page%5Bnumber%5D=1&page%5Bsize%5D=50",
"first": "http://www.example.com/v1/users/494/phone_numbers?page%5Bnumber%5D=1&page%5Bsize%5D=50",
"prev": null,
"next": null,
"last": "http://www.example.com/v1/users/494/phone_numbers?page%5Bnumber%5D=1&page%5Bsize%5D=50"
},
"meta": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_count": 2,
"total_pages": 1
}
},
"schema": {
"$ref": "#/components/schemas/user_phone_number_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/phone_numbers/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Show user phone number",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserPhoneNumbers"
],
"description": "Retrieves a specific user phone number",
"operationId": "showUserPhoneNumber",
"responses": {
"200": {
"description": "user_phone_number found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "54964537-ae1e-4c3b-9c47-817dd3dfa8f5",
"type": "user_phone_numbers",
"attributes": {
"user_id": 494,
"phone": "+15132069595 x2061",
"primary": true,
"created_at": "2025-07-12T00:20:21.252-07:00",
"updated_at": "2025-07-12T00:20:21.252-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/user_phone_number_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update user phone number",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserPhoneNumbers"
],
"description": "Updates a user phone number",
"operationId": "updateUserPhoneNumber",
"parameters": [],
"responses": {
"200": {
"description": "user_phone_number updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "7641be3c-ab5d-4dd1-97dd-1d4b5b923096",
"type": "user_phone_numbers",
"attributes": {
"user_id": 494,
"phone": "+14155553000",
"primary": true,
"created_at": "2025-07-12T00:20:21.713-07:00",
"updated_at": "2025-07-12T00:20:21.868-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/user_phone_number_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_user_phone_number"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete user phone number",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserPhoneNumbers"
],
"description": "Deletes a user phone number",
"operationId": "deleteUserPhoneNumber",
"responses": {
"200": {
"description": "user_phone_number deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "87acedf9-3225-4a1e-8e72-d512cb107e72",
"type": "user_phone_numbers",
"attributes": {
"user_id": 494,
"phone": "+18608702094 x7391",
"primary": true,
"created_at": "2025-07-12T00:20:22.500-07:00",
"updated_at": "2025-07-12T00:20:22.652-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/user_phone_number_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/users": {
"get": {
"summary": "List users",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Users"
],
"description": "List users",
"operationId": "listUsers",
"parameters": [
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[email]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at"
]
},
"required": false
},
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: email_addresses,phone_numbers",
"schema": {
"type": "string",
"enum": [
"email_addresses",
"phone_numbers",
"devices",
"role",
"on_call_role"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "user found",
"content": {
"application/vnd.api+json": {
"example": {
"data": [
{
"id": "511",
"type": "users",
"attributes": {
"name": "Reatha Daugherty",
"email": "christene@dooley-walker.test",
"phone": null,
"phone_2": null,
"first_name": "Reatha",
"last_name": "Daugherty",
"full_name": "Reatha Daugherty",
"full_name_with_team": "[Lesch, Parker and Stamm] Reatha Daugherty",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:20:25.848-07:00",
"created_at": "2025-07-12T00:20:25.848-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "0426f8cb-bbe1-455d-bdb8-abe4596159af",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "b2aa8198-4fa9-425a-9d42-4f16d525ed80",
"type": "roles"
}
},
"on_call_role": {
"data": {
"id": "4501a060-5231-43b0-91e0-145b637aeda7",
"type": "on_call_roles"
}
}
}
},
{
"id": "510",
"type": "users",
"attributes": {
"name": "Augustine Erdman",
"email": "galen_gerlach@hansen-dickinson.example",
"phone": null,
"phone_2": null,
"first_name": "Augustine",
"last_name": "Erdman",
"full_name": "Augustine Erdman",
"full_name_with_team": "[Lesch, Parker and Stamm] Augustine Erdman",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:20:25.739-07:00",
"created_at": "2025-07-12T00:20:25.739-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "5383e6de-f27e-45d9-a4ad-cdf67991c34f",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "bfa92a6b-5c52-4965-b82c-e0faba972a8a",
"type": "roles"
}
},
"on_call_role": {
"data": {
"id": "4501a060-5231-43b0-91e0-145b637aeda7",
"type": "on_call_roles"
}
}
}
},
{
"id": "509",
"type": "users",
"attributes": {
"name": "Kenneth Emard",
"email": "chad.balistreri@runolfsdottir.test",
"phone": null,
"phone_2": null,
"first_name": "Kenneth",
"last_name": "Emard",
"full_name": "Kenneth Emard",
"full_name_with_team": "[Lesch, Parker and Stamm] Kenneth Emard",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:20:25.602-07:00",
"created_at": "2025-07-12T00:20:25.602-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "c846f834-1887-49d2-a9fd-dd29c5fceb93",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "d1a91baa-7f8f-4cd8-965e-178352d32dfd",
"type": "roles"
}
},
"on_call_role": {
"data": {
"id": "4501a060-5231-43b0-91e0-145b637aeda7",
"type": "on_call_roles"
}
}
}
},
{
"id": "507",
"type": "users",
"attributes": {
"name": "Robert Hermann",
"email": "melvin@luettgen.example",
"phone": null,
"phone_2": null,
"first_name": "Robert",
"last_name": "Hermann",
"full_name": "Robert Hermann",
"full_name_with_team": "[Lesch, Parker and Stamm] Robert Hermann",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:20:25.067-07:00",
"created_at": "2025-07-12T00:20:25.067-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "0600ae18-6898-4450-84f1-779bc582e07a",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "bfa92a6b-5c52-4965-b82c-e0faba972a8a",
"type": "roles"
}
},
"on_call_role": {
"data": {
"id": "4501a060-5231-43b0-91e0-145b637aeda7",
"type": "on_call_roles"
}
}
}
},
{
"id": "506",
"type": "users",
"attributes": {
"name": "Sonya Miller",
"email": "boyd@hansen.test",
"phone": null,
"phone_2": null,
"first_name": "Sonya",
"last_name": "Miller",
"full_name": "Sonya Miller",
"full_name_with_team": "[Lesch, Parker and Stamm] Sonya Miller",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:20:24.969-07:00",
"created_at": "2025-07-12T00:20:24.969-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "d7975fe5-c919-4f7c-93bd-2b0292001a63",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "bfa92a6b-5c52-4965-b82c-e0faba972a8a",
"type": "roles"
}
},
"on_call_role": {
"data": {
"id": "4501a060-5231-43b0-91e0-145b637aeda7",
"type": "on_call_roles"
}
}
}
},
{
"id": "505",
"type": "users",
"attributes": {
"name": "Shavonne Terry",
"email": "gilma_lind@gleichner-turcotte.test",
"phone": null,
"phone_2": null,
"first_name": "Shavonne",
"last_name": "Terry",
"full_name": "Shavonne Terry",
"full_name_with_team": "[Lesch, Parker and Stamm] Shavonne Terry",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:20:24.868-07:00",
"created_at": "2025-07-12T00:20:24.868-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "25cb695b-f1b4-4665-bdb7-08606c464779",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "bfa92a6b-5c52-4965-b82c-e0faba972a8a",
"type": "roles"
}
},
"on_call_role": {
"data": {
"id": "4501a060-5231-43b0-91e0-145b637aeda7",
"type": "on_call_roles"
}
}
}
},
{
"id": "504",
"type": "users",
"attributes": {
"name": "Rory Zemlak",
"email": "jack@stoltenberg.example",
"phone": null,
"phone_2": null,
"first_name": "Rory",
"last_name": "Zemlak",
"full_name": "Rory Zemlak",
"full_name_with_team": "[Lesch, Parker and Stamm] Rory Zemlak",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:20:24.766-07:00",
"created_at": "2025-07-12T00:20:24.766-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a7cb1a5c-bc33-42c9-a507-3cb2eb2d4f8f",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "bfa92a6b-5c52-4965-b82c-e0faba972a8a",
"type": "roles"
}
},
"on_call_role": {
"data": {
"id": "4501a060-5231-43b0-91e0-145b637aeda7",
"type": "on_call_roles"
}
}
}
},
{
"id": "503",
"type": "users",
"attributes": {
"name": "Brad Williamson",
"email": "ozzie.hessel@marks-goyette.example",
"phone": null,
"phone_2": null,
"first_name": "Brad",
"last_name": "Williamson",
"full_name": "Brad Williamson",
"full_name_with_team": "[Lesch, Parker and Stamm] Brad Williamson",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:20:24.662-07:00",
"created_at": "2025-07-12T00:20:24.662-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "a5dac8d7-cc9d-437f-a0a3-7b357da32cf5",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "bfa92a6b-5c52-4965-b82c-e0faba972a8a",
"type": "roles"
}
},
"on_call_role": {
"data": {
"id": "4501a060-5231-43b0-91e0-145b637aeda7",
"type": "on_call_roles"
}
}
}
},
{
"id": "502",
"type": "users",
"attributes": {
"name": "Fiona Weimann",
"email": "will.rolfson@brakus.example",
"phone": null,
"phone_2": null,
"first_name": "Fiona",
"last_name": "Weimann",
"full_name": "Fiona Weimann",
"full_name_with_team": "[Lesch, Parker and Stamm] Fiona Weimann",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:20:24.555-07:00",
"created_at": "2025-07-12T00:20:24.555-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "24a43b8c-128c-4c92-a2ae-1dbc20befa66",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "bfa92a6b-5c52-4965-b82c-e0faba972a8a",
"type": "roles"
}
},
"on_call_role": {
"data": {
"id": "4501a060-5231-43b0-91e0-145b637aeda7",
"type": "on_call_roles"
}
}
}
},
{
"id": "501",
"type": "users",
"attributes": {
"name": "Gilberto Okuneva",
"email": "gracia@pouros-cartwright.test",
"phone": null,
"phone_2": null,
"first_name": "Gilberto",
"last_name": "Okuneva",
"full_name": "Gilberto Okuneva",
"full_name_with_team": "[Lesch, Parker and Stamm] Gilberto Okuneva",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:20:24.450-07:00",
"created_at": "2025-07-12T00:20:24.450-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "8f6e1986-64d0-47a7-a562-78b20ad3c70d",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "bfa92a6b-5c52-4965-b82c-e0faba972a8a",
"type": "roles"
}
},
"on_call_role": {
"data": {
"id": "4501a060-5231-43b0-91e0-145b637aeda7",
"type": "on_call_roles"
}
}
}
},
{
"id": "500",
"type": "users",
"attributes": {
"name": "Efrain Davis",
"email": "jasper@bayer-leuschke.test",
"phone": null,
"phone_2": null,
"first_name": "Efrain",
"last_name": "Davis",
"full_name": "Efrain Davis",
"full_name_with_team": "[Lesch, Parker and Stamm] Efrain Davis",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:20:24.342-07:00",
"created_at": "2025-07-12T00:20:24.342-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "09a7c747-fb8b-4aca-96d7-b2bdd75b87da",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "bfa92a6b-5c52-4965-b82c-e0faba972a8a",
"type": "roles"
}
},
"on_call_role": {
"data": {
"id": "4501a060-5231-43b0-91e0-145b637aeda7",
"type": "on_call_roles"
}
}
}
},
{
"id": "499",
"type": "users",
"attributes": {
"name": "Harland Raynor",
"email": "nana@harris.example",
"phone": null,
"phone_2": null,
"first_name": "Harland",
"last_name": "Raynor",
"full_name": "Harland Raynor",
"full_name_with_team": "[Lesch, Parker and Stamm] Harland Raynor",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:20:24.234-07:00",
"created_at": "2025-07-12T00:20:24.234-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "e6fd0288-5111-42e3-8d03-f2e2359e322e",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "bfa92a6b-5c52-4965-b82c-e0faba972a8a",
"type": "roles"
}
},
"on_call_role": {
"data": {
"id": "4501a060-5231-43b0-91e0-145b637aeda7",
"type": "on_call_roles"
}
}
}
},
{
"id": "498",
"type": "users",
"attributes": {
"name": "Lore Schinner",
"email": "anette_jones@hyatt.test",
"phone": null,
"phone_2": null,
"first_name": "Lore",
"last_name": "Schinner",
"full_name": "Lore Schinner",
"full_name_with_team": "[Lesch, Parker and Stamm] Lore Schinner",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:20:29.243-07:00",
"created_at": "2025-07-12T00:20:23.796-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "3d657781-80dd-4c57-a6d6-bcc298b0b7ba",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "d1a91baa-7f8f-4cd8-965e-178352d32dfd",
"type": "roles"
}
},
"on_call_role": {
"data": {
"id": "4501a060-5231-43b0-91e0-145b637aeda7",
"type": "on_call_roles"
}
}
}
}
],
"links": {
"self": "http://www.example.com/v1/users?page%5Bnumber%5D=1&page%5Bsize%5D=50",
"first": "http://www.example.com/v1/users?page%5Bnumber%5D=1&page%5Bsize%5D=50",
"prev": null,
"next": null,
"last": "http://www.example.com/v1/users?page%5Bnumber%5D=1&page%5Bsize%5D=50"
},
"meta": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_count": 13,
"total_pages": 1
}
},
"schema": {
"$ref": "#/components/schemas/user_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/users/me": {
"get": {
"summary": "Get current user",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Users"
],
"description": "Get current user",
"operationId": "getCurrentUser",
"responses": {
"200": {
"description": "user found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "498",
"type": "users",
"attributes": {
"name": "Lore Schinner",
"email": "anette_jones@hyatt.test",
"phone": null,
"phone_2": null,
"first_name": "Lore",
"last_name": "Schinner",
"full_name": "Lore Schinner",
"full_name_with_team": "[Lesch, Parker and Stamm] Lore Schinner",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:20:29.663-07:00",
"created_at": "2025-07-12T00:20:23.796-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "3d657781-80dd-4c57-a6d6-bcc298b0b7ba",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "d1a91baa-7f8f-4cd8-965e-178352d32dfd",
"type": "roles"
}
},
"on_call_role": {
"data": {
"id": "4501a060-5231-43b0-91e0-145b637aeda7",
"type": "on_call_roles"
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/user_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/users/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an user",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Users"
],
"description": "Retrieves a specific user by id",
"operationId": "getUser",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: email_addresses,phone_numbers",
"schema": {
"type": "string",
"enum": [
"email_addresses",
"phone_numbers",
"devices",
"role",
"on_call_role"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "user found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "498",
"type": "users",
"attributes": {
"name": "Lore Schinner",
"email": "anette_jones@hyatt.test",
"phone": null,
"phone_2": null,
"first_name": "Lore",
"last_name": "Schinner",
"full_name": "Lore Schinner",
"full_name_with_team": "[Lesch, Parker and Stamm] Lore Schinner",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:20:29.901-07:00",
"created_at": "2025-07-12T00:20:23.796-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "3d657781-80dd-4c57-a6d6-bcc298b0b7ba",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "d1a91baa-7f8f-4cd8-965e-178352d32dfd",
"type": "roles"
}
},
"on_call_role": {
"data": {
"id": "4501a060-5231-43b0-91e0-145b637aeda7",
"type": "on_call_roles"
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/user_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"delete": {
"summary": "Delete an user",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Users"
],
"description": "Delete a specific user by id",
"operationId": "deleteUser",
"responses": {
"200": {
"description": "user deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "499",
"type": "users",
"attributes": {
"name": "Harland Raynor",
"email": "nana@harris.example",
"phone": null,
"phone_2": null,
"first_name": "Harland",
"last_name": "Raynor",
"full_name": "Harland Raynor",
"full_name_with_team": "[Lesch, Parker and Stamm] Harland Raynor",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:20:24.234-07:00",
"created_at": "2025-07-12T00:20:24.234-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "e6fd0288-5111-42e3-8d03-f2e2359e322e",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": null
},
"on_call_role": {
"data": null
}
}
}
},
"schema": {
"$ref": "#/components/schemas/user_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a user",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Users"
],
"description": "Update a specific user by id",
"operationId": "updateUser",
"parameters": [],
"responses": {
"200": {
"description": "update name and role simultaneously",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "499",
"type": "users",
"attributes": {
"name": "New Name",
"email": "nana@harris.example",
"phone": null,
"phone_2": null,
"first_name": "New",
"last_name": "Name",
"full_name": "New Name",
"full_name_with_team": "[Lesch, Parker and Stamm] New Name",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-07-12T00:20:31.912-07:00",
"created_at": "2025-07-12T00:20:24.234-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "e6fd0288-5111-42e3-8d03-f2e2359e322e",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
},
"role": {
"data": {
"id": "e71d97bb-f8ad-4ef4-9a10-19d2de702052",
"type": "roles"
}
},
"on_call_role": {
"data": {
"id": "27a96641-53c5-432b-960a-aa96be5fcecd",
"type": "on_call_roles"
}
}
}
}
},
"schema": {
"$ref": "#/components/schemas/user_response"
}
}
}
},
"404": {
"description": "returns 404 for on_call_role_id belonging to another team",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"detail": "On-call role not found or does not belong to this team",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_user"
}
}
}
}
}
},
"/v1/webhooks/endpoints/{endpoint_id}/deliveries": {
"get": {
"summary": "List webhook deliveries",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WebhooksDeliveries"
],
"description": "List webhook deliveries for given endpoint",
"operationId": "listWebhooksDeliveries",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "endpoint_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/webhooks_delivery_list"
}
}
}
}
}
}
},
"/v1/webhooks/deliveries/{id}/deliver": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Retries a webhook delivery",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WebhooksDeliveries"
],
"description": "Retries a webhook delivery",
"operationId": "deliverWebhooksDelivery",
"responses": {
"200": {
"description": "webhooks_delivery delivered",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "7b6131e7-8ef8-4267-971d-ffdfdbaa43a1",
"type": "webhooks_deliveries",
"attributes": {
"endpoint_id": "5a1f2b3d-729d-4aae-9ad1-85584827534e",
"payload": "{\"event\":{\"id\":\"79b5497b-5ec7-4217-925d-8e1c5caf84bb\",\"type\":\"incident.created\",\"issued_at\":\"2025-07-12T00:20:34.808-07:00\"},\"data\":{\"id\":null,\"sequential_id\":null,\"title\":\"Considerate Refreshment\",\"slug\":\"considerate-refreshment\",\"kind\":\"normal\",\"private\":false,\"summary\":null,\"status\":\"started\",\"url\":\"http://localhost:3001/account/incidents\",\"short_url\":null,\"mitigation_message\":null,\"resolution_message\":null,\"cancellation_message\":null,\"public_title\":null,\"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_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,\"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,\"started_at\":\"2025-07-12T00:20:34.791-07:00\",\"detected_at\":null,\"acknowledged_at\":null,\"mitigated_at\":null,\"resolved_at\":null,\"cancelled_at\":null,\"created_at\":null,\"updated_at\":null,\"labels\":{},\"severity\":null,\"user\":null,\"started_by\":null,\"mitigated_by\":null,\"resolved_by\":null,\"cancelled_by\":null,\"causes\":[],\"roles\":[],\"environments\":[],\"incident_types\":[],\"services\":[],\"functionalities\":[],\"groups\":[],\"events\":[],\"action_items\":[],\"form_field_selections\":[],\"feedbacks\":[]}}",
"delivered_at": "2025-07-12T00:20:35.103-07:00",
"created_at": "2025-07-12T00:20:34.825-07:00",
"updated_at": "2025-07-12T00:20:35.103-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/webhooks_delivery_response"
}
}
}
}
}
}
},
"/v1/webhooks/deliveries/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a webhook delivery",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WebhooksDeliveries"
],
"description": "Retrieves a specific webhook delivery by id",
"operationId": "getWebhooksDelivery",
"responses": {
"200": {
"description": "webhooks_delivery found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "7b6131e7-8ef8-4267-971d-ffdfdbaa43a1",
"type": "webhooks_deliveries",
"attributes": {
"endpoint_id": "5a1f2b3d-729d-4aae-9ad1-85584827534e",
"payload": "{\"event\":{\"id\":\"79b5497b-5ec7-4217-925d-8e1c5caf84bb\",\"type\":\"incident.created\",\"issued_at\":\"2025-07-12T00:20:34.808-07:00\"},\"data\":{\"id\":null,\"sequential_id\":null,\"title\":\"Considerate Refreshment\",\"slug\":\"considerate-refreshment\",\"kind\":\"normal\",\"private\":false,\"summary\":null,\"status\":\"started\",\"url\":\"http://localhost:3001/account/incidents\",\"short_url\":null,\"mitigation_message\":null,\"resolution_message\":null,\"cancellation_message\":null,\"public_title\":null,\"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_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,\"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,\"started_at\":\"2025-07-12T00:20:34.791-07:00\",\"detected_at\":null,\"acknowledged_at\":null,\"mitigated_at\":null,\"resolved_at\":null,\"cancelled_at\":null,\"created_at\":null,\"updated_at\":null,\"labels\":{},\"severity\":null,\"user\":null,\"started_by\":null,\"mitigated_by\":null,\"resolved_by\":null,\"cancelled_by\":null,\"causes\":[],\"roles\":[],\"environments\":[],\"incident_types\":[],\"services\":[],\"functionalities\":[],\"groups\":[],\"events\":[],\"action_items\":[],\"form_field_selections\":[],\"feedbacks\":[]}}",
"delivered_at": null,
"created_at": "2025-07-12T00:20:34.825-07:00",
"updated_at": "2025-07-12T00:20:34.825-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/webhooks_delivery_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/webhooks/endpoints": {
"post": {
"summary": "Creates a webhook endpoint",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WebhooksEndpoints"
],
"description": "Creates a new webhook endpoint from provided data",
"operationId": "createWebhooksEndpoint",
"parameters": [],
"responses": {
"201": {
"description": "webhooks_endpoint created",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "0706c670-fde1-4bda-bc0e-dc6025b2cde1",
"type": "webhooks_endpoints",
"attributes": {
"team_id": 414,
"slug": "test-664aea7f-aaa8-4326-b870-3f29b3a290d6",
"name": "Test",
"url": "https://test.com/test",
"secret": "ZsPwEgiDWoXhYNT6",
"event_types": [
"incident.created"
],
"enabled": true,
"created_at": "2025-07-12T00:20:37.339-07:00",
"updated_at": "2025-07-12T00:20:37.339-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/webhooks_endpoint_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Name can't be blank",
"status": "422"
},
{
"title": "URL is not a valid URL",
"status": "422"
},
{
"title": "URL can't be blank",
"status": "422"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Invalid token",
"status": "401"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_webhooks_endpoint"
}
}
},
"required": true
}
},
"get": {
"summary": "List webhook endpoints",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WebhooksEndpoints"
],
"description": "List webhook endpoints",
"operationId": "listWebhooksEndpoints",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/webhooks_endpoint_list"
}
}
}
}
}
}
},
"/v1/webhooks/endpoints/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a webhook endpoint",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WebhooksEndpoints"
],
"description": "Retrieves a specific webhook endpoint by id",
"operationId": "getWebhooksEndpoint",
"responses": {
"200": {
"description": "webhooks_endpoint found",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "6b579b8b-c9e1-496e-82e7-14c2f3e822e8",
"type": "webhooks_endpoints",
"attributes": {
"team_id": 414,
"slug": "test",
"name": "test",
"url": "https://test.com",
"secret": "ayifT7TgerHWUbXh",
"event_types": [],
"enabled": true,
"created_at": "2025-07-12T00:20:37.178-07:00",
"updated_at": "2025-07-12T00:20:37.178-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/webhooks_endpoint_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a webhook endpoint",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WebhooksEndpoints"
],
"description": "Update a specific webhook endpoint by id",
"operationId": "updateWebhooksEndpoint",
"parameters": [],
"responses": {
"200": {
"description": "webhooks_endpoint updated",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "6b579b8b-c9e1-496e-82e7-14c2f3e822e8",
"type": "webhooks_endpoints",
"attributes": {
"team_id": 414,
"slug": "test",
"name": "Updated",
"url": "https://test.com",
"secret": "ayifT7TgerHWUbXh",
"event_types": [],
"enabled": true,
"created_at": "2025-07-12T00:20:37.178-07:00",
"updated_at": "2025-07-12T00:20:38.260-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/webhooks_endpoint_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_webhooks_endpoint"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a webhook endpoint",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WebhooksEndpoints"
],
"description": "Delete a specific webhook endpoint by id",
"operationId": "deleteWebhooksEndpoint",
"responses": {
"200": {
"description": "webhooks_endpoint deleted",
"content": {
"application/vnd.api+json": {
"example": {
"data": {
"id": "6b579b8b-c9e1-496e-82e7-14c2f3e822e8",
"type": "webhooks_endpoints",
"attributes": {
"team_id": 414,
"slug": "test",
"name": "test",
"url": "https://test.com",
"secret": "ayifT7TgerHWUbXh",
"event_types": [],
"enabled": true,
"created_at": "2025-07-12T00:20:37.178-07:00",
"updated_at": "2025-07-12T00:20:38.769-07:00"
}
}
},
"schema": {
"$ref": "#/components/schemas/webhooks_endpoint_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"example": {
"errors": [
{
"title": "Not found or unauthorized",
"status": "404"
}
]
},
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
}
},
"servers": [
{
"url": "https://api.rootly.com"
}
],
"components": {
"securitySchemes": {
"bearer_auth": {
"type": "http",
"scheme": "bearer"
}
},
"schemas": {
"attach_alert": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alerts"
]
},
"attributes": {
"type": "object",
"properties": {
"alert_ids": {
"type": "array",
"description": "Alert Id to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false,
"required": [
"alert_ids"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"new_alert": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alerts"
]
},
"attributes": {
"type": "object",
"properties": {
"noise": {
"type": "string",
"description": "Whether the alert is marked as noise",
"enum": [
"noise",
"not_noise"
],
"nullable": true
},
"source": {
"type": "string",
"description": "The source of the alert",
"enum": [
"rootly",
"manual",
"api",
"web",
"slack",
"email",
"workflow",
"live_call_routing",
"pagerduty",
"opsgenie",
"victorops",
"pagertree",
"datadog",
"nobl9",
"zendesk",
"asana",
"clickup",
"sentry",
"rollbar",
"jira",
"honeycomb",
"service_now",
"linear",
"grafana",
"alertmanager",
"google_cloud",
"generic_webhook",
"cloud_watch",
"azure",
"splunk",
"chronosphere",
"app_optics",
"bug_snag",
"monte_carlo",
"nagios",
"prtg",
"catchpoint",
"app_dynamics",
"checkly",
"new_relic",
"gitlab"
]
},
"status": {
"type": "string",
"enum": [
"open",
"triggered"
],
"description": "Only available for organizations with Rootly On-Call enabled. Can be one of open, triggered."
},
"summary": {
"type": "string",
"description": "The summary of the alert"
},
"description": {
"type": "string",
"description": "The description of the alert",
"nullable": true
},
"service_ids": {
"type": "array",
"description": "The Service ID's to attach to the alert. If your organization has On-Call enabled and your notification target is a Service. This field will be automatically set for you.",
"items": {
"type": "string"
},
"nullable": true
},
"group_ids": {
"type": "array",
"description": "The Group ID's to attach to the alert. If your organization has On-Call enabled and your notification target is a Group. This field will be automatically set for you.",
"items": {
"type": "string"
},
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "The Environment ID's to attach to the alert",
"items": {
"type": "string"
},
"nullable": true
},
"started_at": {
"type": "string",
"description": "Alert start datetime",
"format": "date-time",
"nullable": true
},
"ended_at": {
"type": "string",
"description": "Alert end datetime",
"format": "date-time",
"nullable": true
},
"external_id": {
"type": "string",
"description": "External ID",
"nullable": true
},
"external_url": {
"type": "string",
"description": "External Url",
"nullable": true
},
"alert_urgency_id": {
"type": "string",
"description": "The ID of the alert urgency",
"nullable": true
},
"notification_target_type": {
"type": "string",
"enum": [
"User",
"Group",
"EscalationPolicy",
"Service"
],
"description": "Only available for organizations with Rootly On-Call enabled. Can be one of Group, Service, EscalationPolicy, User.",
"nullable": true
},
"notification_target_id": {
"type": "string",
"description": "Only available for organizations with Rootly On-Call enabled. The _identifier_ of the notification target object.",
"nullable": true
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Key of the tag"
},
"value": {
"type": "string",
"description": "Value of the tag"
}
},
"required": [
"key",
"value"
],
"nullable": true
}
},
"data": {
"type": "object",
"description": "Additional data",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"source",
"summary"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_alert": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alerts"
]
},
"attributes": {
"type": "object",
"properties": {
"noise": {
"type": "string",
"description": "Whether the alert is marked as noise",
"enum": [
"noise",
"not_noise"
],
"nullable": true
},
"source": {
"type": "string",
"description": "The source of the alert",
"enum": [
"rootly",
"manual",
"api",
"web",
"slack",
"email",
"workflow",
"live_call_routing",
"pagerduty",
"opsgenie",
"victorops",
"pagertree",
"datadog",
"nobl9",
"zendesk",
"asana",
"clickup",
"sentry",
"rollbar",
"jira",
"honeycomb",
"service_now",
"linear",
"grafana",
"alertmanager",
"google_cloud",
"generic_webhook",
"cloud_watch",
"azure",
"splunk",
"chronosphere",
"app_optics",
"bug_snag",
"monte_carlo",
"nagios",
"prtg",
"catchpoint",
"app_dynamics",
"checkly",
"new_relic",
"gitlab"
]
},
"summary": {
"type": "string",
"description": "The summary of the alert"
},
"description": {
"type": "string",
"description": "The description of the alert",
"nullable": true
},
"service_ids": {
"type": "array",
"description": "The Service ID's to attach to the alert",
"items": {
"type": "string"
},
"nullable": true
},
"group_ids": {
"type": "array",
"description": "The Group ID's to attach to the alert",
"items": {
"type": "string"
},
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "The Environment ID's to attach to the alert",
"items": {
"type": "string"
},
"nullable": true
},
"started_at": {
"type": "string",
"description": "Alert start datetime",
"format": "date-time",
"nullable": true
},
"ended_at": {
"type": "string",
"description": "Alert end datetime",
"format": "date-time",
"nullable": true
},
"external_id": {
"type": "string",
"description": "External ID",
"nullable": true
},
"external_url": {
"type": "string",
"description": "External Url",
"nullable": true
},
"alert_urgency_id": {
"type": "string",
"description": "The ID of the alert urgency",
"nullable": true
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Key of the tag"
},
"value": {
"type": "string",
"description": "Value of the tag"
}
},
"required": [
"key",
"value"
],
"nullable": true
}
},
"data": {
"type": "object",
"description": "Additional data",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"source",
"summary",
"attributes"
]
}
},
"required": [
"data"
]
},
"alert": {
"type": "object",
"properties": {
"noise": {
"type": "string",
"description": "Whether the alert is marked as noise",
"enum": [
"noise",
"not_noise"
],
"nullable": true
},
"source": {
"type": "string",
"description": "The source of the alert",
"enum": [
"rootly",
"manual",
"api",
"web",
"slack",
"email",
"workflow",
"live_call_routing",
"pagerduty",
"opsgenie",
"victorops",
"pagertree",
"datadog",
"nobl9",
"zendesk",
"asana",
"clickup",
"sentry",
"rollbar",
"jira",
"honeycomb",
"service_now",
"linear",
"grafana",
"alertmanager",
"google_cloud",
"generic_webhook",
"cloud_watch",
"azure",
"splunk",
"chronosphere",
"app_optics",
"bug_snag",
"monte_carlo",
"nagios",
"prtg",
"catchpoint",
"app_dynamics",
"checkly",
"new_relic",
"gitlab"
]
},
"status": {
"type": "string",
"enum": [
"open",
"triggered",
"acknowledged",
"resolved"
],
"description": "The status of the alert"
},
"summary": {
"type": "string",
"description": "The summary of the alert"
},
"description": {
"type": "string",
"description": "The description of the alert",
"nullable": true
},
"services": {
"type": "array",
"description": "Services attached to the alert",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/service"
}
]
}
},
"groups": {
"type": "array",
"description": "Groups attached to the alert",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/team"
}
]
}
},
"environments": {
"type": "array",
"description": "Environments attached to the alert",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/environment"
}
]
}
},
"service_ids": {
"type": "array",
"description": "The Service ID's to attach to the alert. If your organization has On-Call enabled and your notification target is a Service. This field will be automatically set for you.",
"items": {
"type": "string"
},
"nullable": true
},
"group_ids": {
"type": "array",
"description": "The Group ID's to attach to the alert. If your organization has On-Call enabled and your notification target is a Group. This field will be automatically set for you.",
"items": {
"type": "string"
},
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "The Environment ID's to attach to the alert",
"items": {
"type": "string"
},
"nullable": true
},
"external_id": {
"type": "string",
"description": "External ID",
"nullable": true
},
"external_url": {
"type": "string",
"description": "External Url",
"nullable": true
},
"alert_urgency_id": {
"type": "string",
"description": "The ID of the alert urgency",
"nullable": true
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Key of the tag"
},
"value": {
"type": "string",
"description": "Value of the tag"
}
},
"required": [
"key",
"value"
],
"nullable": true
}
},
"data": {
"type": "object",
"description": "Additional data",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"source",
"summary",
"created_at",
"updated_at"
]
},
"alert_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert"
},
"source": {
"type": "string",
"description": "The source of the alert",
"enum": [
"rootly",
"manual",
"api",
"web",
"slack",
"email",
"workflow",
"live_call_routing",
"pagerduty",
"opsgenie",
"victorops",
"pagertree",
"datadog",
"nobl9",
"zendesk",
"asana",
"clickup",
"sentry",
"rollbar",
"jira",
"honeycomb",
"service_now",
"linear",
"grafana",
"alertmanager",
"google_cloud",
"generic_webhook",
"cloud_watch",
"azure",
"splunk",
"chronosphere",
"app_optics",
"bug_snag",
"monte_carlo",
"nagios",
"prtg",
"catchpoint",
"app_dynamics",
"checkly",
"new_relic",
"gitlab"
]
},
"type": {
"type": "string",
"enum": [
"alerts"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"alert_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert"
},
"source": {
"type": "string",
"description": "The source of the alert",
"enum": [
"rootly",
"manual",
"api",
"web",
"slack",
"email",
"workflow",
"live_call_routing",
"pagerduty",
"opsgenie",
"victorops",
"pagertree",
"datadog",
"nobl9",
"zendesk",
"asana",
"clickup",
"sentry",
"rollbar",
"jira",
"honeycomb",
"service_now",
"linear",
"grafana",
"alertmanager",
"google_cloud",
"generic_webhook",
"cloud_watch",
"azure",
"splunk",
"chronosphere",
"app_optics",
"bug_snag",
"monte_carlo",
"nagios",
"prtg",
"catchpoint",
"app_dynamics",
"checkly",
"new_relic",
"gitlab"
]
},
"type": {
"type": "string",
"enum": [
"alerts"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"resolve_alert": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alerts"
]
},
"attributes": {
"type": "object",
"properties": {
"resolution_message": {
"type": "string",
"description": "How was the alert resolved?",
"nullable": true
},
"resolve_related_incidents": {
"type": "boolean",
"description": "Resolve all associated incidents",
"nullable": true
}
},
"additionalProperties": false
}
}
}
}
},
"new_alert_event": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_events"
]
},
"attributes": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"note"
]
},
"user_id": {
"type": "integer",
"description": "Author of the note."
},
"details": {
"type": "string",
"description": "Note message."
}
},
"additionalProperties": false,
"required": [
"kind",
"details"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_alert_event": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_events"
]
},
"attributes": {
"type": "object",
"properties": {
"user_id": {
"type": "integer",
"description": "Author of the note."
},
"details": {
"type": "string",
"description": "Note message."
}
},
"additionalProperties": false,
"required": [
"details"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"alert_event": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"informational",
"notification",
"action",
"status_update",
"recording",
"alert_grouping",
"alert_urgency",
"alert_routing",
"note",
"noise",
"maintenance"
]
},
"action": {
"type": "string",
"enum": [
"created",
"escalation_policy_paged",
"emailed",
"slacked",
"called",
"texted",
"notified",
"opened",
"retriggered",
"answered",
"acknowledged",
"escalated",
"paged",
"resolved",
"attached",
"snoozed",
"triggered",
"updated",
"added",
"removed",
"marked",
"not_marked",
"muted"
]
},
"source": {
"type": "string"
},
"user_id": {
"type": "integer",
"description": "Author of the note.",
"nullable": true
},
"details": {
"type": "string",
"description": "Note message.",
"nullable": true
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"source",
"kind",
"action",
"created_at",
"updated_at"
]
},
"alert_event_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert event"
},
"type": {
"type": "string",
"enum": [
"alert_events"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_event"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"alert_event_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert event"
},
"type": {
"type": "string",
"enum": [
"alert_events"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_event"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_alerts_source": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_sources"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert source"
},
"source_type": {
"type": "string",
"description": "The alert source type",
"enum": [
"email",
"app_dynamics",
"catchpoint",
"datadog",
"alertmanager",
"google_cloud",
"grafana",
"sentry",
"generic_webhook",
"cloud_watch",
"checkly",
"azure",
"new_relic",
"splunk",
"chronosphere",
"app_optics",
"bug_snag",
"honeycomb",
"monte_carlo",
"nagios",
"prtg"
]
},
"alert_urgency_id": {
"type": "string",
"description": "ID for the default alert urgency assigned to this alert source"
},
"owner_group_ids": {
"type": "array",
"description": "List of team IDs that will own the alert source",
"items": {
"type": "string"
}
},
"alert_template_attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The alert title.",
"nullable": true
},
"description": {
"type": "string",
"description": "The alert description.",
"nullable": true
},
"external_url": {
"type": "string",
"description": "The alert URL.",
"nullable": true
}
}
},
"alert_source_urgency_rules_attributes": {
"type": "array",
"description": "List of rules that define the conditions under which the alert urgency will be set automatically based on the alert payload",
"items": {
"type": "object",
"properties": {
"json_path": {
"type": "string",
"description": "JSON path expression to extract a specific value from the alert's payload for evaluation"
},
"operator": {
"type": "string",
"description": "Comparison operator used to evaluate the extracted value against the specified condition",
"enum": [
"is",
"is_not",
"contains",
"does_not_contain"
]
},
"value": {
"type": "string",
"description": "Value that the extracted payload data is compared to using the specified operator to determine a match"
},
"conditionable_type": {
"type": "string",
"description": "The type of the conditionable",
"enum": [
"AlertField"
]
},
"conditionable_id": {
"type": "string",
"description": "The ID of the conditionable. If conditionable_type is AlertField, this is the ID of the alert field."
},
"kind": {
"type": "string",
"description": "The kind of the conditionable",
"enum": [
"payload",
"alert_field"
]
},
"alert_urgency_id": {
"type": "string",
"description": "The ID of the alert urgency"
}
}
}
},
"sourceable_attributes": {
"type": "object",
"description": "Provide additional attributes for generic_webhook alerts source",
"properties": {
"auto_resolve": {
"type": "boolean",
"description": "Set this to true to auto-resolve alerts based on field_mappings_attributes conditions"
},
"resolve_state": {
"type": "string",
"description": "This value is matched with the value extracted from alerts payload using JSON path in field_mappings_attributes"
},
"accept_threaded_emails": {
"type": "boolean",
"description": "Set this to false to reject threaded emails"
},
"field_mappings_attributes": {
"type": "array",
"description": "Specify rules to auto resolve alerts",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "Select the field on which the condition to be evaluated",
"enum": [
"external_id",
"state",
"alert_title",
"alert_external_url",
"notification_target_type",
"notification_target_id"
]
},
"json_path": {
"type": "string",
"description": "JSON path expression to extract a specific value from the alert's payload for evaluation"
}
}
}
}
}
},
"resolution_rule_attributes": {
"type": "object",
"description": "Provide additional attributes for email alerts source",
"properties": {
"enabled": {
"type": "boolean",
"description": "Set this to true to enable the auto resolution rule"
},
"condition_type": {
"type": "string",
"description": "The type of condition to evaluate to apply auto resolution rule",
"enum": [
"all",
"any"
]
},
"identifier_matchable_type": {
"type": "string",
"description": "The type of the identifier matchable",
"enum": [
"AlertField"
]
},
"identifier_matchable_id": {
"type": "string",
"description": "The ID of the identifier matchable. If identifier_matchable_type is AlertField, this is the ID of the alert field."
},
"identifier_reference_kind": {
"type": "string",
"description": "The kind of the identifier reference",
"enum": [
"payload",
"alert_field"
]
},
"identifier_json_path": {
"type": "string",
"description": "JSON path expression to extract unique alert identifier used to match triggered alerts with resolving alerts"
},
"identifier_value_regex": {
"type": "string",
"description": "Regex group to further specify the part of the string used as a unique identifier"
},
"conditions_attributes": {
"type": "array",
"description": "List of conditions to evaluate for auto resolution",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "JSON path expression to extract a specific value from the alert's payload for evaluation"
},
"operator": {
"type": "string",
"description": "Comparison operator used to evaluate the extracted value against the specified condition",
"enum": [
"is",
"is_not",
"contains",
"does_not_contain",
"starts_with",
"ends_with"
]
},
"value": {
"type": "string",
"description": "Value that the extracted payload data is compared to using the specified operator to determine a match"
},
"conditionable_type": {
"type": "string",
"description": "The type of the conditionable",
"enum": [
"AlertField"
]
},
"conditionable_id": {
"type": "string",
"description": "The ID of the conditionable. If conditionable_type is AlertField, this is the ID of the alert field."
},
"kind": {
"type": "string",
"description": "The kind of the conditionable",
"enum": [
"payload",
"alert_field"
]
}
}
}
}
}
},
"alert_source_fields_attributes": {
"type": "array",
"description": "List of alert fields to be added to the alert source",
"items": {
"type": "object",
"properties": {
"alert_field_id": {
"type": "string",
"description": "The ID of the alert field"
},
"template_body": {
"type": "string",
"description": "Liquid expression to extract a specific value from the alert's payload for evaluation"
}
}
}
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_alerts_source": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_sources"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert source"
},
"source_type": {
"type": "string",
"description": "The alert source type",
"enum": [
"email",
"app_dynamics",
"catchpoint",
"datadog",
"alertmanager",
"google_cloud",
"grafana",
"sentry",
"generic_webhook",
"cloud_watch",
"checkly",
"azure",
"new_relic",
"splunk",
"chronosphere",
"app_optics",
"bug_snag",
"honeycomb",
"monte_carlo",
"nagios",
"prtg"
]
},
"alert_urgency_id": {
"type": "string",
"description": "ID for the default alert urgency assigned to this alert source"
},
"owner_group_ids": {
"type": "array",
"description": "List of team IDs that will own the alert source",
"items": {
"type": "string"
}
},
"alert_template_attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The alert title.",
"nullable": true
},
"description": {
"type": "string",
"description": "The alert description.",
"nullable": true
},
"external_url": {
"type": "string",
"description": "The alert URL.",
"nullable": true
}
}
},
"alert_source_urgency_rules_attributes": {
"type": "array",
"description": "List of rules that define the conditions under which the alert urgency will be set automatically based on the alert payload",
"items": {
"type": "object",
"properties": {
"json_path": {
"type": "string",
"description": "JSON path expression to extract a specific value from the alert's payload for evaluation"
},
"operator": {
"type": "string",
"description": "Comparison operator used to evaluate the extracted value against the specified condition",
"enum": [
"is",
"is_not",
"contains",
"does_not_contain"
]
},
"value": {
"type": "string",
"description": "Value that the extracted payload data is compared to using the specified operator to determine a match"
},
"conditionable_type": {
"type": "string",
"description": "The type of the conditionable",
"enum": [
"AlertField"
]
},
"conditionable_id": {
"type": "string",
"description": "The ID of the conditionable. If conditionable_type is AlertField, this is the ID of the alert field."
},
"kind": {
"type": "string",
"description": "The kind of the conditionable",
"enum": [
"payload",
"alert_field"
]
},
"alert_urgency_id": {
"type": "string",
"description": "The ID of the alert urgency"
}
}
}
},
"sourceable_attributes": {
"type": "object",
"description": "Provide additional attributes for generic_webhook alerts source",
"properties": {
"auto_resolve": {
"type": "boolean",
"description": "Set this to true to auto-resolve alerts based on field_mappings_attributes conditions"
},
"resolve_state": {
"type": "string",
"description": "This value is matched with the value extracted from alerts payload using JSON path in field_mappings_attributes"
},
"accept_threaded_emails": {
"type": "boolean",
"description": "Set this to false to reject threaded emails"
},
"field_mappings_attributes": {
"type": "array",
"description": "Specify rules to auto resolve alerts",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "Select the field on which the condition to be evaluated",
"enum": [
"external_id",
"state",
"alert_title",
"alert_external_url",
"notification_target_type",
"notification_target_id"
]
},
"json_path": {
"type": "string",
"description": "JSON path expression to extract a specific value from the alert's payload for evaluation"
}
}
}
}
}
},
"resolution_rule_attributes": {
"type": "object",
"description": "Provide additional attributes for email alerts source",
"properties": {
"enabled": {
"type": "boolean",
"description": "Set this to true to enable the auto resolution rule"
},
"condition_type": {
"type": "string",
"description": "The type of condition to evaluate to apply auto resolution rule",
"enum": [
"all",
"any"
]
},
"identifier_json_path": {
"type": "string",
"description": "JSON path expression to extract unique alert identifier used to match triggered alerts with resolving alerts"
},
"identifier_value_regex": {
"type": "string",
"description": "Regex group to further specify the part of the string used as a unique identifier"
},
"identifier_matchable_type": {
"type": "string",
"description": "The type of the identifier matchable",
"enum": [
"AlertField"
]
},
"identifier_matchable_id": {
"type": "string",
"description": "The ID of the identifier matchable. If identifier_matchable_type is AlertField, this is the ID of the alert field."
},
"identifier_reference_kind": {
"type": "string",
"description": "The kind of the identifier reference",
"enum": [
"payload",
"alert_field"
]
},
"conditions_attributes": {
"type": "array",
"description": "List of conditions to evaluate for auto resolution",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "JSON path expression to extract a specific value from the alert's payload for evaluation"
},
"operator": {
"type": "string",
"description": "Comparison operator used to evaluate the extracted value against the specified condition",
"enum": [
"is",
"is_not",
"contains",
"does_not_contain",
"starts_with",
"ends_with"
]
},
"value": {
"type": "string",
"description": "Value that the extracted payload data is compared to using the specified operator to determine a match"
},
"conditionable_type": {
"type": "string",
"description": "The type of the conditionable",
"enum": [
"AlertField"
]
},
"conditionable_id": {
"type": "string",
"description": "The ID of the conditionable. If conditionable_type is AlertField, this is the ID of the alert field."
},
"kind": {
"type": "string",
"description": "The kind of the conditionable",
"enum": [
"payload",
"alert_field"
]
}
}
}
}
}
},
"alert_source_fields_attributes": {
"type": "array",
"description": "List of alert fields to be added to the alert source",
"items": {
"type": "object",
"properties": {
"alert_field_id": {
"type": "string",
"description": "The ID of the alert field"
},
"template_body": {
"type": "string",
"description": "Liquid expression to extract a specific value from the alert's payload for evaluation"
}
}
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"alerts_source": {
"type": "object",
"properties": {
"alert_urgency_id": {
"type": "string",
"description": "ID for the default alert urgency assigned to this alert source"
},
"name": {
"type": "string",
"description": "The name of the alert source"
},
"source_type": {
"type": "string",
"description": "The alert source type",
"enum": [
"email",
"app_dynamics",
"catchpoint",
"datadog",
"alertmanager",
"google_cloud",
"grafana",
"sentry",
"generic_webhook",
"cloud_watch",
"checkly",
"azure",
"new_relic",
"splunk",
"chronosphere",
"app_optics",
"bug_snag",
"honeycomb",
"monte_carlo",
"nagios",
"prtg"
]
},
"status": {
"type": "string",
"description": "The current status of the alert source"
},
"secret": {
"type": "string",
"description": "A secret key used to authenticate incoming requests to this alerts source"
},
"webhook_endpoint": {
"type": "string",
"description": "The URL endpoint of the alert source",
"nullable": true
},
"email": {
"type": "string",
"description": "The email address of the alert source",
"nullable": true
},
"owner_group_ids": {
"type": "array",
"description": "List of team IDs that will own the alert source",
"items": {
"type": "string"
}
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
},
"sourceable_attributes": {
"type": "object",
"description": "Additional attributes specific to certain alert sources (e.g., generic_webhook), encapsulating source-specific configurations or details",
"nullable": true
},
"resolution_rule_attributes": {
"type": "object",
"description": "Additional attributes for email or generic webhook alerts source",
"nullable": true
},
"alert_source_fields_attributes": {
"type": "array",
"description": "List of alert fields to be added to alert source",
"nullable": true,
"items": {
"type": "object",
"properties": {
"alert_field_id": {
"type": "string",
"description": "The ID of the alert field"
},
"template_body": {
"type": "string",
"description": "Liquid expression to extract a specific value from the alert's payload for evaluation",
"nullable": true
}
}
}
}
},
"required": [
"name",
"status",
"secret",
"created_at",
"updated_at"
]
},
"alerts_source_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert source"
},
"type": {
"type": "string",
"enum": [
"alert_sources"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alerts_source"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"alerts_source_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert source"
},
"type": {
"type": "string",
"enum": [
"alert_sources"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alerts_source"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_alert_routing_rule": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_routing_rules"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert routing rule"
},
"enabled": {
"type": "boolean",
"description": "Whether the alert routing rule is enabled"
},
"owning_team_ids": {
"type": "array",
"description": "The IDs of the teams which own the alert routing rule. If the user doesn't have Alert Routing Create Permission in On-Call Roles, then this field is required and can contain Team IDs the user is an admin of.",
"items": {
"type": "string",
"format": "uuid"
}
},
"alerts_source_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the alerts source"
},
"position": {
"type": "integer",
"description": "The position of the alert routing rule for ordering evaluation"
},
"condition_type": {
"type": "string",
"description": "The type of condition for the alert routing rule",
"enum": [
"all",
"any"
]
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"property_field_type": {
"type": "string",
"description": "The type of the property field",
"enum": [
"attribute",
"payload"
]
},
"property_field_name": {
"type": "string",
"description": "The name of the property field. If the property field type is selected as 'attribute', then the allowed property field names are 'summary' (for Title), 'description', 'alert_urgency' and 'external_url' (for Alert Source URL). If the property field type is selected as 'payload', then the property field name should be supplied in JSON Path syntax."
},
"property_field_condition_type": {
"type": "string",
"description": "The condition type of the property field",
"enum": [
"is_one_of",
"is_not_one_of",
"contains",
"does_not_contain",
"starts_with",
"ends_with",
"matches_regex",
"is_empty"
]
},
"property_field_value": {
"type": "string",
"description": "The value of the property field. Can be null if the property field condition type is 'is_one_of' or 'is_not_one_of'"
},
"property_field_values": {
"type": "array",
"description": "The values of the property field. Need to be passed if the property field condition type is 'is_one_of' or 'is_not_one_of' except for when property field name is 'alert_urgency'",
"items": {
"type": "string"
}
}
},
"required": [
"property_field_type",
"property_field_name",
"property_field_condition_type"
]
}
},
"destination": {
"type": "object",
"properties": {
"target_type": {
"type": "string",
"description": "The type of the target",
"enum": [
"Service",
"Group",
"EscalationPolicy"
]
},
"target_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the target"
}
},
"required": [
"target_type",
"target_id"
]
}
},
"additionalProperties": false,
"required": [
"name",
"alerts_source_id",
"destination"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_alert_routing_rule": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_routing_rules"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert routing rule"
},
"enabled": {
"type": "boolean",
"description": "Whether the alert routing rule is enabled"
},
"alerts_source_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the alerts source"
},
"position": {
"type": "integer",
"description": "The position of the alert routing rule for ordering evaluation"
},
"owning_team_ids": {
"type": "array",
"description": "The IDs of the teams that own the alert routing rule",
"items": {
"type": "string",
"format": "uuid"
}
},
"condition_type": {
"type": "string",
"description": "The type of condition for the alert routing rule",
"enum": [
"all",
"any"
]
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The ID of the alert routing rule condition"
},
"property_field_type": {
"type": "string",
"description": "The type of the property field",
"enum": [
"attribute",
"payload"
]
},
"property_field_name": {
"type": "string",
"description": "The name of the property field. If the property field type is selected as 'attribute', then the allowed property field names are 'summary' (for Title), 'description', 'alert_urgency' and 'external_url' (for Alert Source URL). If the property field type is selected as 'payload', then the property field name should be supplied in JSON Path syntax."
},
"property_field_condition_type": {
"type": "string",
"description": "The condition type of the property field",
"enum": [
"is_one_of",
"is_not_one_of",
"contains",
"does_not_contain",
"starts_with",
"ends_with",
"matches_regex",
"is_empty"
]
},
"property_field_value": {
"type": "string",
"description": "The value of the property field. Can be null if the property field condition type is 'is_one_of' or 'is_not_one_of'",
"nullable": true
},
"property_field_values": {
"type": "array",
"description": "The values of the property field. Used if the property field condition type is 'is_one_of' or 'is_not_one_of' except for when property field name is 'alert_urgency'",
"items": {
"type": "string"
}
}
}
}
},
"destination": {
"type": "object",
"properties": {
"target_type": {
"type": "string",
"description": "The type of the target",
"enum": [
"Service",
"Group",
"EscalationPolicy"
]
},
"target_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the target"
}
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"alert_routing_rule": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert routing rule"
},
"enabled": {
"type": "boolean",
"description": "Whether the alert routing rule is enabled"
},
"alerts_source_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the alerts source"
},
"position": {
"type": "integer",
"description": "The position of the alert routing rule for ordering evaluation"
},
"condition_type": {
"type": "string",
"description": "The type of condition for the alert routing rule",
"enum": [
"all",
"any"
]
},
"conditions": {
"type": "array",
"description": "The conditions for the alert routing rule",
"items": {
"type": "object",
"properties": {
"property_field_type": {
"type": "string",
"description": "The type of the property field",
"enum": [
"attribute",
"payload"
]
},
"property_field_name": {
"type": "string",
"description": "The name of the property field. If the property field type is selected as 'attribute', then the allowed property field names are 'summary' (for Title), 'description', 'alert_urgency' and 'external_url' (for Alert Source URL). If the property field type is selected as 'payload', then the property field name should be supplied in JSON Path syntax."
},
"property_field_condition_type": {
"type": "string",
"description": "The condition type of the property field",
"enum": [
"is_one_of",
"is_not_one_of",
"contains",
"does_not_contain",
"starts_with",
"ends_with",
"matches_regex",
"is_empty"
]
},
"property_field_value": {
"type": "string",
"description": "The value of the property field. Can be null if the property field condition type is 'is_one_of' or 'is_not_one_of'",
"nullable": true
},
"property_field_values": {
"type": "array",
"description": "The values of the property field. Used if the property field condition type is 'is_one_of' or 'is_not_one_of' except for when property field name is 'alert_urgency'",
"items": {
"type": "string"
}
}
},
"required": [
"property_field_type",
"property_field_name",
"property_field_condition_type"
]
}
},
"destination": {
"type": "object",
"description": "The destinations for the alert routing rule",
"nullable": true,
"properties": {
"target_type": {
"type": "string",
"description": "The type of the target",
"enum": [
"Service",
"Group",
"EscalationPolicy"
]
},
"target_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the target"
}
},
"required": [
"target_type",
"target_id"
]
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"enabled",
"alerts_source_id",
"position",
"condition_type",
"created_at",
"updated_at"
]
},
"alert_routing_rule_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert_routing_rule"
},
"type": {
"type": "string",
"enum": [
"alert_routing_rules"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_routing_rule"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"alert_routing_rule_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert_routing_rule"
},
"type": {
"type": "string",
"enum": [
"alert_routing_rules"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_routing_rule"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_alert_field": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_fields"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert field"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_alert_field": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_fields"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert field"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"alert_field": {
"type": "object",
"properties": {
"slug": {
"type": "string",
"description": "The slug of the alert field"
},
"name": {
"type": "string",
"description": "The name of the alert field"
},
"kind": {
"type": "string",
"description": "The kind of alert field"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"slug",
"name",
"kind",
"created_at",
"updated_at"
]
},
"alert_field_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the alert field"
},
"type": {
"type": "string",
"enum": [
"alert_fields"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_field"
}
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"alert_field_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the alert field"
},
"type": {
"type": "string",
"enum": [
"alert_fields"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_field"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_alert_urgency": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_urgencies"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert urgency"
},
"description": {
"type": "string",
"description": "The description of the alert urgency"
},
"position": {
"type": "integer",
"description": "Position of the alert urgency",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name",
"description"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_alert_urgency": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_urgencies"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert urgency"
},
"description": {
"type": "string",
"description": "The description of the alert urgency"
},
"position": {
"type": "integer",
"description": "Position of the alert urgency",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"alert_urgency": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert urgency"
},
"description": {
"type": "string",
"description": "The description of the alert urgency"
},
"position": {
"type": "integer",
"description": "Position of the alert urgency"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"description",
"position",
"created_at",
"updated_at"
]
},
"alert_urgency_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert urgency"
},
"type": {
"type": "string",
"enum": [
"alert_urgencies"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_urgency"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"alert_urgency_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert urgency"
},
"type": {
"type": "string",
"enum": [
"alert_urgencies"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_urgency"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_alert_group": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_groups"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert group"
},
"description": {
"type": "string",
"description": "The description of the alert urgency",
"nullable": true
},
"time_window": {
"type": "integer",
"description": "The length of time an Alert Group should stay open and accept new alerts"
},
"targets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"target_type": {
"type": "string",
"description": "The type of the target.",
"enum": [
"Group",
"Service",
"EscalationPolicy"
]
},
"target_id": {
"type": "string",
"format": "uuid",
"description": "id for the Group, Service or EscalationPolicy"
}
},
"required": [
"target_type",
"target_id"
]
}
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"json_path": {
"type": "string",
"description": "The JSON path to the value to group by."
}
}
}
},
"group_by_alert_title": {
"type": "integer",
"enum": [
1,
0
],
"description": "Whether the alerts should be grouped by titles."
},
"group_by_alert_urgency": {
"type": "integer",
"enum": [
1,
0
],
"description": "Whether the alerts should be grouped by urgencies."
},
"condition_type": {
"type": "string",
"enum": [
"all",
"any"
],
"description": "Group alerts when ANY or ALL of the fields are matching."
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"property_field_type": {
"type": "string",
"description": "The type of the property field",
"enum": [
"attribute",
"payload",
"alert_field"
]
},
"property_field_name": {
"type": "string",
"description": "The name of the property field. If the property field type is selected as 'attribute', then the allowed property field names are 'summary' (for Title), 'description', 'alert_urgency' and 'external_url' (for Alert Source URL). If the property field type is selected as 'payload', then the property field name should be supplied in JSON Path syntax."
},
"property_field_condition_type": {
"type": "string",
"description": "The condition type of the property field",
"enum": [
"is_one_of",
"is_not_one_of",
"contains",
"does_not_contain",
"starts_with",
"ends_with",
"matches_regex",
"is_empty",
"matches_existing_alert"
]
},
"property_field_value": {
"type": "string",
"description": "The value of the property field. Can be null if the property field condition type is 'is_one_of' or 'is_not_one_of'"
},
"property_field_values": {
"type": "array",
"description": "The values of the property field. Need to be passed if the property field condition type is 'is_one_of' or 'is_not_one_of' except for when property field name is 'alert_urgency'",
"items": {
"type": "string"
}
},
"alert_urgency_ids": {
"type": "array",
"description": "The Alert Urgency ID's to check in the condition. Only need to be set when the property field type is 'attribute', the property field name is 'alert_urgency' and the property field condition type is 'is_one_of' or 'is_not_one_of'",
"items": {
"type": "string"
},
"nullable": true
},
"conditionable_type": {
"type": "string",
"description": "The type of the conditionable",
"enum": [
"AlertField"
]
},
"conditionable_id": {
"type": "string",
"description": "The ID of the conditionable. If conditionable_type is AlertField, this is the ID of the alert field."
}
},
"required": [
"property_field_type",
"property_field_condition_type"
]
}
}
},
"additionalProperties": false,
"required": [
"name",
"targets"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_alert_group": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_groups"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert group"
},
"description": {
"type": "string",
"description": "The description of the alert group",
"nullable": true
},
"time_window": {
"type": "integer",
"description": "The length of time an Alert Group should stay open and accept new alerts"
},
"targets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"target_type": {
"type": "string",
"description": "The type of the target.",
"enum": [
"Group",
"Service",
"EscalationPolicy"
]
},
"target_id": {
"type": "string",
"format": "uuid",
"description": "id for the Group, Service or EscalationPolicy"
}
},
"required": [
"target_type",
"target_id"
]
}
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"json_path": {
"type": "string",
"description": "The JSON path to the value to group by."
}
}
}
},
"group_by_alert_title": {
"type": "integer",
"enum": [
1,
0
],
"description": "Whether the alerts should be grouped by titles."
},
"group_by_alert_urgency": {
"type": "integer",
"enum": [
1,
0
],
"description": "Whether the alerts should be grouped by urgencies."
},
"condition_type": {
"type": "string",
"enum": [
"all",
"any"
],
"description": "Group alerts when ANY or ALL of the fields are matching."
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The ID of the alert group condition"
},
"property_field_type": {
"type": "string",
"description": "The type of the property field",
"enum": [
"attribute",
"payload",
"alert_field"
]
},
"property_field_name": {
"type": "string",
"description": "The name of the property field. If the property field type is selected as 'attribute', then the allowed property field names are 'summary' (for Title), 'description', 'alert_urgency' and 'external_url' (for Alert Source URL). If the property field type is selected as 'payload', then the property field name should be supplied in JSON Path syntax."
},
"property_field_condition_type": {
"type": "string",
"description": "The condition type of the property field",
"enum": [
"is_one_of",
"is_not_one_of",
"contains",
"does_not_contain",
"starts_with",
"ends_with",
"matches_regex",
"is_empty",
"matches_existing_alert"
]
},
"property_field_value": {
"type": "string",
"description": "The value of the property field. Can be null if the property field condition type is 'is_one_of' or 'is_not_one_of'"
},
"property_field_values": {
"type": "array",
"description": "The values of the property field. Need to be passed if the property field condition type is 'is_one_of' or 'is_not_one_of' except for when property field name is 'alert_urgency'",
"items": {
"type": "string"
}
},
"alert_urgency_ids": {
"type": "array",
"description": "The Alert Urgency ID's to check in the condition. Only need to be set when the property field type is 'attribute', the property field name is 'alert_urgency' and the property field condition type is 'is_one_of' or 'is_not_one_of'",
"items": {
"type": "string"
},
"nullable": true
},
"conditionable_type": {
"type": "string",
"description": "The type of the conditionable",
"enum": [
"AlertField"
]
},
"conditionable_id": {
"type": "string",
"description": "The ID of the conditionable. If conditionable_type is AlertField, this is the ID of the alert field."
}
},
"required": [
"property_field_type",
"property_field_condition_type"
]
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"alert_group": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert group"
},
"description": {
"type": "string",
"description": "The description of the alert group",
"nullable": true
},
"slug": {
"type": "string",
"description": "The slug of the alert group"
},
"condition_type": {
"type": "string",
"description": "Grouping condition for the alert group"
},
"time_window": {
"type": "integer",
"description": "Time window for the alert grouping"
},
"group_by_alert_title": {
"type": "boolean",
"description": "Whether the alerts are grouped by title or not"
},
"group_by_alert_urgency": {
"type": "boolean",
"description": "Whether the alerts are grouped by urgency or not"
},
"targets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"target_type": {
"type": "string",
"description": "The type of the target.",
"enum": [
"Group",
"Service",
"EscalationPolicy"
]
},
"target_id": {
"type": "string",
"format": "uuid",
"description": "id for the Group, Service or EscalationPolicy"
}
},
"required": [
"target_type",
"target_id"
]
}
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"json_path": {
"type": "string",
"description": "The JSON path to the value to group by."
}
}
}
},
"conditions": {
"type": "array",
"description": "The conditions for the alert group",
"items": {
"type": "object",
"properties": {
"property_field_type": {
"type": "string",
"description": "The type of the property field",
"enum": [
"attribute",
"payload",
"alert_field"
]
},
"property_field_name": {
"type": "string",
"nullable": true,
"description": "The name of the property field. If the property field type is selected as 'attribute', then the allowed property field names are 'summary' (for Title), 'description', 'alert_urgency' and 'external_url' (for Alert Source URL). If the property field type is selected as 'payload', then the property field name should be supplied in JSON Path syntax."
},
"property_field_condition_type": {
"type": "string",
"description": "The condition type of the property field",
"enum": [
"is_one_of",
"is_not_one_of",
"contains",
"does_not_contain",
"starts_with",
"ends_with",
"matches_regex",
"is_empty",
"matches_existing_alert"
]
},
"property_field_value": {
"type": "string",
"description": "The value of the property field. Can be null if the property field condition type is 'is_one_of' or 'is_not_one_of'",
"nullable": true
},
"property_field_values": {
"type": "array",
"description": "The values of the property field. Used if the property field condition type is 'is_one_of' or 'is_not_one_of' except for when property field name is 'alert_urgency'",
"items": {
"type": "string"
}
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"record_id": {
"type": "string",
"description": "ID of the Alert Urgency to set."
},
"record_type": {
"type": "string",
"description": "Should be \"AlertUrgency\"."
}
},
"required": [
"record_id",
"record_type"
],
"nullable": true
}
}
},
"required": [
"property_field_type",
"property_field_condition_type"
]
}
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
},
"deleted_at": {
"type": "string",
"nullable": true,
"description": "Date or deletion"
}
},
"required": [
"name",
"description",
"slug",
"created_at",
"updated_at",
"deleted_at",
"condition_type",
"time_window"
]
},
"alert_group_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert group"
},
"type": {
"type": "string",
"enum": [
"alert_groups"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_group"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"alert_group_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert group"
},
"type": {
"type": "string",
"enum": [
"alert_groups"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_group"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
}
},
"required": [
"data"
]
},
"audit": {
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "Describes the action that was taken."
},
"item_type": {
"type": "string",
"description": "Describes the object in which the action was taken on",
"enum": [
"ApiKey",
"Cause",
"CustomField",
"CustomFieldOption",
"CustomForm",
"Dashboard",
"Environment",
"EscalationPolicy",
"EscalationPolicyPath",
"ExportJob",
"FormField",
"Functionality",
"GeniusWorkflow",
"GeniusWorkflowGroup",
"GeniusWorkflowRun",
"Group",
"Heartbeat",
"Incident",
"IncidentActionItem",
"IncidentEvent",
"IncidentFormFieldSelection",
"IncidentFormFieldSelectionUser",
"IncidentPostMortem",
"IncidentRoleAssignment",
"IncidentRoleTask",
"IncidentStatusPageEvent",
"IncidentTask",
"IncidentType",
"LiveCallRouter",
"OnCallRole",
"Playbook",
"PlaybookTask",
"Role",
"Schedule",
"Service",
"Severity",
"StatusPage"
],
"nullable": true
},
"object": {
"type": "object",
"description": "The object in which the action was taken on",
"nullable": true
},
"object_changes": {
"type": "object",
"description": "The changes that occurred on the object",
"nullable": true
},
"user_id": {
"type": "integer",
"description": "The ID of who took action on the object. Together with whodunnit_type can be used to find the user",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"item_id": {
"type": "string",
"description": "ID of the affected object",
"nullable": true
},
"id": {
"type": "integer",
"description": "ID of audit",
"nullable": true
}
},
"required": [
"event",
"created_at"
]
},
"audits_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the audit log item"
},
"type": {
"type": "string",
"enum": [
"audits"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/audit"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_authorization": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"authorizations"
]
},
"attributes": {
"type": "object",
"properties": {
"authorizable_id": {
"type": "string",
"description": "The id of the resource being accessed."
},
"authorizable_type": {
"type": "string",
"description": "The type of resource being accessed.",
"enum": [
"Dashboard"
]
},
"grantee_id": {
"type": "string",
"description": "The resource id granted access."
},
"grantee_type": {
"type": "string",
"description": "The type of resource granted access.",
"enum": [
"User",
"Team"
]
},
"permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"read",
"update",
"authorize",
"destroy"
]
}
}
},
"additionalProperties": false,
"required": [
"authorizable_id",
"authorizable_type",
"grantee_id",
"grantee_type",
"permissions"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_authorization": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"authorizations"
]
},
"attributes": {
"type": "object",
"properties": {
"permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"read",
"update",
"authorize",
"destroy"
]
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"authorization": {
"type": "object",
"properties": {
"authorizable_id": {
"type": "string",
"description": "The id of the resource being accessed."
},
"authorizable_type": {
"type": "string",
"description": "The type of resource being accessed.",
"enum": [
"Dashboard"
]
},
"grantee_id": {
"type": "string",
"description": "The resource id granted access."
},
"grantee_type": {
"type": "string",
"description": "The type of resource granted access.",
"enum": [
"User",
"Team"
]
},
"permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"read",
"update",
"authorize",
"destroy"
]
}
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"authorizable_id",
"authorizable_type",
"grantee_id",
"grantee_type",
"permissions",
"created_at",
"updated_at"
]
},
"authorization_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the authorization"
},
"type": {
"type": "string",
"enum": [
"authorizations"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/authorization"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"authorization_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the authorization"
},
"type": {
"type": "string",
"enum": [
"authorizations"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/authorization"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_catalog": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"catalogs"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"icon": {
"type": "string",
"enum": [
"globe-alt",
"server-stack",
"users",
"user-group",
"chart-bar",
"shapes",
"light-bulb",
"cursor-arrow-ripple"
]
},
"position": {
"type": "integer",
"description": "Default position of the catalog when displayed in a list.",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_catalog": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"catalogs"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"icon": {
"type": "string",
"enum": [
"globe-alt",
"server-stack",
"users",
"user-group",
"chart-bar",
"shapes",
"light-bulb",
"cursor-arrow-ripple"
]
},
"position": {
"type": "integer",
"description": "Default position of the catalog when displayed in a list.",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"catalog": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"icon": {
"type": "string",
"enum": [
"globe-alt",
"server-stack",
"users",
"user-group",
"chart-bar",
"shapes",
"light-bulb",
"cursor-arrow-ripple"
]
},
"position": {
"type": "integer",
"description": "Default position of the catalog when displayed in a list.",
"nullable": true
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"name",
"icon",
"position",
"created_at",
"updated_at"
]
},
"catalog_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the catalog"
},
"type": {
"type": "string",
"enum": [
"catalogs"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/catalog"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"catalog_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the catalog"
},
"type": {
"type": "string",
"enum": [
"catalogs"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/catalog"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_catalog_field": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"catalog_fields"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"text",
"reference"
]
},
"kind_catalog_id": {
"type": "string",
"description": "Restricts values to items of specified catalog.",
"nullable": true
},
"multiple": {
"type": "boolean",
"description": "Whether the attribute accepts multiple values."
},
"position": {
"type": "integer",
"description": "Default position of the item when displayed in a list.",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name",
"kind"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_catalog_field": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"catalog_fields"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"text",
"reference"
]
},
"kind_catalog_id": {
"type": "string",
"description": "Restricts values to items of specified catalog.",
"nullable": true
},
"position": {
"type": "integer",
"description": "Default position of the item when displayed in a list.",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"catalog_field": {
"type": "object",
"properties": {
"catalog_id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"text",
"reference"
]
},
"kind_catalog_id": {
"type": "string",
"description": "Restricts values to items of specified catalog.",
"nullable": true
},
"multiple": {
"type": "boolean",
"description": "Whether the attribute accepts multiple values."
},
"position": {
"type": "integer",
"description": "Default position of the item when displayed in a list.",
"nullable": true
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"catalog_id",
"name",
"slug",
"kind",
"multiple",
"position",
"created_at",
"updated_at"
]
},
"catalog_field_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the catalog_field"
},
"type": {
"type": "string",
"enum": [
"catalog_fields"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/catalog_field"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"catalog_field_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the catalog_field"
},
"type": {
"type": "string",
"enum": [
"catalog_fields"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/catalog_field"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_catalog_entity": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"catalog_entities"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"position": {
"type": "integer",
"description": "Default position of the item when displayed in a list.",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_catalog_entity": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"catalog_entities"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"position": {
"type": "integer",
"description": "Default position of the item when displayed in a list.",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"catalog_entity": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"position": {
"type": "integer",
"description": "Default position of the item when displayed in a list.",
"nullable": true
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"name",
"position",
"created_at",
"updated_at"
]
},
"catalog_entity_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the catalog_entity"
},
"type": {
"type": "string",
"enum": [
"catalog_entities"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/catalog_entity"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"catalog_entity_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the catalog_entity"
},
"type": {
"type": "string",
"enum": [
"catalog_entities"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/catalog_entity"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_catalog_entity_property": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"catalog_entity_properties"
]
},
"attributes": {
"type": "object",
"properties": {
"catalog_entity_id": {
"type": "string"
},
"catalog_field_id": {
"type": "string"
},
"key": {
"type": "string",
"enum": [
"text",
"catalog_entity"
]
},
"value": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"catalog_field_id",
"key",
"value"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_catalog_entity_property": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"catalog_entity_properties"
]
},
"attributes": {
"type": "object",
"properties": {
"key": {
"type": "string",
"enum": [
"text",
"catalog_entity"
]
},
"value": {
"type": "string"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"catalog_entity_property": {
"type": "object",
"properties": {
"catalog_entity_id": {
"type": "string"
},
"catalog_field_id": {
"type": "string"
},
"key": {
"type": "string",
"enum": [
"text",
"catalog_entity"
]
},
"value": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"catalog_entity_id",
"catalog_field_id",
"key",
"value",
"created_at",
"updated_at"
]
},
"catalog_entity_property_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the catalog_entity_property"
},
"type": {
"type": "string",
"enum": [
"catalog_entity_properties"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/catalog_entity_property"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"catalog_entity_property_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the catalog_entity_property"
},
"type": {
"type": "string",
"enum": [
"catalog_entity_properties"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/catalog_entity_property"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_cause": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"causes"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the cause"
},
"description": {
"type": "string",
"description": "The description of the cause",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the cause",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_cause": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"causes"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the cause"
},
"description": {
"type": "string",
"description": "The description of the cause",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the cause",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"cause": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the cause"
},
"slug": {
"type": "string",
"description": "The slug of the cause"
},
"description": {
"type": "string",
"description": "The description of the cause",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the cause",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"cause_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the cause"
},
"type": {
"type": "string",
"enum": [
"causes"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/cause"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"cause_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the cause"
},
"type": {
"type": "string",
"enum": [
"causes"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/cause"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_communications_stage": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"communications_stages"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications stage"
},
"description": {
"type": "string",
"description": "The description of the communications stage",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the communications stage",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_communications_stage": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"communications_stages"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications stage"
},
"description": {
"type": "string",
"description": "The description of the communications stage",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the communications stage",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"communications_stage": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications stage"
},
"slug": {
"type": "string",
"description": "The slug of the communications stage"
},
"description": {
"type": "string",
"description": "The description of the communications stage",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the communications stage",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"slug",
"position",
"created_at",
"updated_at"
]
},
"communications_stage_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the communications stage"
},
"type": {
"type": "string",
"enum": [
"communications_stages"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/communications_stage"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"communications_stages_response": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the communications stage"
},
"type": {
"type": "string",
"enum": [
"communications_stages"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/communications_stage"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data"
]
},
"new_communications_type": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"communications_types"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications type"
},
"description": {
"type": "string",
"description": "The description of the communications type",
"nullable": true
},
"color": {
"type": "string",
"description": "The color of the communications type",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the communications type",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name",
"color"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_communications_type": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"communications_types"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications type"
},
"description": {
"type": "string",
"description": "The description of the communications type",
"nullable": true
},
"color": {
"type": "string",
"description": "The color of the communications type",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the communications type",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"communications_type": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications type"
},
"slug": {
"type": "string",
"description": "The slug of the communications type"
},
"description": {
"type": "string",
"description": "The description of the communications type",
"nullable": true
},
"color": {
"type": "string",
"description": "The color of the communications type",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the communications type"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"slug",
"color",
"position",
"created_at",
"updated_at"
]
},
"communications_type_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the communications type"
},
"type": {
"type": "string",
"enum": [
"communications_types"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/communications_type"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"communications_types_response": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the communications type"
},
"type": {
"type": "string",
"enum": [
"communications_types"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/communications_type"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data"
]
},
"new_communications_template": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"communications-templates"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications template"
},
"description": {
"type": "string",
"description": "The description of the communications template",
"nullable": true
},
"communication_type_id": {
"type": "string",
"description": "The communication type ID"
},
"position": {
"type": "integer",
"description": "Position of the communications template",
"nullable": true
},
"communication_template_stages_attributes": {
"type": "array",
"description": "Template stages attributes",
"nullable": true,
"items": {
"type": "object",
"properties": {
"communication_stage_id": {
"type": "string",
"description": "The communication stage ID"
},
"sms_content": {
"type": "string",
"description": "SMS content for the stage",
"nullable": true
},
"email_subject": {
"type": "string",
"description": "Email subject for the stage",
"nullable": true
},
"email_body": {
"type": "string",
"description": "Email body for the stage",
"nullable": true
},
"slack_content": {
"type": "string",
"description": "Slack content for the stage",
"nullable": true
}
}
}
}
},
"additionalProperties": false,
"required": [
"name",
"communication_type_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_communications_template": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"communications-templates"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications template"
},
"description": {
"type": "string",
"description": "The description of the communications template",
"nullable": true
},
"communication_type_id": {
"type": "string",
"description": "The communication type ID"
},
"position": {
"type": "integer",
"description": "Position of the communications template",
"nullable": true
},
"communication_template_stages_attributes": {
"type": "array",
"description": "Template stages attributes",
"nullable": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the communication template stage",
"nullable": true
},
"sms_content": {
"type": "string",
"description": "SMS content for the stage",
"nullable": true
},
"email_subject": {
"type": "string",
"description": "Email subject for the stage",
"nullable": true
},
"email_body": {
"type": "string",
"description": "Email body for the stage",
"nullable": true
},
"slack_content": {
"type": "string",
"description": "Slack content for the stage",
"nullable": true
}
}
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"communications_template": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications template"
},
"slug": {
"type": "string",
"description": "The slug of the communications template"
},
"description": {
"type": "string",
"description": "The description of the communications template",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the communications template",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
},
"communication_type_id": {
"type": "string",
"description": "The communication type ID"
},
"communication_template_stages": {
"type": "array",
"description": "Communication template stages",
"nullable": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the communication template stage"
},
"communication_stage_id": {
"type": "string",
"description": "The communication stage ID"
},
"sms_content": {
"type": "string",
"description": "SMS content for the stage",
"nullable": true
},
"email_subject": {
"type": "string",
"description": "Email subject for the stage",
"nullable": true
},
"email_body": {
"type": "string",
"description": "Email body for the stage",
"nullable": true
},
"slack_content": {
"type": "string",
"description": "Slack content for the stage",
"nullable": true
}
}
}
},
"communication_type": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the communication type"
},
"name": {
"type": "string",
"description": "Name of the communication type"
}
}
}
},
"required": [
"name",
"slug",
"position",
"created_at",
"updated_at"
]
},
"communications_template_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the communications template"
},
"type": {
"type": "string",
"enum": [
"communications-templates"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/communications_template"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"communications_templates_response": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the communications template"
},
"type": {
"type": "string",
"enum": [
"communications-templates"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/communications_template"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data"
]
},
"new_communications_group": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"communications-groups"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications group"
},
"description": {
"type": "string",
"description": "The description of the communications group",
"nullable": true
},
"communication_type_id": {
"type": "string",
"description": "The communication type ID"
},
"is_private": {
"type": "boolean",
"description": "Whether the group is private",
"nullable": true
},
"condition_type": {
"type": "string",
"description": "Condition type",
"enum": [
"any",
"all"
],
"nullable": true
},
"sms_channel": {
"type": "boolean",
"description": "SMS channel enabled",
"nullable": true
},
"email_channel": {
"type": "boolean",
"description": "Email channel enabled",
"nullable": true
},
"slack_channel_ids": {
"type": "array",
"description": "Array of Slack channel IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"communication_group_conditions_attributes": {
"type": "array",
"description": "Group conditions attributes",
"nullable": true,
"items": {
"type": "object",
"properties": {
"property_type": {
"type": "string",
"description": "Property type",
"enum": [
"service",
"severity",
"functionality",
"group",
"incident_type"
]
},
"service_ids": {
"type": "array",
"description": "Array of service IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"severity_ids": {
"type": "array",
"description": "Array of severity IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"functionality_ids": {
"type": "array",
"description": "Array of functionality IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"group_ids": {
"type": "array",
"description": "Array of group IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"incident_type_ids": {
"type": "array",
"description": "Array of incident type IDs",
"nullable": true,
"items": {
"type": "string"
}
}
}
}
},
"communication_group_members_attributes": {
"type": "array",
"description": "Group members attributes",
"nullable": true,
"items": {
"type": "object",
"properties": {
"user_id": {
"type": "integer",
"description": "User ID"
}
}
}
},
"communication_external_group_members_attributes": {
"type": "array",
"description": "External group members attributes",
"nullable": true,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the external member"
},
"email": {
"type": "string",
"description": "Email of the external member"
},
"phone_number": {
"type": "string",
"description": "Phone number of the external member"
}
}
}
}
},
"additionalProperties": false,
"required": [
"name",
"communication_type_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_communications_group": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"communications-groups"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications group"
},
"description": {
"type": "string",
"description": "The description of the communications group",
"nullable": true
},
"communication_type_id": {
"type": "string",
"description": "The communication type ID"
},
"is_private": {
"type": "boolean",
"description": "Whether the group is private",
"nullable": true
},
"condition_type": {
"type": "string",
"description": "Condition type",
"enum": [
"any",
"all"
],
"nullable": true
},
"sms_channel": {
"type": "boolean",
"description": "SMS channel enabled",
"nullable": true
},
"email_channel": {
"type": "boolean",
"description": "Email channel enabled",
"nullable": true
},
"slack_channel_ids": {
"type": "array",
"description": "Array of Slack channel IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"communication_group_conditions_attributes": {
"type": "array",
"description": "Group conditions attributes",
"nullable": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the condition",
"nullable": true
},
"property_type": {
"type": "string",
"description": "Property type",
"enum": [
"service",
"severity",
"functionality",
"group",
"incident_type"
]
},
"service_ids": {
"type": "array",
"description": "Array of service IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"severity_ids": {
"type": "array",
"description": "Array of severity IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"functionality_ids": {
"type": "array",
"description": "Array of functionality IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"group_ids": {
"type": "array",
"description": "Array of group IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"incident_type_ids": {
"type": "array",
"description": "Array of incident type IDs",
"nullable": true,
"items": {
"type": "string"
}
}
}
}
},
"communication_group_members_attributes": {
"type": "array",
"description": "Group members attributes",
"nullable": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the group member",
"nullable": true
},
"user_id": {
"type": "integer",
"description": "User ID"
}
}
}
},
"communication_external_group_members_attributes": {
"type": "array",
"description": "External group members attributes",
"nullable": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the external group member",
"nullable": true
},
"name": {
"type": "string",
"description": "Name of the external member"
},
"email": {
"type": "string",
"description": "Email of the external member"
},
"phone_number": {
"type": "string",
"description": "Phone number of the external member"
}
}
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"communications_group": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications group"
},
"slug": {
"type": "string",
"description": "The slug of the communications group"
},
"description": {
"type": "string",
"description": "The description of the communications group",
"nullable": true
},
"communication_type_id": {
"type": "string",
"description": "The communication type ID"
},
"is_private": {
"type": "boolean",
"description": "Whether the group is private"
},
"condition_type": {
"type": "string",
"description": "Condition type",
"enum": [
"any",
"all"
]
},
"sms_channel": {
"type": "boolean",
"description": "SMS channel enabled"
},
"email_channel": {
"type": "boolean",
"description": "Email channel enabled"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
},
"communication_group_conditions": {
"type": "array",
"description": "Group conditions",
"nullable": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the condition"
},
"condition": {
"type": "string",
"description": "Condition"
},
"property_type": {
"type": "string",
"description": "Property type",
"enum": [
"service",
"severity",
"functionality",
"group",
"incident_type"
]
},
"properties": {
"type": "array",
"description": "Properties",
"nullable": true,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id": {
"type": "string"
}
}
}
}
}
}
},
"communication_group_members": {
"type": "array",
"description": "Group members",
"nullable": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the group member"
},
"user_id": {
"type": "integer",
"description": "User ID"
},
"name": {
"type": "string",
"description": "Name of the group member"
},
"email": {
"type": "string",
"description": "Email of the group member"
}
}
}
},
"communication_external_group_members": {
"type": "array",
"description": "External group members",
"nullable": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the external group member"
},
"name": {
"type": "string",
"description": "Name of the external member"
},
"email": {
"type": "string",
"description": "Email of the external member"
},
"phone_number": {
"type": "string",
"description": "Phone number of the external member"
}
}
}
}
},
"required": [
"name",
"slug",
"communication_type_id",
"is_private",
"condition_type",
"sms_channel",
"email_channel",
"created_at",
"updated_at"
]
},
"communications_group_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the communications group"
},
"type": {
"type": "string",
"enum": [
"communications-groups"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/communications_group"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"communications_groups_response": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the communications group"
},
"type": {
"type": "string",
"enum": [
"communications-groups"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/communications_group"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data"
]
},
"new_custom_field_option": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"custom_field_options"
]
},
"attributes": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The value of the custom_field_option"
},
"color": {
"type": "string",
"description": "The hex color of the custom_field_option"
},
"default": {
"type": "boolean"
},
"position": {
"type": "integer",
"description": "The position of the custom_field_option"
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_custom_field_option": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"custom_field_options"
]
},
"attributes": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The value of the custom_field_option"
},
"color": {
"type": "string",
"description": "The hex color of the custom_field_option"
},
"default": {
"type": "boolean"
},
"position": {
"type": "integer",
"description": "The position of the custom_field_option"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"custom_field_option": {
"type": "object",
"properties": {
"custom_field_id": {
"type": "integer",
"description": "The ID of the parent custom field"
},
"value": {
"type": "string",
"description": "The value of the custom_field_option"
},
"color": {
"type": "string",
"description": "The hex color of the custom_field_option"
},
"default": {
"type": "boolean"
},
"position": {
"type": "integer",
"description": "The position of the custom_field_option"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"value",
"color",
"position",
"created_at",
"updated_at"
]
},
"custom_field_option_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the custom_field_option"
},
"type": {
"type": "string",
"enum": [
"custom_field_options"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/custom_field_option"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"custom_field_option_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the custom_field_option"
},
"type": {
"type": "string",
"enum": [
"custom_field_options"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/custom_field_option"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_custom_field": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"custom_fields"
]
},
"attributes": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The name of the custom_field"
},
"description": {
"type": "string",
"description": "The description of the custom_field",
"nullable": true
},
"shown": {
"type": "array",
"items": {
"type": "string",
"description": "Where the custom_field is shown",
"enum": [
"incident_form",
"incident_mitigation_form",
"incident_resolution_form",
"incident_post_mortem_form",
"incident_slack_form",
"incident_mitigation_slack_form",
"incident_resolution_slack_form",
"incident_post_mortem"
]
}
},
"required": {
"type": "array",
"items": {
"type": "string",
"description": "Where the custom_field is required",
"enum": [
"incident_form",
"incident_mitigation_form",
"incident_resolution_form",
"incident_post_mortem_form",
"incident_slack_form",
"incident_mitigation_slack_form",
"incident_resolution_slack_form"
]
},
"nullable": true
},
"default": {
"type": "string",
"description": "The default value for text field kinds",
"nullable": true
},
"position": {
"type": "integer",
"description": "The position of the custom_field"
}
},
"additionalProperties": false,
"required": [
"label"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_custom_field": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"custom_fields"
]
},
"attributes": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The name of the custom_field"
},
"slug": {
"type": "string",
"description": "The slug of the custom_field"
},
"description": {
"type": "string",
"description": "The description of the custom_field",
"nullable": true
},
"shown": {
"type": "array",
"items": {
"type": "string",
"description": "Where the custom_field is shown",
"enum": [
"incident_form",
"incident_mitigation_form",
"incident_resolution_form",
"incident_post_mortem_form",
"incident_slack_form",
"incident_mitigation_slack_form",
"incident_resolution_slack_form",
"incident_post_mortem"
]
}
},
"required": {
"type": "array",
"items": {
"type": "string",
"description": "Where the custom_field is required",
"enum": [
"incident_form",
"incident_mitigation_form",
"incident_resolution_form",
"incident_post_mortem_form",
"incident_slack_form",
"incident_mitigation_slack_form",
"incident_resolution_slack_form"
]
},
"nullable": true
},
"default": {
"type": "string",
"description": "The default value for text field kinds",
"nullable": true
},
"position": {
"type": "integer",
"description": "The position of the custom_field"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"custom_field": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The name of the custom_field"
},
"kind": {
"type": "string",
"description": "The kind of the custom_field"
},
"enabled": {
"type": "boolean",
"description": "Whether the custom_field is enabled"
},
"slug": {
"type": "string",
"description": "The slug of the custom_field"
},
"description": {
"type": "string",
"description": "The description of the custom_field",
"nullable": true
},
"shown": {
"type": "array",
"items": {
"type": "string",
"description": "Where the custom_field is shown",
"enum": [
"incident_form",
"incident_mitigation_form",
"incident_resolution_form",
"incident_post_mortem_form",
"incident_slack_form",
"incident_mitigation_slack_form",
"incident_resolution_slack_form",
"incident_post_mortem"
]
}
},
"required": {
"type": "array",
"items": {
"type": "string",
"description": "Where the custom_field is required",
"enum": [
"incident_form",
"incident_mitigation_form",
"incident_resolution_form",
"incident_post_mortem_form",
"incident_slack_form",
"incident_mitigation_slack_form",
"incident_resolution_slack_form"
]
},
"nullable": true
},
"default": {
"type": "string",
"description": "The default value for text field kinds",
"nullable": true
},
"position": {
"type": "integer",
"description": "The position of the custom_field"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"label",
"slug",
"shown",
"required",
"position",
"created_at",
"updated_at"
]
},
"custom_field_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the custom_field"
},
"type": {
"type": "string",
"enum": [
"custom_fields"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/custom_field"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"custom_field_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the custom_field"
},
"type": {
"type": "string",
"enum": [
"custom_fields"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/custom_field"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_custom_form": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"custom_forms"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the custom form."
},
"slug": {
"type": "string",
"description": "The custom form slug. Add this to form_field.shown or form_field.required to associate form fields with custom forms."
},
"description": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"command": {
"type": "string",
"description": "The Slack command used to trigger this form."
}
},
"additionalProperties": false,
"required": [
"name",
"command"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_custom_form": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"custom_forms"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the custom form."
},
"slug": {
"type": "string",
"description": "The custom form slug. Add this to form_field.shown or form_field.required to associate form fields with custom forms."
},
"description": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"command": {
"type": "string",
"description": "The Slack command used to trigger this form."
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"custom_form": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the custom form."
},
"slug": {
"type": "string",
"description": "The custom form slug. Add this to form_field.shown or form_field.required to associate form fields with custom forms."
},
"description": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"command": {
"type": "string",
"description": "The Slack command used to trigger this form."
},
"created_at": {
"type": "string",
"description": "Date of creation."
},
"updated_at": {
"type": "string",
"description": "Date of last update."
}
},
"required": [
"name",
"slug",
"command",
"enabled",
"created_at",
"updated_at"
]
},
"custom_form_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique id of the custom form."
},
"type": {
"type": "string",
"enum": [
"custom_forms"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/custom_form"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"custom_form_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique id of the custom form."
},
"type": {
"type": "string",
"enum": [
"custom_forms"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/custom_form"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_dashboard_panel": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"dashboard_panels"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the dashboard_panel",
"nullable": true
},
"params": {
"type": "object",
"properties": {
"display": {
"type": "string",
"enum": [
"line_chart",
"line_stepped_chart",
"column_chart",
"stacked_column_chart",
"monitoring_chart",
"pie_chart",
"table",
"aggregate_value"
]
},
"description": {
"type": "string"
},
"table_fields": {
"type": "array",
"items": {
"type": "string"
}
},
"legend": {
"type": "object",
"properties": {
"groups": {
"type": "string",
"enum": [
"all",
"charted"
],
"default": "all"
}
}
},
"datalabels": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
}
},
"datasets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"collection": {
"type": "string",
"enum": [
"alerts",
"incidents",
"incident_post_mortems",
"incident_action_items",
"users"
]
},
"filter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"and",
"or"
]
},
"condition": {
"type": "string",
"enum": [
"=",
"!=",
">=",
"<=",
"exists",
"not_exists",
"contains",
"not_contains"
]
},
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
}
},
"group_by": {
"type": "string",
"nullable": true
},
"aggregate": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"count",
"sum",
"average"
]
},
"key": {
"type": "string",
"nullable": true
},
"cumulative": {
"type": "boolean",
"nullable": true
}
},
"nullable": true
}
}
}
}
}
},
"position": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"w": {
"type": "number"
},
"h": {
"type": "number"
}
},
"required": [
"x",
"y",
"w",
"h"
],
"nullable": true
}
},
"additionalProperties": false,
"required": [
"params"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_dashboard_panel": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"dashboard_panels"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the dashboard_panel",
"nullable": true
},
"params": {
"type": "object",
"properties": {
"display": {
"type": "string",
"enum": [
"line_chart",
"line_stepped_chart",
"column_chart",
"stacked_column_chart",
"monitoring_chart",
"pie_chart",
"table",
"aggregate_value"
]
},
"description": {
"type": "string"
},
"table_fields": {
"type": "array",
"items": {
"type": "string"
}
},
"legend": {
"type": "object",
"properties": {
"groups": {
"type": "string",
"enum": [
"all",
"charted"
],
"default": "all"
}
}
},
"datalabels": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
}
},
"datasets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"collection": {
"type": "string",
"enum": [
"alerts",
"incidents",
"incident_post_mortems",
"incident_action_items",
"users"
]
},
"filter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"and",
"or"
]
},
"condition": {
"type": "string",
"enum": [
"=",
"!=",
">=",
"<=",
"exists",
"not_exists",
"contains",
"not_contains"
]
},
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
}
},
"group_by": {
"type": "string",
"nullable": true
},
"aggregate": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"count",
"sum",
"average"
]
},
"key": {
"type": "string",
"nullable": true
},
"cumulative": {
"type": "boolean",
"nullable": true
}
},
"nullable": true
}
}
}
}
}
},
"position": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"w": {
"type": "number"
},
"h": {
"type": "number"
}
},
"required": [
"x",
"y",
"w",
"h"
],
"nullable": true
}
},
"additionalProperties": false
}
}
}
},
"required": [
"data"
]
},
"dashboard_panel": {
"type": "object",
"properties": {
"dashboard_id": {
"type": "string",
"description": "The panel dashboard"
},
"name": {
"type": "string",
"description": "The name of the dashboard_panel",
"nullable": true
},
"params": {
"type": "object",
"properties": {
"display": {
"type": "string",
"enum": [
"line_chart",
"line_stepped_chart",
"column_chart",
"stacked_column_chart",
"monitoring_chart",
"pie_chart",
"table",
"aggregate_value"
]
},
"description": {
"type": "string"
},
"table_fields": {
"type": "array",
"items": {
"type": "string"
}
},
"legend": {
"type": "object",
"properties": {
"groups": {
"type": "string",
"enum": [
"all",
"charted"
],
"default": "all"
}
}
},
"datalabels": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
}
},
"datasets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"collection": {
"type": "string",
"enum": [
"alerts",
"incidents",
"incident_post_mortems",
"incident_action_items",
"users"
]
},
"filter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"and",
"or"
]
},
"condition": {
"type": "string",
"enum": [
"=",
"!=",
">=",
"<=",
"exists",
"not_exists",
"contains",
"not_contains"
]
},
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
}
},
"group_by": {
"type": "string",
"nullable": true
},
"aggregate": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"count",
"sum",
"average"
]
},
"key": {
"type": "string",
"nullable": true
},
"cumulative": {
"type": "boolean",
"nullable": true
}
},
"nullable": true
}
}
}
}
}
},
"position": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"w": {
"type": "number"
},
"h": {
"type": "number"
}
},
"required": [
"x",
"y",
"w",
"h"
],
"nullable": true
},
"data": {
"type": "array",
"items": {
"type": "object"
}
}
},
"required": [
"params"
]
},
"dashboard_panel_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the dashboard_panel"
},
"type": {
"type": "string",
"enum": [
"dashboard_panels"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dashboard_panel"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"dashboard_panel_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the dashboard_panel"
},
"type": {
"type": "string",
"enum": [
"dashboard_panels"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dashboard_panel"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_dashboard": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"dashboards"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the dashboard"
},
"description": {
"type": "string",
"description": "The description of the dashboard",
"nullable": true
},
"owner": {
"type": "string",
"description": "The owner type of the dashboard",
"enum": [
"user",
"team"
]
},
"public": {
"type": "boolean",
"description": "Whether the dashboard is public"
},
"range": {
"type": "string",
"description": "The date range for dashboard panel data",
"nullable": true
},
"auto_refresh": {
"type": "boolean",
"description": "Whether the dashboard auto-updates the UI with new data."
},
"color": {
"type": "string",
"description": "The hex color of the dashboard",
"enum": [
"#FCF2CF",
"#D7F5E1",
"#E9E2FF",
"#FAE6E8",
"#FAEEE6"
],
"nullable": true
},
"icon": {
"type": "string",
"description": "The emoji icon of the dashboard"
},
"period": {
"type": "string",
"description": "The grouping period for dashboard panel data",
"enum": [
"day",
"week",
"month"
],
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name",
"owner"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_dashboard": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"dashboards"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the dashboard"
},
"description": {
"type": "string",
"description": "The description of the dashboard",
"nullable": true
},
"owner": {
"type": "string",
"description": "The owner type of the dashboard",
"enum": [
"user",
"team"
]
},
"public": {
"type": "boolean",
"description": "Whether the dashboard is public"
},
"range": {
"type": "string",
"description": "The date range for dashboard panel data",
"nullable": true
},
"auto_refresh": {
"type": "boolean",
"description": "Whether the dashboard auto-updates the UI with new data."
},
"color": {
"type": "string",
"description": "The hex color of the dashboard",
"enum": [
"#FCF2CF",
"#D7F5E1",
"#E9E2FF",
"#FAE6E8",
"#FAEEE6"
],
"nullable": true
},
"icon": {
"type": "string",
"description": "The emoji icon of the dashboard"
},
"period": {
"type": "string",
"description": "The grouping period for dashboard panel data",
"enum": [
"day",
"week",
"month"
],
"nullable": true
}
},
"additionalProperties": false
}
}
}
},
"required": [
"data"
]
},
"dashboard": {
"type": "object",
"properties": {
"team_id": {
"type": "integer",
"description": "The dashboard team"
},
"user_id": {
"type": "integer",
"description": "The dashboard user owner if owner is of type user",
"nullable": true
},
"name": {
"type": "string",
"description": "The name of the dashboard"
},
"description": {
"type": "string",
"description": "The description of the dashboard",
"nullable": true
},
"owner": {
"type": "string",
"description": "The owner type of the dashboard",
"enum": [
"user",
"team"
]
},
"public": {
"type": "boolean",
"description": "Whether the dashboard is public"
},
"range": {
"type": "string",
"description": "The date range for dashboard panel data",
"nullable": true
},
"period": {
"type": "string",
"description": "The grouping period for dashboard panel data",
"nullable": true
},
"auto_refresh": {
"type": "boolean",
"description": "Whether the dashboard auto-updates the UI with new data."
},
"color": {
"type": "string",
"description": "The hex color of the dashboard",
"enum": [
"#FCF2CF",
"#D7F5E1",
"#E9E2FF",
"#FAE6E8",
"#FAEEE6"
],
"nullable": true
},
"icon": {
"type": "string",
"description": "The emoji icon of the dashboard"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"owner",
"public"
]
},
"dashboard_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the dashboard"
},
"type": {
"type": "string",
"enum": [
"dashboards"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dashboard"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"dashboard_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the dashboard"
},
"type": {
"type": "string",
"enum": [
"dashboards"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dashboard"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_environment": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"environments"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the environment"
},
"description": {
"type": "string",
"description": "The description of the environment",
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the environment",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the environment",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the environment",
"items": {
"type": "string"
},
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this environment",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this environment",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_environment": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"environments"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the environment"
},
"description": {
"type": "string",
"description": "The description of the environment",
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the environment",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the environment",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the environment",
"items": {
"type": "string"
},
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this environment",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this environment",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"environment": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the environment"
},
"slug": {
"type": "string",
"description": "The slug of the environment"
},
"description": {
"type": "string",
"description": "The description of the environment",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails attached to the environment",
"items": {
"type": "string"
},
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the environment",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the environment",
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this environment",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this environment",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"environment_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the environment"
},
"type": {
"type": "string",
"enum": [
"environments"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/environment"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"environment_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the environment"
},
"type": {
"type": "string",
"enum": [
"environments"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/environment"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"errors_list": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"status": {
"type": "string"
},
"code": {
"type": "string",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
}
},
"required": [
"title",
"status"
]
}
}
}
},
"new_escalation_policy": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"escalation_policies"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the escalation policy"
},
"description": {
"type": "string",
"description": "The description of the escalation policy",
"nullable": true
},
"repeat_count": {
"type": "integer",
"description": "The number of times this policy will be executed until someone acknowledges the alert"
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Associated groups (alerting the group will trigger escalation policy)"
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Associated services (alerting the service will trigger escalation policy)"
},
"business_hours": {
"type": "object",
"properties": {
"time_zone": {
"type": "string",
"description": "Time zone for business hours",
"nullable": true
},
"days": {
"type": "array",
"items": {
"type": "string",
"enum": [
"M",
"T",
"W",
"R",
"F",
"U",
"S"
]
},
"description": "Business days",
"nullable": true
},
"start_time": {
"type": "string",
"description": "Start time for business hours (HH:MM)",
"nullable": true
},
"end_time": {
"type": "string",
"description": "End time for business hours (HH:MM)",
"nullable": true
}
},
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_escalation_policy": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"escalation_policies"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the escalation policy"
},
"description": {
"type": "string",
"description": "The description of the escalation policy",
"nullable": true
},
"repeat_count": {
"type": "integer",
"description": "The number of times this policy will be executed until someone acknowledges the alert"
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Associated groups (alerting the group will trigger escalation policy)"
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Associated services (alerting the service will trigger escalation policy)"
},
"business_hours": {
"type": "object",
"properties": {
"time_zone": {
"type": "string",
"description": "Time zone for business hours",
"nullable": true
},
"days": {
"type": "array",
"items": {
"type": "string",
"enum": [
"M",
"T",
"W",
"R",
"F",
"U",
"S"
]
},
"description": "Business days",
"nullable": true
},
"start_time": {
"type": "string",
"description": "Start time for business hours (HH:MM)",
"nullable": true
},
"end_time": {
"type": "string",
"description": "End time for business hours (HH:MM)",
"nullable": true
}
},
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"escalation_policy": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the escalation policy"
},
"description": {
"type": "string",
"description": "The description of the escalation policy",
"nullable": true
},
"repeat_count": {
"type": "integer",
"description": "The number of times this policy will be executed until someone acknowledges the alert"
},
"created_by_user_id": {
"type": "integer",
"description": "User who created the escalation policy"
},
"last_updated_by_user_id": {
"type": "integer",
"description": "User who updated the escalation policy"
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Associated groups (alerting the group will trigger escalation policy)"
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Associated services (alerting the service will trigger escalation policy)"
},
"business_hours": {
"type": "object",
"properties": {
"time_zone": {
"type": "string",
"description": "Time zone for business hours",
"nullable": true
},
"days": {
"type": "array",
"items": {
"type": "string",
"enum": [
"M",
"T",
"W",
"R",
"F",
"U",
"S"
]
},
"description": "Business days",
"nullable": true
},
"start_time": {
"type": "string",
"description": "Start time for business hours (HH:MM)",
"nullable": true
},
"end_time": {
"type": "string",
"description": "End time for business hours (HH:MM)",
"nullable": true
}
},
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"repeat_count",
"created_by_user_id"
]
},
"escalation_policy_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the escalation policy"
},
"type": {
"type": "string",
"enum": [
"escalation_policies"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/escalation_policy"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"escalation_policy_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the escalation policy"
},
"type": {
"type": "string",
"enum": [
"escalation_policies"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/escalation_policy"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_escalation_policy_path": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"escalation_paths"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the escalation path"
},
"notification_type": {
"type": "string",
"description": "Notification rule type to be used",
"enum": [
"audible",
"quiet"
],
"default": "audible"
},
"default": {
"type": "boolean",
"description": "Whether this escalation path is the default path",
"nullable": true
},
"match_mode": {
"type": "string",
"description": "How path rules are matched.",
"enum": [
"match-all-rules",
"match-any-rule"
],
"default": "match-all-rules"
},
"position": {
"type": "integer",
"description": "The position of this path in the paths for this EP."
},
"repeat": {
"type": "boolean",
"description": "Whether this path should be repeated until someone acknowledges the alert",
"nullable": true
},
"repeat_count": {
"type": "integer",
"description": "The number of times this path will be executed until someone acknowledges the alert",
"nullable": true
},
"initial_delay": {
"type": "integer",
"description": "Initial delay for escalation path in minutes. Maximum 1 week (10080)."
},
"rules": {
"type": "array",
"description": "Escalation path conditions",
"items": {
"type": "object",
"anyOf": [
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"alert_urgency"
]
},
"urgency_ids": {
"type": "array",
"description": "Alert urgency ids for which this escalation path should be used"
}
},
"required": [
"rule_type",
"urgency_ids"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"working_hour"
]
},
"within_working_hour": {
"type": "boolean",
"description": "Whether the escalation path should be used within working hours"
}
},
"required": [
"rule_type",
"within_working_hour"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"json_path"
]
},
"json_path": {
"type": "string",
"description": "JSON path to extract value from payload"
},
"operator": {
"type": "string",
"description": "How JSON path value should be matched",
"enum": [
"is",
"is_not",
"contains",
"does_not_contain"
]
},
"value": {
"type": "string",
"description": "Value with which JSON path value should be matched"
}
},
"required": [
"rule_type",
"json_path",
"operator",
"value"
]
}
]
}
},
"time_restriction_time_zone": {
"type": "string",
"description": "Time zone used for time restrictions.",
"enum": [
"International Date Line West",
"Etc/GMT+12",
"American Samoa",
"Pacific/Pago_Pago",
"Midway Island",
"Pacific/Midway",
"Hawaii",
"Pacific/Honolulu",
"Alaska",
"America/Juneau",
"Pacific Time (US & Canada)",
"America/Los_Angeles",
"Tijuana",
"America/Tijuana",
"Arizona",
"America/Phoenix",
"Mazatlan",
"America/Mazatlan",
"Mountain Time (US & Canada)",
"America/Denver",
"Central America",
"America/Guatemala",
"Central Time (US & Canada)",
"America/Chicago",
"Chihuahua",
"America/Chihuahua",
"Guadalajara",
"America/Mexico_City",
"Mexico City",
"America/Mexico_City",
"Monterrey",
"America/Monterrey",
"Saskatchewan",
"America/Regina",
"Bogota",
"America/Bogota",
"Eastern Time (US & Canada)",
"America/New_York",
"Indiana (East)",
"America/Indiana/Indianapolis",
"Lima",
"America/Lima",
"Quito",
"America/Lima",
"Atlantic Time (Canada)",
"America/Halifax",
"Caracas",
"America/Caracas",
"Georgetown",
"America/Guyana",
"La Paz",
"America/La_Paz",
"Puerto Rico",
"America/Puerto_Rico",
"Santiago",
"America/Santiago",
"Newfoundland",
"America/St_Johns",
"Brasilia",
"America/Sao_Paulo",
"Buenos Aires",
"America/Argentina/Buenos_Aires",
"Montevideo",
"America/Montevideo",
"Greenland",
"America/Godthab",
"Mid-Atlantic",
"Atlantic/South_Georgia",
"Azores",
"Atlantic/Azores",
"Cape Verde Is.",
"Atlantic/Cape_Verde",
"Edinburgh",
"Europe/London",
"Lisbon",
"Europe/Lisbon",
"London",
"Europe/London",
"Monrovia",
"Africa/Monrovia",
"UTC",
"Etc/UTC",
"Amsterdam",
"Europe/Amsterdam",
"Belgrade",
"Europe/Belgrade",
"Berlin",
"Europe/Berlin",
"Bern",
"Europe/Zurich",
"Bratislava",
"Europe/Bratislava",
"Brussels",
"Europe/Brussels",
"Budapest",
"Europe/Budapest",
"Casablanca",
"Africa/Casablanca",
"Copenhagen",
"Europe/Copenhagen",
"Dublin",
"Europe/Dublin",
"Ljubljana",
"Europe/Ljubljana",
"Madrid",
"Europe/Madrid",
"Paris",
"Europe/Paris",
"Prague",
"Europe/Prague",
"Rome",
"Europe/Rome",
"Sarajevo",
"Europe/Sarajevo",
"Skopje",
"Europe/Skopje",
"Stockholm",
"Europe/Stockholm",
"Vienna",
"Europe/Vienna",
"Warsaw",
"Europe/Warsaw",
"West Central Africa",
"Africa/Algiers",
"Zagreb",
"Europe/Zagreb",
"Zurich",
"Europe/Zurich",
"Athens",
"Europe/Athens",
"Bucharest",
"Europe/Bucharest",
"Cairo",
"Africa/Cairo",
"Harare",
"Africa/Harare",
"Helsinki",
"Europe/Helsinki",
"Jerusalem",
"Asia/Jerusalem",
"Kaliningrad",
"Europe/Kaliningrad",
"Kyiv",
"Europe/Kiev",
"Pretoria",
"Africa/Johannesburg",
"Riga",
"Europe/Riga",
"Sofia",
"Europe/Sofia",
"Tallinn",
"Europe/Tallinn",
"Vilnius",
"Europe/Vilnius",
"Baghdad",
"Asia/Baghdad",
"Istanbul",
"Europe/Istanbul",
"Kuwait",
"Asia/Kuwait",
"Minsk",
"Europe/Minsk",
"Moscow",
"Europe/Moscow",
"Nairobi",
"Africa/Nairobi",
"Riyadh",
"Asia/Riyadh",
"St. Petersburg",
"Europe/Moscow",
"Volgograd",
"Europe/Volgograd",
"Tehran",
"Asia/Tehran",
"Abu Dhabi",
"Asia/Muscat",
"Baku",
"Asia/Baku",
"Muscat",
"Asia/Muscat",
"Samara",
"Europe/Samara",
"Tbilisi",
"Asia/Tbilisi",
"Yerevan",
"Asia/Yerevan",
"Kabul",
"Asia/Kabul",
"Almaty",
"Asia/Almaty",
"Astana",
"Asia/Almaty",
"Ekaterinburg",
"Asia/Yekaterinburg",
"Islamabad",
"Asia/Karachi",
"Karachi",
"Asia/Karachi",
"Tashkent",
"Asia/Tashkent",
"Chennai",
"Asia/Kolkata",
"Kolkata",
"Asia/Kolkata",
"Mumbai",
"Asia/Kolkata",
"New Delhi",
"Asia/Kolkata",
"Sri Jayawardenepura",
"Asia/Colombo",
"Kathmandu",
"Asia/Kathmandu",
"Dhaka",
"Asia/Dhaka",
"Urumqi",
"Asia/Urumqi",
"Rangoon",
"Asia/Rangoon",
"Bangkok",
"Asia/Bangkok",
"Hanoi",
"Asia/Bangkok",
"Jakarta",
"Asia/Jakarta",
"Krasnoyarsk",
"Asia/Krasnoyarsk",
"Novosibirsk",
"Asia/Novosibirsk",
"Beijing",
"Asia/Shanghai",
"Chongqing",
"Asia/Chongqing",
"Hong Kong",
"Asia/Hong_Kong",
"Irkutsk",
"Asia/Irkutsk",
"Kuala Lumpur",
"Asia/Kuala_Lumpur",
"Perth",
"Australia/Perth",
"Singapore",
"Asia/Singapore",
"Taipei",
"Asia/Taipei",
"Ulaanbaatar",
"Asia/Ulaanbaatar",
"Osaka",
"Asia/Tokyo",
"Sapporo",
"Asia/Tokyo",
"Seoul",
"Asia/Seoul",
"Tokyo",
"Asia/Tokyo",
"Yakutsk",
"Asia/Yakutsk",
"Adelaide",
"Australia/Adelaide",
"Darwin",
"Australia/Darwin",
"Brisbane",
"Australia/Brisbane",
"Canberra",
"Australia/Canberra",
"Guam",
"Pacific/Guam",
"Hobart",
"Australia/Hobart",
"Melbourne",
"Australia/Melbourne",
"Port Moresby",
"Pacific/Port_Moresby",
"Sydney",
"Australia/Sydney",
"Vladivostok",
"Asia/Vladivostok",
"Magadan",
"Asia/Magadan",
"New Caledonia",
"Pacific/Noumea",
"Solomon Is.",
"Pacific/Guadalcanal",
"Srednekolymsk",
"Asia/Srednekolymsk",
"Auckland",
"Pacific/Auckland",
"Fiji",
"Pacific/Fiji",
"Kamchatka",
"Asia/Kamchatka",
"Marshall Is.",
"Pacific/Majuro",
"Wellington",
"Pacific/Auckland",
"Chatham Is.",
"Pacific/Chatham",
"Nuku'alofa",
"Pacific/Tongatapu",
"Samoa",
"Pacific/Apia",
"Tokelau Is.",
"Pacific/Fakaofo"
],
"nullable": true
},
"time_restrictions": {
"type": "array",
"description": "If time restrictions are set, alerts will follow this path when they arrive within the specified time ranges and meet the rules.",
"items": {
"type": "object",
"properties": {
"start_day": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
]
},
"start_time": {
"type": "string",
"description": "Formatted as HH:MM"
},
"end_day": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
]
},
"end_time": {
"type": "string",
"description": "Formatted as HH:MM"
}
},
"required": [
"start_day",
"start_time",
"end_day",
"end_time"
]
}
}
},
"required": [
"name"
],
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_escalation_policy_path": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"escalation_paths"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the escalation path"
},
"notification_type": {
"type": "string",
"description": "Position of the escalation policy level",
"enum": [
"audible",
"quiet"
],
"default": "audible"
},
"default": {
"type": "boolean",
"description": "Whether this escalation path is the default path",
"nullable": true
},
"match_mode": {
"type": "string",
"description": "How path rules are matched.",
"enum": [
"match-all-rules",
"match-any-rule"
],
"default": "match-all-rules"
},
"position": {
"type": "integer",
"description": "The position of this path in the paths for this EP."
},
"repeat": {
"type": "boolean",
"description": "Whether this path should be repeated until someone acknowledges the alert",
"nullable": true
},
"repeat_count": {
"type": "integer",
"description": "The number of times this path will be executed until someone acknowledges the alert",
"nullable": true
},
"initial_delay": {
"type": "integer",
"description": "Initial delay for escalation path in minutes. Maximum 1 week (10080)."
},
"rules": {
"type": "array",
"description": "Escalation path conditions",
"items": {
"type": "object",
"anyOf": [
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"alert_urgency"
]
},
"urgency_ids": {
"type": "array",
"description": "Alert urgency ids for which this escalation path should be used"
}
},
"required": [
"rule_type",
"urgency_ids"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"working_hour"
]
},
"within_working_hour": {
"type": "boolean",
"description": "Whether the escalation path should be used within working hours"
}
},
"required": [
"rule_type",
"within_working_hour"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"json_path"
]
},
"json_path": {
"type": "string",
"description": "JSON path to extract value from payload"
},
"operator": {
"type": "string",
"description": "How JSON path value should be matched",
"enum": [
"is",
"is_not",
"contains",
"does_not_contain"
]
},
"value": {
"type": "string",
"description": "Value with which JSON path value should be matched"
}
},
"required": [
"rule_type",
"json_path",
"operator",
"value"
]
}
],
"nullable": true
}
},
"time_restriction_time_zone": {
"type": "string",
"description": "Time zone used for time restrictions.",
"enum": [
"International Date Line West",
"Etc/GMT+12",
"American Samoa",
"Pacific/Pago_Pago",
"Midway Island",
"Pacific/Midway",
"Hawaii",
"Pacific/Honolulu",
"Alaska",
"America/Juneau",
"Pacific Time (US & Canada)",
"America/Los_Angeles",
"Tijuana",
"America/Tijuana",
"Arizona",
"America/Phoenix",
"Mazatlan",
"America/Mazatlan",
"Mountain Time (US & Canada)",
"America/Denver",
"Central America",
"America/Guatemala",
"Central Time (US & Canada)",
"America/Chicago",
"Chihuahua",
"America/Chihuahua",
"Guadalajara",
"America/Mexico_City",
"Mexico City",
"America/Mexico_City",
"Monterrey",
"America/Monterrey",
"Saskatchewan",
"America/Regina",
"Bogota",
"America/Bogota",
"Eastern Time (US & Canada)",
"America/New_York",
"Indiana (East)",
"America/Indiana/Indianapolis",
"Lima",
"America/Lima",
"Quito",
"America/Lima",
"Atlantic Time (Canada)",
"America/Halifax",
"Caracas",
"America/Caracas",
"Georgetown",
"America/Guyana",
"La Paz",
"America/La_Paz",
"Puerto Rico",
"America/Puerto_Rico",
"Santiago",
"America/Santiago",
"Newfoundland",
"America/St_Johns",
"Brasilia",
"America/Sao_Paulo",
"Buenos Aires",
"America/Argentina/Buenos_Aires",
"Montevideo",
"America/Montevideo",
"Greenland",
"America/Godthab",
"Mid-Atlantic",
"Atlantic/South_Georgia",
"Azores",
"Atlantic/Azores",
"Cape Verde Is.",
"Atlantic/Cape_Verde",
"Edinburgh",
"Europe/London",
"Lisbon",
"Europe/Lisbon",
"London",
"Europe/London",
"Monrovia",
"Africa/Monrovia",
"UTC",
"Etc/UTC",
"Amsterdam",
"Europe/Amsterdam",
"Belgrade",
"Europe/Belgrade",
"Berlin",
"Europe/Berlin",
"Bern",
"Europe/Zurich",
"Bratislava",
"Europe/Bratislava",
"Brussels",
"Europe/Brussels",
"Budapest",
"Europe/Budapest",
"Casablanca",
"Africa/Casablanca",
"Copenhagen",
"Europe/Copenhagen",
"Dublin",
"Europe/Dublin",
"Ljubljana",
"Europe/Ljubljana",
"Madrid",
"Europe/Madrid",
"Paris",
"Europe/Paris",
"Prague",
"Europe/Prague",
"Rome",
"Europe/Rome",
"Sarajevo",
"Europe/Sarajevo",
"Skopje",
"Europe/Skopje",
"Stockholm",
"Europe/Stockholm",
"Vienna",
"Europe/Vienna",
"Warsaw",
"Europe/Warsaw",
"West Central Africa",
"Africa/Algiers",
"Zagreb",
"Europe/Zagreb",
"Zurich",
"Europe/Zurich",
"Athens",
"Europe/Athens",
"Bucharest",
"Europe/Bucharest",
"Cairo",
"Africa/Cairo",
"Harare",
"Africa/Harare",
"Helsinki",
"Europe/Helsinki",
"Jerusalem",
"Asia/Jerusalem",
"Kaliningrad",
"Europe/Kaliningrad",
"Kyiv",
"Europe/Kiev",
"Pretoria",
"Africa/Johannesburg",
"Riga",
"Europe/Riga",
"Sofia",
"Europe/Sofia",
"Tallinn",
"Europe/Tallinn",
"Vilnius",
"Europe/Vilnius",
"Baghdad",
"Asia/Baghdad",
"Istanbul",
"Europe/Istanbul",
"Kuwait",
"Asia/Kuwait",
"Minsk",
"Europe/Minsk",
"Moscow",
"Europe/Moscow",
"Nairobi",
"Africa/Nairobi",
"Riyadh",
"Asia/Riyadh",
"St. Petersburg",
"Europe/Moscow",
"Volgograd",
"Europe/Volgograd",
"Tehran",
"Asia/Tehran",
"Abu Dhabi",
"Asia/Muscat",
"Baku",
"Asia/Baku",
"Muscat",
"Asia/Muscat",
"Samara",
"Europe/Samara",
"Tbilisi",
"Asia/Tbilisi",
"Yerevan",
"Asia/Yerevan",
"Kabul",
"Asia/Kabul",
"Almaty",
"Asia/Almaty",
"Astana",
"Asia/Almaty",
"Ekaterinburg",
"Asia/Yekaterinburg",
"Islamabad",
"Asia/Karachi",
"Karachi",
"Asia/Karachi",
"Tashkent",
"Asia/Tashkent",
"Chennai",
"Asia/Kolkata",
"Kolkata",
"Asia/Kolkata",
"Mumbai",
"Asia/Kolkata",
"New Delhi",
"Asia/Kolkata",
"Sri Jayawardenepura",
"Asia/Colombo",
"Kathmandu",
"Asia/Kathmandu",
"Dhaka",
"Asia/Dhaka",
"Urumqi",
"Asia/Urumqi",
"Rangoon",
"Asia/Rangoon",
"Bangkok",
"Asia/Bangkok",
"Hanoi",
"Asia/Bangkok",
"Jakarta",
"Asia/Jakarta",
"Krasnoyarsk",
"Asia/Krasnoyarsk",
"Novosibirsk",
"Asia/Novosibirsk",
"Beijing",
"Asia/Shanghai",
"Chongqing",
"Asia/Chongqing",
"Hong Kong",
"Asia/Hong_Kong",
"Irkutsk",
"Asia/Irkutsk",
"Kuala Lumpur",
"Asia/Kuala_Lumpur",
"Perth",
"Australia/Perth",
"Singapore",
"Asia/Singapore",
"Taipei",
"Asia/Taipei",
"Ulaanbaatar",
"Asia/Ulaanbaatar",
"Osaka",
"Asia/Tokyo",
"Sapporo",
"Asia/Tokyo",
"Seoul",
"Asia/Seoul",
"Tokyo",
"Asia/Tokyo",
"Yakutsk",
"Asia/Yakutsk",
"Adelaide",
"Australia/Adelaide",
"Darwin",
"Australia/Darwin",
"Brisbane",
"Australia/Brisbane",
"Canberra",
"Australia/Canberra",
"Guam",
"Pacific/Guam",
"Hobart",
"Australia/Hobart",
"Melbourne",
"Australia/Melbourne",
"Port Moresby",
"Pacific/Port_Moresby",
"Sydney",
"Australia/Sydney",
"Vladivostok",
"Asia/Vladivostok",
"Magadan",
"Asia/Magadan",
"New Caledonia",
"Pacific/Noumea",
"Solomon Is.",
"Pacific/Guadalcanal",
"Srednekolymsk",
"Asia/Srednekolymsk",
"Auckland",
"Pacific/Auckland",
"Fiji",
"Pacific/Fiji",
"Kamchatka",
"Asia/Kamchatka",
"Marshall Is.",
"Pacific/Majuro",
"Wellington",
"Pacific/Auckland",
"Chatham Is.",
"Pacific/Chatham",
"Nuku'alofa",
"Pacific/Tongatapu",
"Samoa",
"Pacific/Apia",
"Tokelau Is.",
"Pacific/Fakaofo"
],
"nullable": true
},
"time_restrictions": {
"type": "array",
"description": "If time restrictions are set, alerts will follow this path when they arrive within the specified time ranges and meet the rules.",
"items": {
"type": "object",
"properties": {
"start_day": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
]
},
"start_time": {
"type": "string",
"description": "Formatted as HH:MM"
},
"end_day": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
]
},
"end_time": {
"type": "string",
"description": "Formatted as HH:MM"
}
}
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"escalation_policy_path": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the escalation path"
},
"default": {
"type": "boolean",
"description": "Whether this escalation path is the default path"
},
"notification_type": {
"type": "string",
"description": "Notification rule type"
},
"escalation_policy_id": {
"type": "string",
"description": "The ID of the escalation policy"
},
"match_mode": {
"type": "string",
"description": "How path rules are matched.",
"enum": [
"match-all-rules",
"match-any-rule"
]
},
"position": {
"type": "integer",
"description": "The position of this path in the paths for this EP."
},
"repeat": {
"type": "boolean",
"description": "Whether this path should be repeated until someone acknowledges the alert",
"nullable": true
},
"repeat_count": {
"type": "integer",
"description": "The number of times this path will be executed until someone acknowledges the alert",
"nullable": true
},
"initial_delay": {
"type": "integer",
"description": "Initial delay for escalation path in minutes. Maximum 1 week (10080)."
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
},
"rules": {
"type": "array",
"description": "Escalation path rules",
"items": {
"type": "object",
"anyOf": [
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"alert_urgency"
]
},
"urgency_ids": {
"type": "array",
"description": "Alert urgency ids for which this escalation path should be used",
"items": {
"type": "string"
}
}
},
"required": [
"rule_type",
"urgency_ids"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"working_hour"
]
},
"within_working_hour": {
"type": "boolean",
"description": "Whether the escalation path should be used within working hours"
}
},
"required": [
"rule_type",
"within_working_hour"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"json_path"
]
},
"json_path": {
"type": "string",
"description": "JSON path to extract value from payload"
},
"operator": {
"type": "string",
"description": "How JSON path value should be matched",
"enum": [
"is",
"is_not",
"contains",
"does_not_contain"
]
},
"value": {
"type": "string",
"description": "Value with which JSON path value should be matched"
}
},
"required": [
"rule_type",
"json_path",
"operator",
"value"
]
}
],
"nullable": true
}
},
"time_restriction_time_zone": {
"type": "string",
"description": "Time zone used for time restrictions.",
"enum": [
"International Date Line West",
"Etc/GMT+12",
"American Samoa",
"Pacific/Pago_Pago",
"Midway Island",
"Pacific/Midway",
"Hawaii",
"Pacific/Honolulu",
"Alaska",
"America/Juneau",
"Pacific Time (US & Canada)",
"America/Los_Angeles",
"Tijuana",
"America/Tijuana",
"Arizona",
"America/Phoenix",
"Mazatlan",
"America/Mazatlan",
"Mountain Time (US & Canada)",
"America/Denver",
"Central America",
"America/Guatemala",
"Central Time (US & Canada)",
"America/Chicago",
"Chihuahua",
"America/Chihuahua",
"Guadalajara",
"America/Mexico_City",
"Mexico City",
"America/Mexico_City",
"Monterrey",
"America/Monterrey",
"Saskatchewan",
"America/Regina",
"Bogota",
"America/Bogota",
"Eastern Time (US & Canada)",
"America/New_York",
"Indiana (East)",
"America/Indiana/Indianapolis",
"Lima",
"America/Lima",
"Quito",
"America/Lima",
"Atlantic Time (Canada)",
"America/Halifax",
"Caracas",
"America/Caracas",
"Georgetown",
"America/Guyana",
"La Paz",
"America/La_Paz",
"Puerto Rico",
"America/Puerto_Rico",
"Santiago",
"America/Santiago",
"Newfoundland",
"America/St_Johns",
"Brasilia",
"America/Sao_Paulo",
"Buenos Aires",
"America/Argentina/Buenos_Aires",
"Montevideo",
"America/Montevideo",
"Greenland",
"America/Godthab",
"Mid-Atlantic",
"Atlantic/South_Georgia",
"Azores",
"Atlantic/Azores",
"Cape Verde Is.",
"Atlantic/Cape_Verde",
"Edinburgh",
"Europe/London",
"Lisbon",
"Europe/Lisbon",
"London",
"Europe/London",
"Monrovia",
"Africa/Monrovia",
"UTC",
"Etc/UTC",
"Amsterdam",
"Europe/Amsterdam",
"Belgrade",
"Europe/Belgrade",
"Berlin",
"Europe/Berlin",
"Bern",
"Europe/Zurich",
"Bratislava",
"Europe/Bratislava",
"Brussels",
"Europe/Brussels",
"Budapest",
"Europe/Budapest",
"Casablanca",
"Africa/Casablanca",
"Copenhagen",
"Europe/Copenhagen",
"Dublin",
"Europe/Dublin",
"Ljubljana",
"Europe/Ljubljana",
"Madrid",
"Europe/Madrid",
"Paris",
"Europe/Paris",
"Prague",
"Europe/Prague",
"Rome",
"Europe/Rome",
"Sarajevo",
"Europe/Sarajevo",
"Skopje",
"Europe/Skopje",
"Stockholm",
"Europe/Stockholm",
"Vienna",
"Europe/Vienna",
"Warsaw",
"Europe/Warsaw",
"West Central Africa",
"Africa/Algiers",
"Zagreb",
"Europe/Zagreb",
"Zurich",
"Europe/Zurich",
"Athens",
"Europe/Athens",
"Bucharest",
"Europe/Bucharest",
"Cairo",
"Africa/Cairo",
"Harare",
"Africa/Harare",
"Helsinki",
"Europe/Helsinki",
"Jerusalem",
"Asia/Jerusalem",
"Kaliningrad",
"Europe/Kaliningrad",
"Kyiv",
"Europe/Kiev",
"Pretoria",
"Africa/Johannesburg",
"Riga",
"Europe/Riga",
"Sofia",
"Europe/Sofia",
"Tallinn",
"Europe/Tallinn",
"Vilnius",
"Europe/Vilnius",
"Baghdad",
"Asia/Baghdad",
"Istanbul",
"Europe/Istanbul",
"Kuwait",
"Asia/Kuwait",
"Minsk",
"Europe/Minsk",
"Moscow",
"Europe/Moscow",
"Nairobi",
"Africa/Nairobi",
"Riyadh",
"Asia/Riyadh",
"St. Petersburg",
"Europe/Moscow",
"Volgograd",
"Europe/Volgograd",
"Tehran",
"Asia/Tehran",
"Abu Dhabi",
"Asia/Muscat",
"Baku",
"Asia/Baku",
"Muscat",
"Asia/Muscat",
"Samara",
"Europe/Samara",
"Tbilisi",
"Asia/Tbilisi",
"Yerevan",
"Asia/Yerevan",
"Kabul",
"Asia/Kabul",
"Almaty",
"Asia/Almaty",
"Astana",
"Asia/Almaty",
"Ekaterinburg",
"Asia/Yekaterinburg",
"Islamabad",
"Asia/Karachi",
"Karachi",
"Asia/Karachi",
"Tashkent",
"Asia/Tashkent",
"Chennai",
"Asia/Kolkata",
"Kolkata",
"Asia/Kolkata",
"Mumbai",
"Asia/Kolkata",
"New Delhi",
"Asia/Kolkata",
"Sri Jayawardenepura",
"Asia/Colombo",
"Kathmandu",
"Asia/Kathmandu",
"Dhaka",
"Asia/Dhaka",
"Urumqi",
"Asia/Urumqi",
"Rangoon",
"Asia/Rangoon",
"Bangkok",
"Asia/Bangkok",
"Hanoi",
"Asia/Bangkok",
"Jakarta",
"Asia/Jakarta",
"Krasnoyarsk",
"Asia/Krasnoyarsk",
"Novosibirsk",
"Asia/Novosibirsk",
"Beijing",
"Asia/Shanghai",
"Chongqing",
"Asia/Chongqing",
"Hong Kong",
"Asia/Hong_Kong",
"Irkutsk",
"Asia/Irkutsk",
"Kuala Lumpur",
"Asia/Kuala_Lumpur",
"Perth",
"Australia/Perth",
"Singapore",
"Asia/Singapore",
"Taipei",
"Asia/Taipei",
"Ulaanbaatar",
"Asia/Ulaanbaatar",
"Osaka",
"Asia/Tokyo",
"Sapporo",
"Asia/Tokyo",
"Seoul",
"Asia/Seoul",
"Tokyo",
"Asia/Tokyo",
"Yakutsk",
"Asia/Yakutsk",
"Adelaide",
"Australia/Adelaide",
"Darwin",
"Australia/Darwin",
"Brisbane",
"Australia/Brisbane",
"Canberra",
"Australia/Canberra",
"Guam",
"Pacific/Guam",
"Hobart",
"Australia/Hobart",
"Melbourne",
"Australia/Melbourne",
"Port Moresby",
"Pacific/Port_Moresby",
"Sydney",
"Australia/Sydney",
"Vladivostok",
"Asia/Vladivostok",
"Magadan",
"Asia/Magadan",
"New Caledonia",
"Pacific/Noumea",
"Solomon Is.",
"Pacific/Guadalcanal",
"Srednekolymsk",
"Asia/Srednekolymsk",
"Auckland",
"Pacific/Auckland",
"Fiji",
"Pacific/Fiji",
"Kamchatka",
"Asia/Kamchatka",
"Marshall Is.",
"Pacific/Majuro",
"Wellington",
"Pacific/Auckland",
"Chatham Is.",
"Pacific/Chatham",
"Nuku'alofa",
"Pacific/Tongatapu",
"Samoa",
"Pacific/Apia",
"Tokelau Is.",
"Pacific/Fakaofo"
],
"nullable": true
},
"time_restrictions": {
"type": "array",
"description": "If time restrictions are set, alerts will follow this path when they arrive within the specified time ranges and meet the rules.",
"items": {
"type": "object",
"properties": {
"start_day": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
]
},
"start_time": {
"type": "string",
"description": "Formatted as HH:MM"
},
"end_day": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
]
},
"end_time": {
"type": "string",
"description": "Formatted as HH:MM"
}
}
}
}
},
"required": [
"name",
"default",
"notification_type",
"escalation_policy_id",
"repeat",
"repeat_count"
]
},
"escalation_policy_path_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the escalation policy path"
},
"type": {
"type": "string",
"enum": [
"escalation_paths"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/escalation_policy_path"
}
]
}
},
"required": [
"id",
"attributes"
]
}
},
"required": [
"data"
]
},
"escalation_policy_path_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the escalation policy path"
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/escalation_policy_path"
}
]
}
},
"required": [
"id",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_escalation_policy_level": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"escalation_levels"
]
},
"attributes": {
"type": "object",
"properties": {
"delay": {
"type": "integer",
"description": "Delay before notification targets will be alerted."
},
"position": {
"type": "integer",
"description": "Position of the escalation policy level"
},
"paging_strategy_configuration_strategy": {
"type": "string",
"enum": [
"default",
"random",
"cycle",
"alert"
],
"nullable": true
},
"paging_strategy_configuration_schedule_strategy": {
"type": "string",
"enum": [
"on_call_only",
"everyone"
],
"nullable": true
},
"escalation_policy_path_id": {
"type": "string",
"description": "The ID of the dynamic escalation policy path the level will belong to. If nothing is specified it will add the level to your default path.",
"nullable": true
},
"notification_target_params": {
"type": "array",
"description": "Escalation level's notification targets",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of notification target. If Slack channel, then id of the slack channel (eg. C06Q2JK7RQW)"
},
"type": {
"type": "string",
"description": "The type of the notification target",
"enum": [
"team",
"user",
"schedule",
"slack_channel",
"service"
]
},
"team_members": {
"type": "string",
"enum": [
"all",
"admins",
"escalate"
],
"nullable": true,
"description": "For targets with type=team, controls whether to notify admins, all team members, or escalate to team EP."
}
},
"required": [
"id",
"type"
],
"nullable": true
}
}
},
"required": [
"position",
"notification_target_params"
],
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_escalation_policy_level": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"escalation_levels"
]
},
"attributes": {
"type": "object",
"properties": {
"delay": {
"type": "integer",
"description": "Delay before notification targets will be alerted."
},
"position": {
"type": "integer",
"description": "Position of the escalation policy level"
},
"escalation_policy_path_id": {
"type": "string",
"description": "The ID of the dynamic escalation policy path the level will belong to. If nothing is specified it will add the level to your default path.",
"nullable": true
},
"paging_strategy_configuration_strategy": {
"type": "string",
"enum": [
"default",
"random",
"cycle",
"alert"
],
"nullable": true
},
"paging_strategy_configuration_schedule_strategy": {
"type": "string",
"enum": [
"on_call_only",
"everyone"
],
"nullable": true
},
"notification_target_params": {
"type": "array",
"description": "Escalation level's notification targets",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of notification target"
},
"type": {
"type": "string",
"description": "The type of the notification target",
"enum": [
"team",
"user",
"schedule",
"slack_channel",
"service"
]
},
"team_members": {
"type": "string",
"enum": [
"all",
"admins",
"escalate"
],
"nullable": true,
"description": "For targets with type=team, controls whether to notify admins, all team members, or escalate to team EP."
}
},
"required": [
"id",
"type"
],
"nullable": true
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"escalation_policy_level": {
"type": "object",
"properties": {
"escalation_policy_id": {
"type": "string",
"description": "The ID of the escalation policy"
},
"escalation_policy_path_id": {
"type": "string",
"description": "The ID of the dynamic escalation policy path the level will belong to. If nothing is specified it will add the level to your default path.",
"nullable": true
},
"paging_strategy_configuration_strategy": {
"type": "string",
"enum": [
"default",
"random",
"cycle",
"alert"
],
"nullable": true
},
"paging_strategy_configuration_schedule_strategy": {
"type": "string",
"enum": [
"on_call_only",
"everyone"
],
"nullable": true
},
"delay": {
"type": "integer",
"description": "Delay before notification targets will be alerted."
},
"position": {
"type": "integer",
"description": "Position of the escalation policy level"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
},
"notification_target_params": {
"type": "array",
"description": "Escalation level's notification targets",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of notification target"
},
"type": {
"type": "string",
"description": "The type of the notification target",
"enum": [
"team",
"user",
"schedule",
"slack_channel",
"service"
]
},
"team_members": {
"type": "string",
"enum": [
"all",
"admins",
"escalate"
],
"nullable": true,
"description": "For targets with type=team, controls whether to notify admins, all team members, or escalate to team EP."
}
},
"required": [
"id",
"type"
],
"nullable": true
}
}
},
"required": [
"escalation_policy_id",
"position",
"delay",
"notification_target_params"
]
},
"escalation_policy_level_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the escalation policy level"
},
"type": {
"type": "string",
"enum": [
"escalation_levels"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/escalation_policy_level"
}
]
}
},
"required": [
"id",
"attributes"
]
}
},
"required": [
"data"
]
},
"escalation_policy_level_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the escalation policy level"
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/escalation_policy_level"
}
]
}
},
"required": [
"id",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_form_field_option": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_field_options"
]
},
"attributes": {
"type": "object",
"properties": {
"form_field_id": {
"type": "string",
"description": "The ID of the form field"
},
"value": {
"type": "string",
"description": "The value of the form_field_option"
},
"color": {
"type": "string",
"description": "The hex color of the form_field_option"
},
"default": {
"type": "boolean"
},
"position": {
"type": "integer",
"description": "The position of the form_field_option"
}
},
"additionalProperties": false,
"required": [
"form_field_id",
"value"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_form_field_option": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_field_options"
]
},
"attributes": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The value of the form_field_option"
},
"color": {
"type": "string",
"description": "The hex color of the form_field_option"
},
"default": {
"type": "boolean"
},
"position": {
"type": "integer",
"description": "The position of the form_field_option"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"form_field_option": {
"type": "object",
"properties": {
"form_field_id": {
"type": "string",
"description": "The ID of the parent custom field"
},
"value": {
"type": "string",
"description": "The value of the form_field_option"
},
"color": {
"type": "string",
"description": "The hex color of the form_field_option"
},
"default": {
"type": "boolean"
},
"position": {
"type": "integer",
"description": "The position of the form_field_option"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"value",
"color",
"position",
"created_at",
"updated_at"
]
},
"form_field_option_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form_field_option"
},
"type": {
"type": "string",
"enum": [
"form_field_options"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_field_option"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"form_field_option_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form_field_option"
},
"type": {
"type": "string",
"enum": [
"form_field_options"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_field_option"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_form_field_placement_condition": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_field_placement_conditions"
]
},
"attributes": {
"type": "object",
"properties": {
"conditioned": {
"type": "string",
"description": "The resource or attribute the condition applies.",
"enum": [
"placement",
"required"
]
},
"position": {
"type": "integer",
"description": "The condition position."
},
"form_field_id": {
"type": "string",
"description": "The condition field."
},
"comparison": {
"type": "string",
"description": "The condition comparison.",
"enum": [
"equal",
"is_set",
"is_not_set"
]
},
"values": {
"type": "array",
"description": "The values for comparison.",
"items": {
"type": "string",
"description": "The value for comparison."
}
}
},
"required": [
"conditioned",
"form_field_id",
"comparison",
"values"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_form_field_placement_condition": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_field_placement_conditions"
]
},
"attributes": {
"type": "object",
"properties": {
"conditioned": {
"type": "string",
"description": "The resource or attribute the condition applies.",
"enum": [
"placement",
"required"
]
},
"position": {
"type": "integer",
"description": "The condition position."
},
"form_field_id": {
"type": "string",
"description": "The condition field."
},
"comparison": {
"type": "string",
"description": "The condition comparison.",
"enum": [
"equal",
"is_set",
"is_not_set"
]
},
"values": {
"type": "array",
"description": "The values for comparison.",
"items": {
"type": "string",
"description": "The value for comparison."
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"form_field_placement_condition": {
"type": "object",
"properties": {
"form_field_placement_id": {
"type": "string",
"description": "The form field placement this condition applies."
},
"conditioned": {
"type": "string",
"description": "The resource or attribute the condition applies.",
"enum": [
"placement",
"required"
]
},
"position": {
"type": "integer",
"description": "The condition position."
},
"form_field_id": {
"type": "string",
"description": "The condition field."
},
"comparison": {
"type": "string",
"description": "The condition comparison.",
"enum": [
"equal",
"is_set",
"is_not_set"
]
},
"values": {
"type": "array",
"description": "The values for comparison.",
"items": {
"type": "string",
"description": "The value for comparison."
}
}
},
"required": [
"form_field_placement_id",
"conditioned",
"position",
"form_field_id",
"comparison",
"values"
]
},
"form_field_placement_condition_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form set condition"
},
"type": {
"type": "string",
"enum": [
"form_field_placement_conditions"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_field_placement_condition"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"form_field_placement_condition_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form set condition"
},
"type": {
"type": "string",
"enum": [
"form_field_placement_conditions"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_field_placement_condition"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_form_field_placement": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_field_placements"
]
},
"attributes": {
"type": "object",
"properties": {
"form_set_id": {
"type": "string",
"description": "The form set this field is placed in."
},
"form": {
"type": "string",
"description": "The form this field is placed on."
},
"position": {
"type": "integer",
"description": "The position of the field placement."
},
"required": {
"type": "boolean",
"description": "Whether the field is unconditionally required on this form."
},
"required_operator": {
"type": "string",
"description": "Logical operator when evaluating multiple form_field_placement_conditions with conditioned=required",
"enum": [
"and",
"or"
]
},
"placement_operator": {
"type": "string",
"description": "Logical operator when evaluating multiple form_field_placement_conditions with conditioned=placement",
"enum": [
"and",
"or"
]
}
},
"required": [
"form_set_id",
"form"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_form_field_placement": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_field_placements"
]
},
"attributes": {
"type": "object",
"properties": {
"form_set_id": {
"type": "string",
"description": "The form set this field is placed in."
},
"form": {
"type": "string",
"description": "The form this field is placed on."
},
"position": {
"type": "integer",
"description": "The position of the field placement."
},
"required": {
"type": "boolean",
"description": "Whether the field is unconditionally required on this form."
},
"required_operator": {
"type": "string",
"description": "Logical operator when evaluating multiple form_field_placement_conditions with conditioned=required",
"enum": [
"and",
"or"
]
},
"placement_operator": {
"type": "string",
"description": "Logical operator when evaluating multiple form_field_placement_conditions with conditioned=placement",
"enum": [
"and",
"or"
]
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"form_field_placement": {
"type": "object",
"properties": {
"form_field_id": {
"type": "string",
"description": "The form field that is placed."
},
"form_set_id": {
"type": "string",
"description": "The form set this field is placed in."
},
"form": {
"type": "string",
"description": "The form this field is placed on."
},
"position": {
"type": "integer",
"description": "The position of the field placement."
},
"required": {
"type": "boolean",
"description": "Whether the field is unconditionally required on this form."
},
"required_operator": {
"type": "string",
"description": "Logical operator when evaluating multiple form_field_placement_conditions with conditioned=required",
"enum": [
"and",
"or"
]
},
"placement_operator": {
"type": "string",
"description": "Logical operator when evaluating multiple form_field_placement_conditions with conditioned=placement",
"enum": [
"and",
"or"
]
}
},
"required": [
"form_field_id",
"form_set_id",
"form",
"position",
"required"
]
},
"form_field_placement_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form field placement"
},
"type": {
"type": "string",
"enum": [
"form_field_placements"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_field_placement"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"form_field_placement_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form field placement"
},
"type": {
"type": "string",
"enum": [
"form_field_placements"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_field_placement"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_form_field_position": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_field_positions"
]
},
"attributes": {
"type": "object",
"properties": {
"form_field_id": {
"type": "string",
"description": "The ID of the form field."
},
"form": {
"type": "string",
"description": "The form for the position",
"enum": [
"web_new_incident_form",
"web_update_incident_form",
"web_incident_post_mortem_form",
"web_incident_mitigation_form",
"web_incident_resolution_form",
"web_incident_cancellation_form",
"web_scheduled_incident_form",
"web_update_scheduled_incident_form",
"incident_post_mortem",
"slack_new_incident_form",
"slack_update_incident_form",
"slack_update_incident_status_form",
"slack_incident_mitigation_form",
"slack_incident_resolution_form",
"slack_incident_cancellation_form",
"slack_scheduled_incident_form",
"slack_update_scheduled_incident_form"
]
},
"position": {
"type": "integer",
"description": "The position of the form_field_position"
}
},
"additionalProperties": false,
"required": [
"form_field_id",
"position",
"form"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_form_field_position": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_field_positions"
]
},
"attributes": {
"type": "object",
"properties": {
"form_field_id": {
"type": "string",
"description": "The ID of the form field."
},
"form": {
"type": "string",
"description": "The form for the position",
"enum": [
"web_new_incident_form",
"web_update_incident_form",
"web_incident_post_mortem_form",
"web_incident_mitigation_form",
"web_incident_resolution_form",
"web_incident_cancellation_form",
"web_scheduled_incident_form",
"web_update_scheduled_incident_form",
"incident_post_mortem",
"slack_new_incident_form",
"slack_update_incident_form",
"slack_update_incident_status_form",
"slack_incident_mitigation_form",
"slack_incident_resolution_form",
"slack_incident_cancellation_form",
"slack_scheduled_incident_form",
"slack_update_scheduled_incident_form"
]
},
"position": {
"type": "integer",
"description": "The position of the form_field_position"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"form_field_position": {
"type": "object",
"properties": {
"form_field_id": {
"type": "string",
"description": "The ID of the form field."
},
"form": {
"type": "string",
"description": "The form for the position",
"enum": [
"web_new_incident_form",
"web_update_incident_form",
"web_incident_post_mortem_form",
"web_incident_mitigation_form",
"web_incident_resolution_form",
"web_incident_cancellation_form",
"web_scheduled_incident_form",
"web_update_scheduled_incident_form",
"incident_post_mortem",
"slack_new_incident_form",
"slack_update_incident_form",
"slack_update_incident_status_form",
"slack_incident_mitigation_form",
"slack_incident_resolution_form",
"slack_incident_cancellation_form",
"slack_scheduled_incident_form",
"slack_update_scheduled_incident_form"
]
},
"position": {
"type": "integer",
"description": "The position of the form_field_position"
}
},
"required": [
"form_field_id",
"position",
"form"
]
},
"form_field_position_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form_field_position"
},
"type": {
"type": "string",
"enum": [
"form_field_positions"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_field_position"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"form_field_position_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form_field_position"
},
"type": {
"type": "string",
"enum": [
"form_field_positions"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_field_position"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_form_field": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_fields"
]
},
"attributes": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the form field",
"enum": [
"custom",
"title",
"summary",
"mitigation_message",
"resolution_message",
"severity",
"environments",
"types",
"services",
"causes",
"functionalities",
"teams",
"visibility",
"mark_as_test",
"mark_as_backfilled",
"labels",
"notify_emails",
"trigger_manual_workflows",
"show_ongoing_incidents",
"attach_alerts",
"mark_as_in_triage",
"in_triage_at",
"started_at",
"detected_at",
"acknowledged_at",
"mitigated_at",
"resolved_at",
"closed_at",
"manual_starting_datetime_field"
]
},
"input_kind": {
"type": "string",
"description": "The input kind of the form field",
"enum": [
"text",
"textarea",
"select",
"multi_select",
"date",
"datetime",
"number",
"checkbox",
"tags",
"rich_text"
]
},
"value_kind": {
"type": "string",
"description": "The value kind of the form field",
"enum": [
"inherit",
"group",
"service",
"functionality",
"user",
"catalog_entity"
]
},
"value_kind_catalog_id": {
"type": "string",
"description": "The ID of the catalog used when value_kind is `catalog_entity`",
"nullable": true
},
"name": {
"type": "string",
"description": "The name of the form field"
},
"description": {
"type": "string",
"description": "The description of the form field",
"nullable": true
},
"shown": {
"type": "array",
"items": {
"type": "string",
"description": "Where the form field is shown. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `incident_post_mortem`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`"
}
},
"required": {
"type": "array",
"items": {
"type": "string",
"description": "Where the form field is required. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`"
}
},
"show_on_incident_details": {
"type": "boolean",
"description": "Whether the form field is shown on the incident details panel"
},
"enabled": {
"type": "boolean",
"description": "Whether the form field is enabled"
},
"default_values": {
"type": "array",
"items": {
"type": "string",
"description": "The default values."
}
}
},
"additionalProperties": false,
"required": [
"kind",
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_form_field": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_fields"
]
},
"attributes": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the form field",
"enum": [
"custom",
"title",
"summary",
"mitigation_message",
"resolution_message",
"severity",
"environments",
"types",
"services",
"causes",
"functionalities",
"teams",
"visibility",
"mark_as_test",
"mark_as_backfilled",
"labels",
"notify_emails",
"trigger_manual_workflows",
"show_ongoing_incidents",
"attach_alerts",
"mark_as_in_triage",
"in_triage_at",
"started_at",
"detected_at",
"acknowledged_at",
"mitigated_at",
"resolved_at",
"closed_at",
"manual_starting_datetime_field"
]
},
"input_kind": {
"type": "string",
"description": "The input kind of the form field",
"enum": [
"text",
"textarea",
"select",
"multi_select",
"date",
"datetime",
"number",
"checkbox",
"tags",
"rich_text"
]
},
"value_kind": {
"type": "string",
"description": "The value kind of the form field",
"enum": [
"inherit",
"group",
"service",
"functionality",
"user",
"catalog_entity"
]
},
"value_kind_catalog_id": {
"type": "string",
"description": "The ID of the catalog used when value_kind is `catalog_entity`",
"nullable": true
},
"name": {
"type": "string",
"description": "The name of the form field"
},
"description": {
"type": "string",
"description": "The description of the form field",
"nullable": true
},
"shown": {
"type": "array",
"items": {
"type": "string",
"description": "Where the form field is shown. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `incident_post_mortem`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`"
}
},
"required": {
"type": "array",
"items": {
"type": "string",
"description": "Where the form field is required. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`"
}
},
"show_on_incident_details": {
"type": "boolean",
"description": "Whether the form field is shown on the incident details panel"
},
"enabled": {
"type": "boolean",
"description": "Whether the form field is enabled"
},
"default_values": {
"type": "array",
"items": {
"type": "string",
"description": "The default values."
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"form_field": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the form field",
"enum": [
"custom",
"title",
"summary",
"mitigation_message",
"resolution_message",
"severity",
"environments",
"types",
"services",
"causes",
"functionalities",
"teams",
"visibility",
"mark_as_test",
"mark_as_backfilled",
"labels",
"notify_emails",
"trigger_manual_workflows",
"show_ongoing_incidents",
"attach_alerts",
"mark_as_in_triage",
"in_triage_at",
"started_at",
"detected_at",
"acknowledged_at",
"mitigated_at",
"resolved_at",
"closed_at",
"manual_starting_datetime_field"
]
},
"input_kind": {
"type": "string",
"description": "The input kind of the form field",
"enum": [
"text",
"textarea",
"select",
"multi_select",
"date",
"datetime",
"number",
"checkbox",
"tags",
"rich_text"
]
},
"value_kind": {
"type": "string",
"description": "The value kind of the form field",
"enum": [
"inherit",
"group",
"service",
"functionality",
"user",
"catalog_entity"
]
},
"value_kind_catalog_id": {
"type": "string",
"description": "The ID of the catalog used when value_kind is `catalog_entity`",
"nullable": true
},
"name": {
"type": "string",
"description": "The name of the form field"
},
"slug": {
"type": "string",
"description": "The slug of the form field"
},
"description": {
"type": "string",
"description": "The description of the form field",
"nullable": true
},
"shown": {
"type": "array",
"items": {
"type": "string",
"description": "Where the form field is shown. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `incident_post_mortem`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`"
}
},
"required": {
"type": "array",
"items": {
"type": "string",
"description": "Where the form field is required. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`"
}
},
"show_on_incident_details": {
"type": "boolean",
"description": "Whether the form field is shown on the incident details panel"
},
"enabled": {
"type": "boolean",
"description": "Whether the form field is enabled"
},
"default_values": {
"type": "array",
"items": {
"type": "string",
"description": "The default values."
}
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"kind",
"input_kind",
"value_kind",
"slug",
"name",
"shown",
"required",
"default_values",
"created_at",
"updated_at"
]
},
"form_field_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form field"
},
"type": {
"type": "string",
"enum": [
"form_fields"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_field"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"form_field_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form field"
},
"type": {
"type": "string",
"enum": [
"form_fields"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_field"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_form_set_condition": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_set_conditions"
]
},
"attributes": {
"type": "object",
"properties": {
"form_field_id": {
"type": "string",
"description": "The form field this condition applies."
},
"comparison": {
"type": "string",
"description": "The condition comparison.",
"enum": [
"equal"
]
},
"values": {
"type": "array",
"description": "The values for comparison.",
"items": {
"type": "string",
"description": "The value for comparison."
}
}
},
"required": [
"form_field_id",
"comparison",
"values"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_form_set_condition": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_set_conditions"
]
},
"attributes": {
"type": "object",
"properties": {
"form_field_id": {
"type": "string",
"description": "The form field this condition applies."
},
"comparison": {
"type": "string",
"description": "The condition comparison.",
"enum": [
"equal"
]
},
"values": {
"type": "array",
"description": "The values for comparison.",
"items": {
"type": "string",
"description": "The value for comparison."
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"form_set_condition": {
"type": "object",
"properties": {
"form_set_id": {
"type": "string",
"description": "The form set this condition applies."
},
"form_field_id": {
"type": "string",
"description": "The form field this condition applies."
},
"comparison": {
"type": "string",
"description": "The condition comparison.",
"enum": [
"equal"
]
},
"values": {
"type": "array",
"description": "The values for comparison.",
"items": {
"type": "string",
"description": "The value for comparison."
}
}
},
"required": [
"form_set_id",
"form_field_id",
"comparison",
"values"
]
},
"form_set_condition_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form set condition"
},
"type": {
"type": "string",
"enum": [
"form_set_conditions"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_set_condition"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"form_set_condition_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form set condition"
},
"type": {
"type": "string",
"enum": [
"form_set_conditions"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_set_condition"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_form_set": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_sets"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the form set"
},
"forms": {
"type": "array",
"description": "The forms included in the form set. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`",
"items": {
"type": "string",
"description": "The form included in the form set. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`"
}
}
},
"additionalProperties": false,
"required": [
"name",
"forms"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_form_set": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_sets"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the form set"
},
"forms": {
"type": "array",
"description": "The forms included in the form set. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`",
"items": {
"type": "string",
"description": "The form included in the form set. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`"
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"form_set": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the form set"
},
"slug": {
"type": "string",
"description": "The slug of the form set"
},
"is_default": {
"type": "boolean",
"description": "Whether the form set is default"
},
"forms": {
"type": "array",
"description": "The forms included in the form set. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`",
"items": {
"type": "string",
"description": "The form included in the form set. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`"
}
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"slug",
"is_default",
"forms",
"created_at",
"updated_at"
]
},
"form_set_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form set"
},
"type": {
"type": "string",
"enum": [
"form_sets"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_set"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"form_set_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form set"
},
"type": {
"type": "string",
"enum": [
"form_sets"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_set"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_functionality": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"functionalities"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the functionality"
},
"description": {
"type": "string",
"description": "The description of the functionality",
"nullable": true
},
"public_description": {
"type": "string",
"description": "The public description of the functionality",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the functionality",
"items": {
"type": "string"
},
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the functionality",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the functionality",
"nullable": true
},
"backstage_id": {
"type": "string",
"description": "The Backstage entity id associated to this functionality. eg: :namespace/:kind/:entity_name",
"nullable": true
},
"external_id": {
"type": "string",
"description": "The external id associated to this functionality",
"nullable": true
},
"pagerduty_id": {
"type": "string",
"description": "The PagerDuty service id associated to this functionality",
"nullable": true
},
"opsgenie_id": {
"type": "string",
"description": "The Opsgenie service id associated to this functionality",
"nullable": true
},
"opsgenie_team_id": {
"type": "string",
"description": "The Opsgenie team id associated to this functionality",
"nullable": true
},
"cortex_id": {
"type": "string",
"description": "The Cortex group id associated to this functionality",
"nullable": true
},
"service_now_ci_sys_id": {
"type": "string",
"description": "The Service Now CI sys id associated to this functionality",
"nullable": true
},
"show_uptime": {
"type": "boolean",
"description": "Show uptime",
"nullable": true
},
"show_uptime_last_days": {
"type": "integer",
"description": "Show uptime over x days",
"enum": [
30,
60,
90
],
"nullable": true,
"default": 60
},
"environment_ids": {
"type": "array",
"description": "Environments associated with this functionality",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"description": "Services associated with this functionality",
"items": {
"type": "string"
},
"nullable": true
},
"owner_group_ids": {
"type": "array",
"description": "Owner Teams associated with this functionality",
"items": {
"type": "string"
},
"nullable": true
},
"owner_user_ids": {
"type": "array",
"description": "Owner Users associated with this functionality",
"items": {
"type": "integer"
},
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this functionality",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this functionality",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_functionality": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"functionalities"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the functionality"
},
"description": {
"type": "string",
"description": "The description of the functionality",
"nullable": true
},
"public_description": {
"type": "string",
"description": "The public description of the functionality",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the functionality",
"items": {
"type": "string"
},
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the functionality",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the functionality",
"nullable": true
},
"backstage_id": {
"type": "string",
"description": "The Backstage entity id associated to this functionality. eg: :namespace/:kind/:entity_name",
"nullable": true
},
"external_id": {
"type": "string",
"description": "The external id associated to this functionality",
"nullable": true
},
"pagerduty_id": {
"type": "string",
"description": "The PagerDuty service id associated to this functionality",
"nullable": true
},
"opsgenie_id": {
"type": "string",
"description": "The Opsgenie service id associated to this functionality",
"nullable": true
},
"opsgenie_team_id": {
"type": "string",
"description": "The Opsgenie team id associated to this functionality",
"nullable": true
},
"cortex_id": {
"type": "string",
"description": "The Cortex group id associated to this functionality",
"nullable": true
},
"service_now_ci_sys_id": {
"type": "string",
"description": "The Service Now CI sys id associated to this functionality",
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "Environments associated with this functionality",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"description": "Services associated with this functionality",
"items": {
"type": "string"
},
"nullable": true
},
"owner_group_ids": {
"type": "array",
"description": "Owner Teams associated with this functionality",
"items": {
"type": "string"
},
"nullable": true
},
"owner_user_ids": {
"type": "array",
"description": "Owner Users associated with this functionality",
"items": {
"type": "integer"
},
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this functionality",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this functionality",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"functionality": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the functionality"
},
"slug": {
"type": "string",
"description": "The slug of the functionality"
},
"description": {
"type": "string",
"description": "The description of the functionality",
"nullable": true
},
"public_description": {
"type": "string",
"description": "The public description of the functionality",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails attached to the functionality",
"items": {
"type": "string"
},
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the functionality",
"nullable": true
},
"backstage_id": {
"type": "string",
"description": "The Backstage entity id associated to this functionality. eg: :namespace/:kind/:entity_name",
"nullable": true
},
"external_id": {
"type": "string",
"description": "The external id associated to this functionality",
"nullable": true
},
"pagerduty_id": {
"type": "string",
"description": "The PagerDuty service id associated to this functionality",
"nullable": true
},
"opsgenie_id": {
"type": "string",
"description": "The Opsgenie service id associated to this functionality",
"nullable": true
},
"opsgenie_team_id": {
"type": "string",
"description": "The Opsgenie team id associated to this functionality",
"nullable": true
},
"cortex_id": {
"type": "string",
"description": "The Cortex group id associated to this functionality",
"nullable": true
},
"service_now_ci_sys_id": {
"type": "string",
"description": "The Service Now CI sys id associated to this functionality",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the functionality",
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "Environments associated with this functionality",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"description": "Services associated with this functionality",
"items": {
"type": "string"
},
"nullable": true
},
"owner_group_ids": {
"type": "array",
"description": "Owner Teams associated with this functionality",
"items": {
"type": "string"
},
"nullable": true
},
"owner_user_ids": {
"type": "array",
"description": "Owner Users associated with this functionality",
"items": {
"type": "integer"
},
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this functionality",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this functionality",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"incidents_chart_response": {
"type": "object",
"required": [
"data"
]
},
"uptime_chart_response": {
"type": "object",
"required": [
"data"
]
},
"functionality_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the functionality"
},
"type": {
"type": "string",
"enum": [
"functionalities"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/functionality"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"functionality_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the functionality"
},
"type": {
"type": "string",
"enum": [
"functionalities"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/functionality"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"add_action_item_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"add_action_item"
]
},
"attribute_to_query_by": {
"type": "string",
"description": "Attribute of the Incident to match against",
"enum": [
"jira_issue_id"
],
"nullable": true
},
"query_value": {
"type": "string",
"description": "Value that attribute_to_query_by to uses to match against",
"nullable": true
},
"incident_role_id": {
"type": "string",
"description": "The role id this action item is associated with"
},
"assigned_to_user_id": {
"type": "string",
"description": "[DEPRECATED] Use assigned_to_user attribute instead. The user id this action item is assigned to"
},
"assigned_to_user": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": " The user this action item is assigned to"
},
"priority": {
"type": "string",
"description": "The action item priority",
"enum": [
"high",
"medium",
"low"
]
},
"kind": {
"type": "string",
"description": "The action item kind"
},
"summary": {
"type": "string",
"description": "The action item summary"
},
"description": {
"type": "string",
"description": "The action item description"
},
"status": {
"type": "string",
"description": "The action item status",
"enum": [
"open",
"in_progress",
"cancelled",
"done"
]
},
"post_to_incident_timeline": {
"type": "boolean"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"summary",
"status",
"priority"
]
},
"update_action_item_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_action_item"
]
},
"query_value": {
"type": "string",
"description": "Value that attribute_to_query_by to uses to match against"
},
"attribute_to_query_by": {
"type": "string",
"description": "Attribute of the action item to match against",
"enum": [
"id",
"jira_issue_id",
"asana_task_id",
"shortcut_task_id",
"linear_issue_id",
"zendesk_ticket_id",
"motion_task_id",
"trello_card_id",
"airtable_record_id",
"shortcut_story_id",
"github_issue_id",
"gitlab_issue_id",
"freshservice_ticket_id",
"freshservice_task_id",
"clickup_task_id"
],
"default": "id"
},
"summary": {
"type": "string",
"description": "Brief description of the action item"
},
"assigned_to_user_id": {
"type": "string",
"description": "[DEPRECATED] Use assigned_to_user attribute instead. The user id this action item is assigned to"
},
"assigned_to_user": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": " The user this action item is assigned to"
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": {
"type": "string",
"description": "The action item description"
},
"priority": {
"type": "string",
"description": "The action item priority",
"enum": [
"high",
"medium",
"low"
]
},
"status": {
"type": "string",
"description": "The action item status",
"enum": [
"open",
"in_progress",
"cancelled",
"done"
]
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"post_to_incident_timeline": {
"type": "boolean"
}
},
"required": [
"query_value",
"attribute_to_query_by"
]
},
"add_role_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"add_role"
]
},
"incident_role_id": {
"type": "string",
"description": "The role id to add to the incident"
},
"assigned_to_user_id": {
"type": "string",
"description": "[DEPRECATED] Use assigned_to_user attribute instead. The user id this role is assigned to"
},
"assigned_to_user": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": " The user this role is assigned to"
}
},
"required": [
"incident_role_id"
]
},
"add_slack_bookmark_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"add_slack_bookmark"
]
},
"playbook_id": {
"type": "string",
"description": "The playbook id if bookmark is of an incident playbook"
},
"channel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"title": {
"type": "string",
"description": "The bookmark title. Required if not a playbook bookmark",
"nullable": true
},
"link": {
"type": "string",
"description": "The bookmark link. Required if not a playbook bookmark",
"nullable": true
},
"emoji": {
"type": "string",
"description": "The bookmark emoji"
}
},
"required": [
"channel"
],
"anyOf": [
{
"required": [
"title",
"link"
]
},
{
"required": [
"playbook_id"
]
}
]
},
"add_team_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"add_team"
]
},
"group_id": {
"type": "string",
"description": "The team id"
}
},
"required": [
"group_id"
]
},
"add_to_timeline_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"add_to_timeline"
]
},
"event": {
"type": "string",
"description": "The timeline event description"
},
"url": {
"type": "string",
"description": "A URL for the timeline event"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"event"
]
},
"archive_slack_channels_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"archive_slack_channels"
]
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"channels"
]
},
"attach_datadog_dashboards_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"attach_datadog_dashboards"
]
},
"dashboards": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"dashboards"
]
},
"auto_assign_role_opsgenie_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"auto_assign_role_opsgenie"
]
},
"incident_role_id": {
"type": "string",
"description": "The role id"
},
"schedule": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"incident_role_id",
"schedule"
]
},
"auto_assign_role_rootly_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"auto_assign_role_rootly"
]
},
"incident_role_id": {
"type": "string",
"description": "The role id"
},
"escalation_policy_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"service_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"user_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"group_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"schedule_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"incident_role_id"
]
},
"auto_assign_role_pagerduty_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"auto_assign_role_pagerduty"
]
},
"incident_role_id": {
"type": "string",
"description": "The role id"
},
"service": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"schedule": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"escalation_policy": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"incident_role_id"
],
"anyOf": [
{
"required": [
"schedule"
]
},
{
"required": [
"escalation_policy"
]
}
]
},
"update_pagerduty_incident_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_pagerduty_incident"
]
},
"pagerduty_incident_id": {
"type": "string",
"description": "Pagerduty incident id"
},
"title": {
"type": "string",
"description": "Title to update to"
},
"status": {
"type": "string",
"enum": [
"resolved",
"acknowledged",
"auto"
]
},
"resolution": {
"type": "string",
"description": "A message outlining the incident's resolution in PagerDuty"
},
"escalation_level": {
"type": "integer",
"description": "Escalation level of policy attached to incident",
"minimum": 1,
"maximum": 20,
"example": 1
},
"urgency": {
"type": "string",
"description": "PagerDuty incident urgency, selecting auto will let Rootly auto map our incident severity",
"enum": [
"high",
"low",
"auto"
]
},
"priority": {
"type": "string",
"description": "PagerDuty incident priority, selecting auto will let Rootly auto map our incident severity"
}
},
"required": [
"pagerduty_incident_id"
]
},
"create_pagerduty_status_update_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_pagerduty_status_update"
]
},
"pagerduty_incident_id": {
"type": "string",
"description": "PagerDuty incident id"
},
"message": {
"type": "string",
"description": "A message outlining the incident's resolution in PagerDuty"
}
},
"required": [
"pagerduty_incident_id",
"message"
]
},
"create_pagertree_alert_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_pagertree_alert"
]
},
"title": {
"type": "string",
"description": "Title of alert as text"
},
"description": {
"type": "string",
"description": "Description of alert as text"
},
"urgency": {
"type": "string",
"enum": [
"auto",
"critical",
"high",
"medium",
"low"
]
},
"severity": {
"type": "string",
"enum": [
"auto",
"SEV-1",
"SEV-2",
"SEV-3",
"SEV-4"
]
},
"teams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"incident": {
"type": "boolean",
"description": "Setting to true makes an alert a Pagertree incident"
}
}
},
"update_pagertree_alert_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_pagertree_alert"
]
},
"pagertree_alert_id": {
"type": "string",
"description": "The prefix ID of the Pagertree alert"
},
"title": {
"type": "string",
"description": "Title of alert as text"
},
"description": {
"type": "string",
"description": "Description of alert as text"
},
"urgency": {
"type": "string",
"enum": [
"auto",
"critical",
"high",
"medium",
"low"
]
},
"severity": {
"type": "string",
"enum": [
"auto",
"SEV-1",
"SEV-2",
"SEV-3",
"SEV-4"
]
},
"teams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"incident": {
"type": "boolean",
"description": "Setting to true makes an alert a Pagertree incident"
}
}
},
"auto_assign_role_victor_ops_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"auto_assign_role_victor_ops"
]
},
"incident_role_id": {
"type": "string",
"description": "The role id"
},
"team": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"incident_role_id",
"team"
]
},
"call_people_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"call_people"
]
},
"phone_numbers": {
"type": "array",
"items": {
"type": "string",
"description": "A recipient phone number",
"example": [
"14150001111"
]
}
},
"name": {
"type": "string",
"description": "The name"
},
"content": {
"type": "string",
"description": "The message to be read by text-to-voice"
}
},
"required": [
"phone_numbers",
"name",
"content"
]
},
"create_airtable_table_record_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_airtable_table_record"
]
},
"base": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"table": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"base",
"table"
]
},
"create_asana_subtask_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_asana_subtask"
]
},
"parent_task_id": {
"type": "string",
"description": "The parent task id"
},
"title": {
"type": "string",
"description": "The subtask title"
},
"notes": {
"type": "string"
},
"assign_user_email": {
"type": "string",
"description": "The assigned user's email"
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"due_date": {
"type": "string",
"description": "The due date"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"dependency_direction": {
"type": "string",
"enum": [
"blocking",
"blocked_by"
],
"default": "blocking"
},
"dependent_task_ids": {
"type": "array",
"description": "Dependent task ids. Supports liquid syntax",
"items": {
"type": "string"
},
"nullable": true
}
},
"required": [
"parent_task_id",
"title",
"completion"
]
},
"create_asana_task_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_asana_task"
]
},
"workspace": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"projects": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"title": {
"type": "string",
"description": "The task title"
},
"notes": {
"type": "string"
},
"assign_user_email": {
"type": "string",
"description": "The assigned user's email"
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"due_date": {
"type": "string",
"description": "The due date"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"dependency_direction": {
"type": "string",
"enum": [
"blocking",
"blocked_by"
],
"default": "blocking"
},
"dependent_task_ids": {
"type": "array",
"description": "Dependent task ids. Supports liquid syntax",
"items": {
"type": "string"
},
"nullable": true
}
},
"required": [
"workspace",
"projects",
"title",
"completion"
]
},
"create_confluence_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_confluence_page"
]
},
"integration": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "Specify integration id if you have more than one Confluence instance"
},
"space": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"ancestor": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"template": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"title": {
"type": "string",
"description": "The page title"
},
"content": {
"type": "string",
"description": "The page content"
},
"post_mortem_template_id": {
"type": "string",
"description": "The Retrospective template to use"
},
"mark_post_mortem_as_published": {
"type": "boolean",
"default": true
}
},
"required": [
"space",
"title"
]
},
"create_datadog_notebook_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_datadog_notebook"
]
},
"post_mortem_template_id": {
"type": "string",
"description": "Retrospective template to use when creating notebook, if desired"
},
"mark_post_mortem_as_published": {
"type": "boolean",
"default": true
},
"template": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"title": {
"type": "string",
"description": "The notebook title"
},
"kind": {
"type": "string",
"description": "The notebook kind",
"enum": [
"postmortem",
"runbook",
"investigation",
"documentation",
"report"
]
},
"content": {
"type": "string",
"description": "The notebook content"
}
},
"required": [
"title",
"kind"
]
},
"create_coda_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_coda_page"
]
},
"post_mortem_template_id": {
"type": "string",
"description": "Retrospective template to use when creating page, if desired"
},
"mark_post_mortem_as_published": {
"type": "boolean",
"default": true
},
"title": {
"type": "string",
"description": "The Coda page title"
},
"subtitle": {
"type": "string",
"description": "The Coda page subtitle"
},
"content": {
"type": "string",
"description": "The Coda page content"
},
"template": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Combined doc_id/page_id in format 'doc_id/page_id'"
},
"name": {
"type": "string"
}
}
},
"folder_id": {
"type": "string",
"description": "The Coda folder id"
}
},
"required": [
"title"
]
},
"create_dropbox_paper_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_dropbox_paper_page"
]
},
"post_mortem_template_id": {
"type": "string",
"description": "Retrospective template to use when creating page task, if desired"
},
"mark_post_mortem_as_published": {
"type": "boolean",
"default": true
},
"title": {
"type": "string",
"description": "The page task title"
},
"content": {
"type": "string",
"description": "The page content"
},
"namespace": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"parent_folder": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"title"
]
},
"create_github_issue_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_github_issue"
]
},
"title": {
"type": "string",
"description": "The issue title"
},
"body": {
"type": "string",
"description": "The issue body"
},
"repository": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"repository",
"title"
]
},
"create_gitlab_issue_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_gitlab_issue"
]
},
"issue_type": {
"type": "string",
"description": "The issue type",
"enum": [
"issue",
"incident",
"test_case",
"task"
]
},
"title": {
"type": "string",
"description": "The issue title"
},
"description": {
"type": "string",
"description": "The issue description"
},
"repository": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"labels": {
"type": "string",
"description": "The issue labels"
},
"due_date": {
"type": "string",
"description": "The due date"
}
},
"required": [
"repository",
"title"
]
},
"create_outlook_event_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_outlook_event"
]
},
"calendar": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"attendees": {
"type": "array",
"description": "Emails of attendees",
"items": {
"type": "string"
}
},
"time_zone": {
"type": "string",
"description": "A valid IANA time zone name.",
"nullable": true
},
"days_until_meeting": {
"type": "integer",
"description": "The days until meeting",
"minimum": 0,
"maximum": 31
},
"time_of_meeting": {
"type": "string",
"description": "Time of meeting in format HH:MM",
"example": "14:30"
},
"meeting_duration": {
"type": "string",
"description": "Meeting duration in format like '1 hour', '30 minutes'",
"example": "1 hour"
},
"summary": {
"type": "string",
"description": "The event summary"
},
"description": {
"type": "string",
"description": "The event description"
},
"exclude_weekends": {
"type": "boolean"
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"calendar",
"days_until_meeting",
"time_of_meeting",
"meeting_duration",
"summary",
"description"
]
},
"create_google_calendar_event_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_google_calendar_event"
]
},
"attendees": {
"type": "array",
"description": "Emails of attendees",
"items": {
"type": "string"
}
},
"time_zone": {
"type": "string",
"description": "A valid IANA time zone name.",
"nullable": true
},
"calendar_id": {
"type": "string",
"nullable": true,
"default": "primary"
},
"days_until_meeting": {
"type": "integer",
"description": "The days until meeting",
"minimum": 0,
"maximum": 31
},
"time_of_meeting": {
"type": "string",
"description": "Time of meeting in format HH:MM",
"example": "14:30"
},
"meeting_duration": {
"type": "string",
"description": "Meeting duration in format like '1 hour', '30 minutes'",
"example": "1 hour"
},
"send_updates": {
"type": "boolean",
"description": "Send an email to the attendees notifying them of the event"
},
"can_guests_modify_event": {
"type": "boolean"
},
"can_guests_see_other_guests": {
"type": "boolean"
},
"can_guests_invite_others": {
"type": "boolean"
},
"summary": {
"type": "string",
"description": "The event summary"
},
"description": {
"type": "string",
"description": "The event description"
},
"exclude_weekends": {
"type": "boolean"
},
"conference_solution_key": {
"type": "string",
"enum": [
"eventHangout",
"eventNamedHangout",
"hangoutsMeet",
"addOn"
],
"description": "Sets the video conference type attached to the meeting",
"nullable": true
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"days_until_meeting",
"time_of_meeting",
"meeting_duration",
"summary",
"description"
]
},
"update_google_docs_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_google_docs_page"
]
},
"file_id": {
"type": "string",
"description": "The Google Doc file ID"
},
"title": {
"type": "string",
"description": "The Google Doc title"
},
"content": {
"type": "string",
"description": "The Google Doc content"
},
"post_mortem_template_id": {
"type": "string",
"description": "Retrospective template to use when updating page, if desired"
},
"template_id": {
"type": "string",
"description": "The Google Doc file ID to use as a template."
}
},
"required": [
"file_id"
]
},
"update_coda_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_coda_page"
]
},
"doc_id": {
"type": "string",
"description": "The Coda doc id"
},
"page_id": {
"type": "string",
"description": "The Coda page id"
},
"title": {
"type": "string",
"description": "The Coda page title"
},
"subtitle": {
"type": "string",
"description": "The Coda page subtitle"
},
"content": {
"type": "string",
"description": "The Coda page content"
},
"template": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Combined doc_id/page_id in format 'doc_id/page_id'"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"page_id"
]
},
"update_google_calendar_event_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_google_calendar_event"
]
},
"calendar_id": {
"type": "string",
"nullable": true,
"default": "primary"
},
"event_id": {
"type": "string",
"description": "The event ID"
},
"summary": {
"type": "string",
"description": "The event summary"
},
"description": {
"type": "string",
"description": "The event description"
},
"adjustment_days": {
"type": "integer",
"description": "Days to adjust meeting by",
"minimum": 0,
"maximum": 31
},
"time_of_meeting": {
"type": "string",
"description": "Time of meeting in format HH:MM"
},
"meeting_duration": {
"type": "string",
"description": "Meeting duration in format like '1 hour', '30 minutes'",
"example": "1 hour"
},
"send_updates": {
"type": "boolean",
"description": "Send an email to the attendees notifying them of the event"
},
"can_guests_modify_event": {
"type": "boolean"
},
"can_guests_see_other_guests": {
"type": "boolean"
},
"can_guests_invite_others": {
"type": "boolean"
},
"attendees": {
"type": "array",
"description": "Emails of attendees",
"items": {
"type": "string"
}
},
"replace_attendees": {
"type": "boolean"
},
"conference_solution_key": {
"type": "string",
"enum": [
"eventHangout",
"eventNamedHangout",
"hangoutsMeet",
"addOn"
],
"description": "Sets the video conference type attached to the meeting",
"nullable": true
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"event_id"
]
},
"create_sharepoint_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_sharepoint_page"
]
},
"post_mortem_template_id": {
"type": "string",
"description": "Retrospective template to use when creating page, if desired"
},
"mark_post_mortem_as_published": {
"type": "boolean",
"default": true
},
"title": {
"type": "string",
"description": "The page title"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"drive": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"parent_folder": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"content": {
"type": "string",
"description": "The page content"
},
"template_id": {
"type": "string",
"description": "The SharePoint file ID to use as a template"
}
},
"required": [
"title",
"site",
"drive"
]
},
"create_google_docs_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_google_docs_page"
]
},
"post_mortem_template_id": {
"type": "string",
"description": "Retrospective template to use when creating page, if desired"
},
"mark_post_mortem_as_published": {
"type": "boolean",
"default": true
},
"title": {
"type": "string",
"description": "The page title"
},
"drive": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"parent_folder": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"content": {
"type": "string",
"description": "The page content"
},
"template_id": {
"type": "string",
"description": "The Google Doc file ID to use as a template"
},
"permissions": {
"type": "string",
"description": "Page permissions JSON"
}
},
"required": [
"title"
]
},
"create_google_docs_permissions_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_google_docs_permissions"
]
},
"file_id": {
"type": "string",
"description": "The Google Doc file ID"
},
"permissions": {
"type": "string",
"description": "Page permissions JSON"
},
"send_notification_email": {
"type": "boolean"
},
"email_message": {
"type": "string",
"description": "Email message notification",
"nullable": true
}
},
"required": [
"file_id",
"permissions"
]
},
"remove_google_docs_permissions_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"remove_google_docs_permissions"
]
},
"file_id": {
"type": "string",
"description": "The Google Doc file ID"
},
"attribute_to_query_by": {
"type": "string",
"enum": [
"type",
"role",
"email_address"
],
"default": "email_address"
},
"value": {
"type": "string"
}
},
"required": [
"file_id",
"attribute_to_query_by",
"value"
]
},
"create_quip_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_google_docs_page"
]
},
"post_mortem_template_id": {
"type": "string",
"description": "Retrospective template to use when creating page, if desired"
},
"title": {
"type": "string",
"description": "The page title"
},
"parent_folder_id": {
"type": "string",
"description": "The parent folder id"
},
"content": {
"type": "string",
"description": "The page content"
},
"template_id": {
"type": "string",
"description": "The Quip file ID to use as a template"
},
"mark_post_mortem_as_published": {
"type": "boolean",
"default": true
}
},
"required": [
"title"
]
},
"create_google_meeting_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_google_meeting"
]
},
"summary": {
"type": "string",
"description": "[DEPRECATED] The meeting summary",
"nullable": true
},
"description": {
"type": "string",
"description": "[DEPRECATED] The meeting description",
"nullable": true
},
"conference_solution_key": {
"type": "string",
"enum": [
"eventHangout",
"eventNamedHangout",
"hangoutsMeet",
"addOn"
],
"description": "[DEPRECATED] Sets the video conference type attached to the meeting",
"nullable": true
},
"record_meeting": {
"type": "boolean",
"description": "Rootly AI will record the meeting and automatically generate a transcript and summary from your meeting"
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"summary",
"description"
]
},
"create_go_to_meeting_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_go_to_meeting_task"
]
},
"subject": {
"type": "string",
"description": "The meeting subject"
},
"conference_call_info": {
"type": "string",
"enum": [
"ptsn",
"free",
"hyrid",
"voip"
],
"default": "voip",
"example": "voip",
"nullable": true
},
"password_required": {
"type": "boolean",
"nullable": true
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"subject"
]
},
"create_incident_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_incident"
]
},
"title": {
"type": "string",
"description": "The incident title"
},
"summary": {
"type": "string",
"description": "The incident summary"
},
"severity_id": {
"type": "string"
},
"incident_type_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"functionality_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"environment_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"private": {
"type": "boolean"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"title"
]
},
"create_incident_postmortem_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_incident_postmortem"
]
},
"incident_id": {
"type": "string",
"description": "UUID of the incident that needs a retrospective"
},
"title": {
"type": "string",
"description": "The retrospective title"
},
"status": {
"type": "string",
"nullable": true
},
"template": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "Retrospective template to use",
"nullable": true
}
},
"required": [
"incident_id",
"title"
]
},
"create_jira_issue_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_jira_issue"
]
},
"integration": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "Specify integration id if you have more than one Jira instance"
},
"title": {
"type": "string",
"description": "The issue title"
},
"description": {
"type": "string",
"description": "The issue description"
},
"labels": {
"type": "string",
"description": "The issue labels"
},
"assign_user_email": {
"type": "string",
"description": "The assigned user's email"
},
"reporter_user_email": {
"type": "string",
"description": "The reporter user's email"
},
"project_key": {
"type": "string",
"description": "The project key"
},
"due_date": {
"type": "string",
"description": "The due date"
},
"issue_type": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The issue type id and display name"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The status id and display name"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"update_payload": {
"type": "string",
"description": "Update payload. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"project_key",
"title",
"issue_type"
]
},
"create_jira_subtask_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_jira_subtask"
]
},
"integration": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "Specify integration id if you have more than one Jira instance"
},
"project_key": {
"type": "string",
"description": "The project key"
},
"parent_issue_id": {
"type": "string",
"description": "The parent issue"
},
"title": {
"type": "string",
"description": "The issue title"
},
"description": {
"type": "string",
"description": "The issue description"
},
"subtask_issue_type": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The issue type id and display name"
},
"labels": {
"type": "string",
"description": "The issue labels"
},
"due_date": {
"type": "string",
"description": "The due date"
},
"assign_user_email": {
"type": "string",
"description": "The assigned user's email"
},
"reporter_user_email": {
"type": "string",
"description": "The reporter user's email"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The status id and display name"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"update_payload": {
"type": "string",
"description": "Update payload. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"project_key",
"parent_issue_id",
"title",
"subtask_issue_type"
]
},
"create_linear_issue_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_linear_issue"
]
},
"title": {
"type": "string",
"description": "The issue title"
},
"description": {
"type": "string",
"description": "The issue description"
},
"team": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The team id and display name"
},
"state": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The state id and display name"
},
"project": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The project id and display name"
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"assign_user_email": {
"type": "string",
"description": "The assigned user's email"
}
},
"required": [
"title",
"team",
"state"
]
},
"create_linear_subtask_issue_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_linear_subtask_issue"
]
},
"parent_issue_id": {
"type": "string",
"description": "The parent issue"
},
"title": {
"type": "string",
"description": "The issue title"
},
"description": {
"type": "string",
"description": "The issue description"
},
"state": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The state id and display name"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"assign_user_email": {
"type": "string",
"description": "The assigned user's email"
}
},
"required": [
"parent_issue_id",
"title",
"state"
]
},
"create_linear_issue_comment_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_linear_issue_comment"
]
},
"issue_id": {
"type": "string",
"description": "The issue id"
},
"body": {
"type": "string",
"description": "The issue description"
}
},
"required": [
"issue_id",
"body"
]
},
"create_microsoft_teams_meeting_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_microsoft_teams_meeting"
]
},
"name": {
"type": "string",
"description": "The meeting name"
},
"subject": {
"type": "string",
"description": "The meeting subject"
},
"record_meeting": {
"type": "boolean",
"description": "Rootly AI will record the meeting and automatically generate a transcript and summary from your meeting"
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"name",
"subject"
]
},
"create_microsoft_teams_channel_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_microsoft_teams_channel"
]
},
"team": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"title": {
"type": "string",
"description": "Microsoft Team channel title"
},
"description": {
"type": "string",
"description": "Microsoft Team channel description"
},
"private": {
"type": "string",
"enum": [
"auto",
"true",
"false"
],
"default": "auto"
}
},
"required": [
"workspace",
"title"
]
},
"add_microsoft_teams_tab_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"add_microsoft_teams_tab"
]
},
"playbook_id": {
"type": "string",
"description": "The playbook id if tab is of an incident playbook"
},
"team": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"channel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"title": {
"type": "string",
"description": "The tab title. Required if not a playbook tab",
"nullable": true
},
"link": {
"type": "string",
"description": "The tab link. Required if not a playbook tab",
"nullable": true
}
},
"required": [
"team",
"channel"
],
"anyOf": [
{
"required": [
"title",
"link"
]
},
{
"required": [
"playbook_id"
]
}
]
},
"archive_microsoft_teams_channels_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"archive_microsoft_teams_channels"
]
},
"team": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"team",
"channels"
]
},
"rename_microsoft_teams_channel_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"rename_microsoft_teams_channel"
]
},
"team": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"channel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"title": {
"type": "string"
}
},
"required": [
"title",
"team",
"channel"
]
},
"invite_to_microsoft_teams_channel_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"invite_to_microsoft_teams_channel"
]
},
"team": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"channel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"emails": {
"type": "string",
"description": "Comma separated list of emails to invite"
}
},
"required": [
"channel",
"emails"
]
},
"create_notion_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_notion_page"
]
},
"title": {
"type": "string",
"description": "The Notion page title"
},
"parent_page": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The parent page id and display name"
},
"post_mortem_template_id": {
"type": "string",
"description": "Retrospective template to use when creating page task, if desired"
},
"content": {
"type": "string",
"description": "Custom page content with liquid templating support. When provided, only this content will be rendered (no default sections)"
},
"mark_post_mortem_as_published": {
"type": "boolean",
"default": true
},
"show_timeline_as_table": {
"type": "boolean"
},
"show_action_items_as_table": {
"type": "boolean"
}
},
"required": [
"parent_page",
"title"
]
},
"send_microsoft_teams_message_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"send_microsoft_teams_message"
]
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"text": {
"type": "string",
"description": "The message text"
}
},
"required": [
"text"
],
"anyOf": [
{
"required": [
"channels"
]
}
]
},
"send_microsoft_teams_blocks_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"send_microsoft_teams_blocks"
]
},
"attachments": {
"type": "string",
"description": "Support liquid markup. Needs to be a valid JSON string after liquid is parsed"
}
},
"required": [
"attachments"
],
"anyOf": [
{
"required": [
"channels"
]
}
]
},
"update_notion_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_notion_page"
]
},
"file_id": {
"type": "string",
"description": "The Notion page ID"
},
"title": {
"type": "string",
"description": "The Notion page title"
},
"post_mortem_template_id": {
"type": "string",
"description": "Retrospective template to use when creating page task, if desired"
},
"content": {
"type": "string",
"description": "Custom page content with liquid templating support. When provided, only this content will be rendered (no default sections)"
},
"show_timeline_as_table": {
"type": "boolean"
},
"show_action_items_as_table": {
"type": "boolean"
}
},
"required": [
"file_id"
]
},
"create_service_now_incident_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_service_now_incident"
]
},
"title": {
"type": "string",
"description": "The incident title"
},
"description": {
"type": "string",
"description": "The incident description"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The completion id and display name"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"title"
]
},
"create_shortcut_story_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_shortcut_story"
]
},
"title": {
"type": "string",
"description": "The incident title"
},
"kind": {
"type": "string",
"enum": [
"bug",
"chore",
"feature"
]
},
"description": {
"type": "string",
"description": "The incident description"
},
"labels": {
"type": "string",
"description": "The story labels"
},
"due_date": {
"type": "string",
"description": "The due date"
},
"archivation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The archivation id and display name"
},
"group": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The group id and display name"
},
"project": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The project id and display name"
},
"workflow_state": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The workflow state id workflow state name"
}
},
"required": [
"title",
"archivation",
"kind"
],
"anyOf": [
{
"required": [
"project"
]
},
{
"required": [
"workflow_state"
]
}
]
},
"create_shortcut_task_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_shortcut_task"
]
},
"parent_story_id": {
"type": "string",
"description": "The parent story"
},
"description": {
"type": "string",
"description": "The task description"
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The completion id and display name"
}
},
"required": [
"parent_story_id",
"description",
"completion"
]
},
"create_trello_card_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_trello_card"
]
},
"title": {
"type": "string",
"description": "The card title"
},
"description": {
"type": "string",
"description": "The card description"
},
"due_date": {
"type": "string",
"description": "The due date"
},
"board": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The board id and display name"
},
"list": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The list id and display name"
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"archivation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The archivation id and display name"
}
},
"required": [
"title",
"board",
"list"
]
},
"create_webex_meeting_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_webex_meeting"
]
},
"topic": {
"type": "string",
"description": "The meeting topic"
},
"password": {
"type": "string",
"description": "The meeting password"
},
"record_meeting": {
"type": "boolean",
"description": "Rootly AI will record the meeting and automatically generate a transcript and summary from your meeting"
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"topic"
]
},
"create_zendesk_ticket_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_zendesk_ticket"
]
},
"kind": {
"type": "string",
"enum": [
"problem",
"incident",
"question",
"task"
]
},
"subject": {
"type": "string",
"description": "The ticket subject"
},
"comment": {
"type": "string",
"description": "The ticket comment"
},
"tags": {
"type": "string",
"description": "The ticket tags"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The completion id and display name"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"ticket_payload": {
"type": "string",
"description": "Additional Zendesk ticket attributes. Will be merged into whatever was specified in this tasks current parameters. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"kind",
"subject"
]
},
"create_zendesk_jira_link_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_zendesk_jira_link"
]
},
"jira_issue_id": {
"type": "string",
"description": "Jira Issue Id."
},
"jira_issue_key": {
"type": "string",
"description": "Jira Issue Key."
},
"zendesk_ticket_id": {
"type": "string",
"description": "Zendesk Ticket Id."
}
},
"required": [
"jira_issue_id",
"jira_issue_key",
"zendesk_ticket_id"
]
},
"create_clickup_task_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_clickup_task"
]
},
"title": {
"type": "string",
"description": "The task title"
},
"description": {
"type": "string",
"description": "The task description"
},
"tags": {
"type": "string",
"description": "The task tags"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"due_date": {
"type": "string",
"description": "The due date"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"task_payload": {
"type": "string",
"description": "Additional ClickUp task attributes. Will be merged into whatever was specified in this tasks current parameters. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"title"
]
},
"create_motion_task_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_motion_task"
]
},
"workspace": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"project": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"title": {
"type": "string",
"description": "The task title"
},
"description": {
"type": "string",
"description": "The task description"
},
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"duration": {
"type": "string",
"description": "The duration. Eg. \"NONE\", \"REMINDER\", or a integer greater than 0."
},
"due_date": {
"type": "string",
"description": "The due date"
}
},
"required": [
"workspace",
"title"
]
},
"create_zoom_meeting_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_zoom_meeting"
]
},
"topic": {
"type": "string",
"description": "The meeting topic"
},
"password": {
"type": "string",
"description": "The meeting password"
},
"create_as_email": {
"type": "string",
"description": "The email to use if creating as email"
},
"alternative_hosts": {
"type": "array",
"items": {
"type": "string",
"description": "Alternative host email"
}
},
"auto_recording": {
"type": "string",
"enum": [
"none",
"local",
"cloud"
],
"default": "none"
},
"record_meeting": {
"type": "boolean",
"description": "Rootly AI will record the meeting and automatically generate a transcript and summary from your meeting"
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"topic"
]
},
"get_github_commits_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"get_github_commits"
]
},
"service_ids": {
"type": "array",
"items": {
"type": "string",
"description": "ID of service impacted by incident"
}
},
"github_repository_names": {
"type": "array",
"items": {
"type": "string"
}
},
"branch": {
"type": "string",
"description": "The branch"
},
"past_duration": {
"type": "string",
"description": "How far back to fetch commits (in format '1 minute', '30 days', '3 months', etc.)",
"example": "1 hour"
},
"services_impacted_by_incident": {
"type": "boolean"
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"branch",
"past_duration"
],
"anyOf": [
{
"required": [
"service_ids"
]
},
{
"required": [
"github_repository_names"
]
}
]
},
"get_gitlab_commits_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"get_gitlab_commits"
]
},
"service_ids": {
"type": "array",
"items": {
"type": "string",
"description": "ID of service impacted by incident"
}
},
"gitlab_repository_names": {
"type": "array",
"items": {
"type": "string"
}
},
"branch": {
"type": "string",
"description": "The branch"
},
"past_duration": {
"type": "string",
"description": "How far back to fetch commits (in format '1 minute', '30 days', '3 months', etc.)",
"example": "1 hour"
},
"services_impacted_by_incident": {
"type": "boolean"
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"branch",
"past_duration"
],
"anyOf": [
{
"required": [
"service_ids"
]
},
{
"required": [
"gitlab_repository_names"
]
}
]
},
"get_pulses_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"get_pulses"
]
},
"service_ids": {
"type": "array",
"items": {
"type": "string",
"description": "ID of service impacted by incident"
}
},
"environment_ids": {
"type": "array",
"items": {
"type": "string",
"description": "ID of environment impacted by incident"
}
},
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"refs": {
"type": "array",
"items": {
"type": "string"
}
},
"sources": {
"type": "array",
"items": {
"type": "string"
}
},
"past_duration": {
"type": "string",
"description": "How far back to fetch commits (in format '1 minute', '30 days', '3 months', etc.)",
"example": "1 hour"
},
"services_impacted_by_incident": {
"type": "boolean"
},
"environments_impacted_by_incident": {
"type": "boolean"
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"parent_message_thread_task": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "A hash where [id] is the task id of the parent task that sent a message, and [name] is the name of the parent task"
}
},
"required": [
"past_duration"
]
},
"get_alerts_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"get_alerts"
]
},
"service_ids": {
"type": "array",
"items": {
"type": "string",
"description": "ID of service impacted by incident"
}
},
"environment_ids": {
"type": "array",
"items": {
"type": "string",
"description": "ID of environment impacted by incident"
}
},
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"sources": {
"type": "array",
"items": {
"type": "string"
}
},
"past_duration": {
"type": "string",
"description": "How far back to fetch commits (in format '1 minute', '30 days', '3 months', etc.)",
"example": "1 hour"
},
"services_impacted_by_incident": {
"type": "boolean"
},
"environments_impacted_by_incident": {
"type": "boolean"
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"parent_message_thread_task": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "A hash where [id] is the task id of the parent task that sent a message, and [name] is the name of the parent task"
}
},
"required": [
"past_duration"
]
},
"http_client_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"http_client"
]
},
"headers": {
"type": "string",
"description": "JSON map of HTTP headers"
},
"params": {
"type": "string",
"description": "JSON map of HTTP query parameters"
},
"body": {
"type": "string",
"description": "HTTP body"
},
"url": {
"type": "string",
"description": "URL endpoint",
"example": "https://example.com/foo.json"
},
"event_url": {
"type": "string"
},
"event_message": {
"type": "string"
},
"method": {
"type": "string",
"description": "HTTP method",
"enum": [
"GET",
"POST",
"PATCH",
"PUT",
"DELETE",
"OPTIONS"
],
"default": "GET"
},
"succeed_on_status": {
"type": "string",
"description": "HTTP status code expected. Can be a regular expression. Eg: 200, 200|203, 20[0-3]",
"example": 200
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"url",
"succeed_on_status"
]
},
"invite_to_slack_channel_opsgenie_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"invite_to_slack_channel_opsgenie"
]
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"schedule": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"schedule",
"channels"
]
},
"invite_to_slack_channel_rootly_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"invite_to_slack_channel_rootly"
]
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"escalation_policy_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"service_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"user_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"group_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"schedule_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"channels"
]
},
"invite_to_slack_channel_pagerduty_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"invite_to_slack_channel_pagerduty"
]
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"escalation_policy": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"schedule": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"service": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"channels"
],
"anyOf": [
{
"required": [
"escalation_policy"
]
},
{
"required": [
"schedule"
]
}
]
},
"invite_to_slack_channel_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"invite_to_slack_channel"
]
},
"channel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"slack_users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"slack_user_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"slack_emails": {
"type": "string",
"description": "Comma separated list of emails to invite to the channel"
}
},
"required": [
"channel"
],
"anyOf": [
{
"required": [
"slack_users"
]
},
{
"required": [
"slack_user_groups"
]
},
{
"required": [
"slack_emails"
]
}
]
},
"invite_to_slack_channel_victor_ops_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"invite_to_slack_channel_victor_ops"
]
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"team": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"team",
"channels"
]
},
"page_opsgenie_on_call_responders_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"page_opsgenie_on_call_responders"
]
},
"title": {
"type": "string",
"description": "Incident title.",
"nullable": true
},
"message": {
"type": "string",
"description": "Message of the incident"
},
"description": {
"type": "string",
"description": "Description field of the incident that is generally used to provide a detailed information about the incident"
},
"teams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"priority": {
"type": "string",
"enum": [
"P1",
"P2",
"P3",
"P4",
"P5",
"auto"
],
"default": "P1"
}
}
},
"create_opsgenie_alert_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_opsgenie_alert"
]
},
"message": {
"type": "string",
"description": "Message of the alert"
},
"description": {
"type": "string",
"description": "Description field of the alert that is generally used to provide a detailed information about the alert"
},
"teams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"schedules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"escalations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"priority": {
"type": "string",
"enum": [
"P1",
"P2",
"P3",
"P4",
"P5",
"auto"
],
"default": "P1"
},
"details": {
"type": "string",
"description": "Details payload. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"message"
]
},
"update_opsgenie_alert_task_params": {
"type": "object",
"properties": {
"alert_id": {
"type": "string",
"description": "Opsgenie Alert ID"
},
"task_type": {
"type": "string",
"enum": [
"update_opsgenie_alert"
]
},
"message": {
"type": "string",
"description": "Message of the alert"
},
"description": {
"type": "string",
"description": "Description field of the alert that is generally used to provide a detailed information about the alert"
},
"priority": {
"type": "string",
"enum": [
"P1",
"P2",
"P3",
"P4",
"P5",
"auto"
]
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"alert_id",
"priority",
"completion"
]
},
"update_opsgenie_incident_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_opsgenie_incident"
]
},
"opsgenie_incident_id": {
"type": "string",
"description": "The Opsgenie incident ID, this can also be a Rootly incident variable ex. {{ incident.opsgenie_incident_id }}"
},
"message": {
"type": "string",
"description": "Message of the alert"
},
"description": {
"type": "string",
"description": "Description field of the alert that is generally used to provide a detailed information about the alert"
},
"status": {
"type": "string",
"enum": [
"resolve",
"open",
"close",
"auto"
]
},
"priority": {
"type": "string",
"enum": [
"P1",
"P2",
"P3",
"P4",
"P5",
"auto"
]
}
},
"required": [
"opsgenie_incident_id"
]
},
"page_rootly_on_call_responders_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"page_rootly_on_call_responders"
]
},
"escalation_policy_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"service_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"user_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"group_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"alert_urgency_id": {
"type": "string",
"description": "Alert urgency ID"
},
"summary": {
"type": "string",
"description": "Alert title"
},
"description": {
"type": "string",
"description": "Alert description"
},
"escalation_note": {
"type": "string"
}
},
"required": [
"summary"
]
},
"page_pagerduty_on_call_responders_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"page_pagerduty_on_call_responders"
]
},
"service": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"escalation_policies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"title": {
"type": "string",
"description": "Incident title.",
"nullable": true
},
"message": {
"type": "string"
},
"urgency": {
"type": "string",
"enum": [
"high",
"low",
"auto"
],
"default": "high"
},
"priority": {
"type": "string",
"description": "PagerDuty incident priority, selecting auto will let Rootly auto map our incident severity"
},
"create_new_incident_on_conflict": {
"type": "boolean",
"description": "Rootly only supports linking to a single PagerDuty incident. If this feature is disabled Rootly will add responders from any additional pages to the existing PagerDuty incident that is linked to the Rootly incident. If enabled, Rootly will create a new PagerDuty incident that is not linked to any Rootly incidents",
"default": false
}
},
"required": [
"service"
]
},
"page_victor_ops_on_call_responders_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"page_victor_ops_on_call_responders"
]
},
"escalation_policies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"title": {
"type": "string",
"description": "Alert title.",
"nullable": true
}
},
"anyOf": [
{
"required": [
"users"
]
},
{
"required": [
"escalation_policies"
]
}
]
},
"update_victor_ops_incident_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_victor_ops_incident"
]
},
"victor_ops_incident_id": {
"type": "string",
"description": "The victor_ops incident ID, this can also be a Rootly incident variable ex. {{ incident.victor_ops_incident_id }}"
},
"status": {
"type": "string",
"enum": [
"resolve",
"ack",
"auto"
]
},
"resolution_message": {
"type": "string",
"description": "Resolution message"
}
},
"required": [
"victor_ops_incident_id",
"status"
]
},
"print_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"print"
]
},
"message": {
"type": "string",
"description": "The message to print"
}
},
"required": [
"message"
]
},
"publish_incident_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"publish_incident"
]
},
"incident": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"public_title": {
"type": "string"
},
"event": {
"type": "string",
"description": "Incident event description"
},
"status": {
"type": "string",
"enum": [
"investigating",
"identified",
"monitoring",
"resolved",
"scheduled",
"in_progress",
"verifying",
"completed"
],
"default": "resolved"
},
"notify_subscribers": {
"type": "boolean",
"description": "When true notifies subscribers of the status page by email/text",
"default": false
},
"should_tweet": {
"type": "boolean",
"description": "For Statuspage.io integrated pages auto publishes a tweet for your update",
"default": false
},
"status_page_template": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"status_page_id": {
"type": "string"
},
"integration_payload": {
"type": "string",
"description": "Additional API Payload you can pass to statuspage.io for example. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"incident",
"public_title",
"status",
"status_page_id"
]
},
"redis_client_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"redis_client"
]
},
"url": {
"type": "string",
"example": "redis://redis-12345.c1.us-east-1-2.ec2.cloud.redislabs.com:12345"
},
"commands": {
"type": "string"
},
"event_url": {
"type": "string"
},
"event_message": {
"type": "string"
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"url",
"commands"
]
},
"rename_slack_channel_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"rename_slack_channel"
]
},
"channel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"title": {
"type": "string"
}
},
"required": [
"title",
"channel"
]
},
"change_slack_channel_privacy_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"rename_slack_channel"
]
},
"channel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"privacy": {
"type": "string",
"enum": [
"private",
"public"
]
}
},
"required": [
"title",
"privacy"
]
},
"run_command_heroku_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"run_command_heroku"
]
},
"command": {
"type": "string"
},
"app_name": {
"type": "string"
},
"size": {
"type": "string",
"enum": [
"standard-1X",
"standard-2X"
]
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"command",
"app_name",
"size"
]
},
"send_email_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"send_email"
]
},
"from": {
"type": "string",
"description": "The from email address. Need to use SMTP integration if different than rootly.com",
"default": "Rootly <workflows@rootly.com>"
},
"to": {
"type": "array",
"items": {
"type": "string",
"description": "To address email"
}
},
"cc": {
"type": "array",
"items": {
"type": "string",
"description": "Cc address email"
}
},
"bcc": {
"type": "array",
"items": {
"type": "string",
"description": "Bcc address email"
}
},
"subject": {
"type": "string",
"description": "The subject"
},
"preheader": {
"type": "string",
"description": "The preheader",
"nullable": true
},
"body": {
"type": "string",
"description": "The email body",
"nullable": true
},
"include_header": {
"type": "boolean"
},
"include_footer": {
"type": "boolean"
},
"custom_logo_url": {
"type": "string",
"description": "URL to your custom email logo",
"nullable": true
}
},
"required": [
"to",
"subject",
"body"
]
},
"send_dashboard_report_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"send_dashboard_report"
]
},
"dashboard_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"from": {
"type": "string",
"description": "The from email address. Need to use SMTP integration if different than rootly.com",
"default": "Rootly <workflows@rootly.com>"
},
"to": {
"type": "array",
"items": {
"type": "string",
"description": "The recipient"
}
},
"subject": {
"type": "string",
"description": "The subject"
},
"preheader": {
"type": "string",
"description": "The preheader",
"nullable": true
},
"body": {
"type": "string",
"description": "The email body",
"nullable": true
}
},
"required": [
"dashboard_ids",
"to",
"subject",
"body"
]
},
"create_slack_channel_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_slack_channel"
]
},
"workspace": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"title": {
"type": "string",
"description": "Slack channel title"
},
"private": {
"type": "string",
"enum": [
"auto",
"true",
"false"
],
"default": "auto"
}
},
"required": [
"workspace",
"title"
]
},
"send_slack_message_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"send_slack_message"
]
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"slack_users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"slack_user_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"actionables": {
"type": "array",
"items": {
"type": "string",
"enum": [
"update_summary",
"update_status",
"archive_channel",
"manage_incident_roles",
"update_incident",
"all_commands",
"leave_feedback",
"manage_form_fields",
"manage_action_items",
"view_tasks",
"add_pagerduty_responders",
"add_opsgenie_responders",
"add_victor_ops_responders",
"update_status_page",
"pause_reminder",
"snooze_reminder",
"restart_reminder",
"cancel_incident",
"delete_message"
]
}
},
"broadcast_thread_reply_to_channel": {
"type": "boolean"
},
"send_as_ephemeral": {
"type": "boolean"
},
"color": {
"type": "string",
"description": "A hex color ex. #FFFFFF"
},
"pin_to_channel": {
"type": "boolean"
},
"update_parent_message": {
"type": "boolean"
},
"thread_ts": {
"type": "string",
"description": "The thread to send the message into"
},
"parent_message_thread_task": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "A hash where [id] is the task id of the parent task that sent a message, and [name] is the name of the parent task"
},
"text": {
"type": "string",
"description": "The message text"
},
"send_only_as_threaded_message": {
"type": "boolean",
"description": "When set to true, if the parent for this threaded message cannot be found the message will be skipped."
}
},
"required": [
"text"
],
"anyOf": [
{
"required": [
"channels"
]
},
{
"required": [
"slack_users"
]
},
{
"required": [
"slack_user_groups"
]
}
]
},
"send_sms_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"send_sms"
]
},
"phone_numbers": {
"type": "array",
"items": {
"type": "string",
"description": "A recipient phone number",
"example": [
"14150001111"
]
}
},
"name": {
"type": "string",
"description": "The name"
},
"content": {
"type": "string",
"description": "The SMS message"
}
},
"required": [
"phone_numbers",
"name",
"content"
]
},
"send_whatsapp_message_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"send_whatsapp_message"
]
},
"phone_numbers": {
"type": "array",
"items": {
"type": "string",
"description": "A recipient phone number",
"example": [
"14150001111"
]
}
},
"name": {
"type": "string",
"description": "The name"
},
"content": {
"type": "string",
"description": "The WhatsApp message"
}
},
"required": [
"phone_numbers",
"name",
"content"
]
},
"snapshot_datadog_graph_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"snapshot_datadog_graph"
]
},
"dashboards": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"past_duration": {
"type": "string",
"description": "in format '1 minute', '30 days', '3 months', etc",
"example": "1 hour"
},
"metric_queries": {
"type": "array",
"items": {
"type": "string"
}
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"past_duration"
]
},
"snapshot_grafana_dashboard_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"snapshot_grafana_dashboard"
]
},
"dashboards": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"dashboards"
]
},
"snapshot_looker_look_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"snapshot_looker_look"
]
},
"dashboards": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"dashboards"
]
},
"snapshot_new_relic_graph_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"snapshot_looker_graph"
]
},
"metric_query": {
"type": "string"
},
"metric_type": {
"type": "string",
"enum": [
"APDEX",
"AREA",
"BAR",
"BASELINE",
"BILLBOARD",
"BULLET",
"EVENT_FEED",
"FUNNEL",
"HEATMAP",
"HISTOGRAM",
"LINE",
"PIE",
"SCATTER",
"STACKED_HORIZONTAL_BAR",
"TABLE",
"VERTICAL_BAR"
]
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"metric_query",
"metric_type"
]
},
"tweet_twitter_message_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"tweet_twitter_message"
]
},
"message": {
"type": "string"
}
},
"required": [
"message"
]
},
"update_airtable_table_record_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_airtable_table_record"
]
},
"base_key": {
"type": "string",
"description": "The base key"
},
"table_name": {
"type": "string",
"description": "The table name"
},
"record_id": {
"type": "string",
"description": "The record id"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"base_key",
"table_name",
"record_id"
]
},
"update_asana_task_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_asana_task"
]
},
"task_id": {
"type": "string",
"description": "The task id"
},
"title": {
"type": "string",
"description": "The task title"
},
"notes": {
"type": "string"
},
"assign_user_email": {
"type": "string",
"description": "The assigned user's email"
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"due_date": {
"type": "string",
"description": "The due date"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"dependency_direction": {
"type": "string",
"enum": [
"blocking",
"blocked_by"
],
"default": "blocking"
},
"dependent_task_ids": {
"type": "array",
"description": "Dependent task ids. Supports liquid syntax",
"items": {
"type": "string"
},
"nullable": true
}
},
"required": [
"task_id",
"completion"
]
},
"update_github_issue_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_github_issue"
]
},
"issue_id": {
"type": "string",
"description": "The issue id"
},
"title": {
"type": "string",
"description": "The issue title"
},
"body": {
"type": "string",
"description": "The issue body"
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"issue_id",
"completion"
]
},
"update_gitlab_issue_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_gitlab_issue"
]
},
"issue_id": {
"type": "string",
"description": "The issue id"
},
"issue_type": {
"type": "string",
"description": "The issue type",
"enum": [
"issue",
"incident",
"test_case",
"task"
]
},
"title": {
"type": "string",
"description": "The issue title"
},
"description": {
"type": "string",
"description": "The issue description"
},
"labels": {
"type": "string",
"description": "The issue labels"
},
"due_date": {
"type": "string",
"description": "The due date"
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"issue_id",
"completion"
]
},
"update_incident_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_incident"
]
},
"attribute_to_query_by": {
"type": "string",
"enum": [
"id",
"slug",
"sequential_id",
"pagerduty_incident_id",
"opsgenie_incident_id",
"victor_ops_incident_id",
"jira_issue_id",
"asana_task_id",
"shortcut_task_id",
"linear_issue_id",
"zendesk_ticket_id",
"motion_task_id",
"trello_card_id",
"airtable_record_id",
"shortcut_story_id",
"github_issue_id",
"gitlab_issue_id",
"freshservice_ticket_id",
"freshservice_task_id",
"clickup_task_id"
],
"default": "id"
},
"incident_id": {
"type": "string",
"description": "The incident id to update or id of any attribute on the incident"
},
"title": {
"type": "string",
"description": "The incident title",
"nullable": true
},
"summary": {
"type": "string",
"description": "The incident summary",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
},
"severity_id": {
"type": "string",
"nullable": true
},
"incident_type_ids": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"functionality_ids": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"environment_ids": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"started_at": {
"type": "string",
"nullable": true
},
"detected_at": {
"type": "string",
"nullable": true
},
"acknowledged_at": {
"type": "string",
"nullable": true
},
"mitigated_at": {
"type": "string",
"nullable": true
},
"resolved_at": {
"type": "string",
"nullable": true
},
"private": {
"type": "boolean"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"incident_id"
]
},
"update_incident_postmortem_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_incident_postmortem"
]
},
"postmortem_id": {
"type": "string",
"description": "UUID of the retrospective that needs to be updated"
},
"title": {
"type": "string",
"description": "The incident title",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
}
},
"required": [
"postmortem_id"
]
},
"update_jira_issue_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_jira_issue"
]
},
"issue_id": {
"type": "string",
"description": "The issue id"
},
"title": {
"type": "string",
"description": "The issue title"
},
"description": {
"type": "string",
"description": "The issue description"
},
"labels": {
"type": "string",
"description": "The issue labels"
},
"assign_user_email": {
"type": "string",
"description": "The assigned user's email"
},
"reporter_user_email": {
"type": "string",
"description": "The reporter user's email"
},
"project_key": {
"type": "string",
"description": "The project key"
},
"due_date": {
"type": "string",
"description": "The due date"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The status id and display name"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"update_payload": {
"type": "string",
"description": "Update payload. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"issue_id",
"project_key"
]
},
"update_linear_issue_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_linear_issue"
]
},
"issue_id": {
"type": "string",
"description": "The issue id"
},
"title": {
"type": "string",
"description": "The issue title"
},
"description": {
"type": "string",
"description": "The issue description"
},
"state": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The state id and display name"
},
"project": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The project id and display name"
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"assign_user_email": {
"type": "string",
"description": "The assigned user's email"
}
},
"required": [
"issue_id"
]
},
"update_service_now_incident_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_service_now_incident"
]
},
"incident_id": {
"type": "string",
"description": "The incident id"
},
"title": {
"type": "string",
"description": "The incident title"
},
"description": {
"type": "string",
"description": "The incident description"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The completion id and display name"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"incident_id"
]
},
"update_shortcut_story_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_shortcut_story"
]
},
"story_id": {
"type": "string",
"description": "The story id"
},
"title": {
"type": "string",
"description": "The incident title"
},
"description": {
"type": "string",
"description": "The incident description"
},
"labels": {
"type": "string",
"description": "The story labels"
},
"due_date": {
"type": "string",
"description": "The due date"
},
"archivation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The archivation id and display name"
}
},
"required": [
"story_id",
"archivation"
]
},
"update_shortcut_task_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_shortcut_task"
]
},
"task_id": {
"type": "string",
"description": "The task id"
},
"parent_story_id": {
"type": "string",
"description": "The parent story"
},
"description": {
"type": "string",
"description": "The task description"
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The completion id and display name"
}
},
"required": [
"task_id",
"parent_story_id",
"completion"
]
},
"update_slack_channel_topic_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_slack_channel_topic"
]
},
"channel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"topic": {
"type": "string"
}
},
"required": [
"channel",
"topic"
]
},
"update_status_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_status"
]
},
"status": {
"type": "string",
"enum": [
"in_triage",
"started",
"mitigated",
"resolved",
"closed",
"cancelled"
]
},
"inactivity_timeout": {
"type": "string",
"description": "In format '1 hour', '1 day', etc",
"example": "1 hour"
}
},
"required": [
"status"
]
},
"update_incident_status_timestamp_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_status"
]
},
"sub_status_id": {
"type": "string",
"description": "Sub-status to update timestamp for"
},
"assigned_at": {
"type": "string",
"description": "Timestamp of when the sub-status was assigned"
}
},
"required": [
"sub_status_id",
"assigned_at"
]
},
"update_trello_card_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_trello_card"
]
},
"card_id": {
"type": "string",
"description": "The card id"
},
"title": {
"type": "string",
"description": "The card title"
},
"description": {
"type": "string",
"description": "The card description"
},
"due_date": {
"type": "string",
"description": "The due date"
},
"board": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The board id and display name"
},
"list": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The list id and display name"
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"archivation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The archivation id and display name"
}
},
"required": [
"card_id",
"archivation"
]
},
"update_clickup_task_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_clickup_task"
]
},
"task_id": {
"type": "string",
"description": "The task id"
},
"title": {
"type": "string",
"description": "The task title"
},
"description": {
"type": "string",
"description": "The task description"
},
"tags": {
"type": "string",
"description": "The task tags"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"due_date": {
"type": "string",
"description": "The due date"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"task_payload": {
"type": "string",
"description": "Additional ClickUp task attributes. Will be merged into whatever was specified in this tasks current parameters. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"task_id"
]
},
"update_motion_task_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_motion_task"
]
},
"task_id": {
"type": "string",
"description": "The task id"
},
"title": {
"type": "string",
"description": "The task title"
},
"description": {
"type": "string",
"description": "The task description"
},
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"duration": {
"type": "string",
"description": "The duration. Eg. \"NONE\", \"REMINDER\", or a integer greater than 0."
},
"due_date": {
"type": "string",
"description": "The due date"
}
},
"required": [
"task_id"
]
},
"update_zendesk_ticket_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_zendesk_ticket"
]
},
"ticket_id": {
"type": "string",
"description": "The ticket id"
},
"subject": {
"type": "string",
"description": "The ticket subject"
},
"tags": {
"type": "string",
"description": "The ticket tags"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The completion id and display name"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"ticket_payload": {
"type": "string",
"description": "Additional Zendesk ticket attributes. Will be merged into whatever was specified in this tasks current parameters. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"ticket_id"
]
},
"update_attached_alerts_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_attached_alerts"
]
},
"status": {
"type": "string",
"enum": [
"acknowledged",
"resolved"
]
}
},
"required": [
"status"
]
},
"trigger_workflow_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"trigger_workflow"
]
},
"kind": {
"type": "string",
"enum": [
"incident",
"post_mortem",
"action_item",
"pulse",
"alert"
],
"default": "incident"
},
"attribute_to_query_by": {
"type": "string",
"enum": [
"id",
"slug",
"sequential_id",
"pagerduty_incident_id",
"opsgenie_incident_id",
"victor_ops_incident_id",
"jira_issue_id",
"asana_task_id",
"shortcut_task_id",
"linear_issue_id",
"zendesk_ticket_id",
"motion_task_id",
"trello_card_id",
"airtable_record_id",
"shortcut_story_id",
"github_issue_id",
"freshservice_ticket_id",
"freshservice_task_id",
"clickup_task_id"
],
"default": "id",
"description": "[\"(incident) kind can only match [:id, :slug, :sequential_id, :pagerduty_incident_id, :opsgenie_incident_id, :victor_ops_incident_id, :jira_issue_id, :asana_task_id, :shortcut_task_id, :linear_issue_id, :zendesk_ticket_id, :motion_task_id, :trello_card_id, :airtable_record_id, :shortcut_story_id, :github_issue_id, :freshservice_ticket_id, :freshservice_task_id, :clickup_task_id]\", \"(post_mortem) kind can only match [:id]\", \"(action_item) kind can only match [:id, :jira_issue_id, :asana_task_id, :shortcut_task_id, :linear_issue_id, :zendesk_ticket_id, :motion_task_id, :trello_card_id, :airtable_record_id, :shortcut_story_id, :github_issue_id, :freshservice_ticket_id, :freshservice_task_id, :clickup_task_id]\", \"(pulse) kind can only match [:id]\", \"(alert) kind can only match [:id]\"]"
},
"resource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"check_workflow_conditions": {
"type": "boolean"
}
},
"required": [
"kind",
"workflow",
"resource",
"attribute_to_query_by"
]
},
"send_slack_blocks_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"send_slack_blocks"
]
},
"message": {
"type": "string"
},
"blocks": {
"type": "string",
"description": "Support liquid markup. Needs to be a valid JSON string after liquid is parsed"
},
"attachments": {
"type": "string",
"description": "Support liquid markup. Needs to be a valid JSON string after liquid is parsed"
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"slack_users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"slack_user_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"broadcast_thread_reply_to_channel": {
"type": "boolean"
},
"send_as_ephemeral": {
"type": "boolean"
},
"pin_to_channel": {
"type": "boolean"
},
"thread_ts": {
"type": "string",
"description": "The thread to send the message into"
},
"update_parent_message": {
"type": "boolean"
},
"parent_message_thread_task": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "A hash where [id] is the task id of the parent task that sent a message, and [name] is the name of the parent task"
},
"send_only_as_threaded_message": {
"type": "boolean",
"description": "When set to true, if the parent for this threaded message cannot be found the message will be skipped."
}
},
"required": [
"blocks"
],
"anyOf": [
{
"required": [
"channels"
]
},
{
"required": [
"slack_users"
]
},
{
"required": [
"slack_user_groups"
]
}
]
},
"genius_create_openai_chat_completion_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"genius_openai_chat_completion"
]
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The OpenAI model. eg: gpt-4o-mini"
},
"system_prompt": {
"type": "string",
"description": "The system prompt to send to OpenAI (optional)"
},
"prompt": {
"type": "string",
"description": "The prompt to send to OpenAI"
}
},
"required": [
"model",
"prompt"
]
},
"genius_create_watsonx_chat_completion_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"genius_create_watsonx_chat_completion_task"
]
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The WatsonX model. eg: ibm/granite-3-b8b-instruct"
},
"system_prompt": {
"type": "string",
"description": "The system prompt to send to WatsonX (optional)"
},
"prompt": {
"type": "string",
"description": "The prompt to send to WatsonX"
},
"project_id": {
"type": "string"
}
},
"required": [
"project_id",
"model",
"prompt"
]
},
"genius_create_google_gemini_chat_completion_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"genius_create_google_gemini_chat_completion_task"
]
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The Gemini model. eg: gemini-2.0-flash"
},
"system_prompt": {
"type": "string",
"description": "The system prompt to send to Gemini (optional)"
},
"prompt": {
"type": "string",
"description": "The prompt to send to Gemini"
}
},
"required": [
"model",
"prompt"
]
},
"genius_create_anthropic_chat_completion_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"genius_create_anthropic_chat_completion_task"
]
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The Anthropic model. eg: claude-3-5-sonnet-20241022"
},
"system_prompt": {
"type": "string",
"description": "The system prompt to send to Anthropic (optional)"
},
"prompt": {
"type": "string",
"description": "The prompt to send to Anthropic"
}
},
"required": [
"model",
"prompt"
]
},
"new_workflow_task": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflow_tasks"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the workflow task"
},
"position": {
"type": "integer",
"description": "The position of the workflow task"
},
"skip_on_failure": {
"type": "boolean",
"description": "Skip workflow task if any failures"
},
"enabled": {
"type": "boolean",
"description": "Enable/disable workflow task",
"default": true
},
"task_params": {
"oneOf": [
{
"$ref": "#/components/schemas/add_action_item_task_params"
},
{
"$ref": "#/components/schemas/update_action_item_task_params"
},
{
"$ref": "#/components/schemas/add_role_task_params"
},
{
"$ref": "#/components/schemas/add_slack_bookmark_task_params"
},
{
"$ref": "#/components/schemas/add_team_task_params"
},
{
"$ref": "#/components/schemas/add_to_timeline_task_params"
},
{
"$ref": "#/components/schemas/archive_slack_channels_task_params"
},
{
"$ref": "#/components/schemas/attach_datadog_dashboards_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_opsgenie_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_rootly_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_pagerduty_task_params"
},
{
"$ref": "#/components/schemas/update_pagerduty_incident_task_params"
},
{
"$ref": "#/components/schemas/create_pagerduty_status_update_task_params"
},
{
"$ref": "#/components/schemas/create_pagertree_alert_task_params"
},
{
"$ref": "#/components/schemas/update_pagertree_alert_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_victor_ops_task_params"
},
{
"$ref": "#/components/schemas/call_people_task_params"
},
{
"$ref": "#/components/schemas/create_airtable_table_record_task_params"
},
{
"$ref": "#/components/schemas/create_asana_subtask_task_params"
},
{
"$ref": "#/components/schemas/create_asana_task_task_params"
},
{
"$ref": "#/components/schemas/create_confluence_page_task_params"
},
{
"$ref": "#/components/schemas/create_datadog_notebook_task_params"
},
{
"$ref": "#/components/schemas/create_coda_page_task_params"
},
{
"$ref": "#/components/schemas/create_dropbox_paper_page_task_params"
},
{
"$ref": "#/components/schemas/create_github_issue_task_params"
},
{
"$ref": "#/components/schemas/create_gitlab_issue_task_params"
},
{
"$ref": "#/components/schemas/create_outlook_event_task_params"
},
{
"$ref": "#/components/schemas/create_google_calendar_event_task_params"
},
{
"$ref": "#/components/schemas/update_google_docs_page_task_params"
},
{
"$ref": "#/components/schemas/update_coda_page_task_params"
},
{
"$ref": "#/components/schemas/update_google_calendar_event_task_params"
},
{
"$ref": "#/components/schemas/create_sharepoint_page_task_params"
},
{
"$ref": "#/components/schemas/create_google_docs_page_task_params"
},
{
"$ref": "#/components/schemas/create_google_docs_permissions_task_params"
},
{
"$ref": "#/components/schemas/remove_google_docs_permissions_task_params"
},
{
"$ref": "#/components/schemas/create_quip_page_task_params"
},
{
"$ref": "#/components/schemas/create_google_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_go_to_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_incident_task_params"
},
{
"$ref": "#/components/schemas/create_incident_postmortem_task_params"
},
{
"$ref": "#/components/schemas/create_jira_issue_task_params"
},
{
"$ref": "#/components/schemas/create_jira_subtask_task_params"
},
{
"$ref": "#/components/schemas/create_linear_issue_task_params"
},
{
"$ref": "#/components/schemas/create_linear_subtask_issue_task_params"
},
{
"$ref": "#/components/schemas/create_linear_issue_comment_task_params"
},
{
"$ref": "#/components/schemas/create_microsoft_teams_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_microsoft_teams_channel_task_params"
},
{
"$ref": "#/components/schemas/add_microsoft_teams_tab_task_params"
},
{
"$ref": "#/components/schemas/archive_microsoft_teams_channels_task_params"
},
{
"$ref": "#/components/schemas/rename_microsoft_teams_channel_task_params"
},
{
"$ref": "#/components/schemas/invite_to_microsoft_teams_channel_task_params"
},
{
"$ref": "#/components/schemas/create_notion_page_task_params"
},
{
"$ref": "#/components/schemas/send_microsoft_teams_message_task_params"
},
{
"$ref": "#/components/schemas/send_microsoft_teams_blocks_task_params"
},
{
"$ref": "#/components/schemas/update_notion_page_task_params"
},
{
"$ref": "#/components/schemas/create_service_now_incident_task_params"
},
{
"$ref": "#/components/schemas/create_shortcut_story_task_params"
},
{
"$ref": "#/components/schemas/create_shortcut_task_task_params"
},
{
"$ref": "#/components/schemas/create_trello_card_task_params"
},
{
"$ref": "#/components/schemas/create_webex_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_zendesk_ticket_task_params"
},
{
"$ref": "#/components/schemas/create_zendesk_jira_link_task_params"
},
{
"$ref": "#/components/schemas/create_clickup_task_task_params"
},
{
"$ref": "#/components/schemas/create_motion_task_task_params"
},
{
"$ref": "#/components/schemas/create_zoom_meeting_task_params"
},
{
"$ref": "#/components/schemas/get_github_commits_task_params"
},
{
"$ref": "#/components/schemas/get_gitlab_commits_task_params"
},
{
"$ref": "#/components/schemas/get_pulses_task_params"
},
{
"$ref": "#/components/schemas/get_alerts_task_params"
},
{
"$ref": "#/components/schemas/http_client_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_opsgenie_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_rootly_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_pagerduty_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_victor_ops_task_params"
},
{
"$ref": "#/components/schemas/page_opsgenie_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/create_opsgenie_alert_task_params"
},
{
"$ref": "#/components/schemas/update_opsgenie_alert_task_params"
},
{
"$ref": "#/components/schemas/update_opsgenie_incident_task_params"
},
{
"$ref": "#/components/schemas/page_rootly_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/page_pagerduty_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/page_victor_ops_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/update_victor_ops_incident_task_params"
},
{
"$ref": "#/components/schemas/print_task_params"
},
{
"$ref": "#/components/schemas/publish_incident_task_params"
},
{
"$ref": "#/components/schemas/redis_client_task_params"
},
{
"$ref": "#/components/schemas/rename_slack_channel_task_params"
},
{
"$ref": "#/components/schemas/change_slack_channel_privacy_task_params"
},
{
"$ref": "#/components/schemas/run_command_heroku_task_params"
},
{
"$ref": "#/components/schemas/send_email_task_params"
},
{
"$ref": "#/components/schemas/send_dashboard_report_task_params"
},
{
"$ref": "#/components/schemas/create_slack_channel_task_params"
},
{
"$ref": "#/components/schemas/send_slack_message_task_params"
},
{
"$ref": "#/components/schemas/send_sms_task_params"
},
{
"$ref": "#/components/schemas/send_whatsapp_message_task_params"
},
{
"$ref": "#/components/schemas/snapshot_datadog_graph_task_params"
},
{
"$ref": "#/components/schemas/snapshot_grafana_dashboard_task_params"
},
{
"$ref": "#/components/schemas/snapshot_looker_look_task_params"
},
{
"$ref": "#/components/schemas/snapshot_new_relic_graph_task_params"
},
{
"$ref": "#/components/schemas/tweet_twitter_message_task_params"
},
{
"$ref": "#/components/schemas/update_airtable_table_record_task_params"
},
{
"$ref": "#/components/schemas/update_asana_task_task_params"
},
{
"$ref": "#/components/schemas/update_github_issue_task_params"
},
{
"$ref": "#/components/schemas/update_gitlab_issue_task_params"
},
{
"$ref": "#/components/schemas/update_incident_task_params"
},
{
"$ref": "#/components/schemas/update_incident_postmortem_task_params"
},
{
"$ref": "#/components/schemas/update_jira_issue_task_params"
},
{
"$ref": "#/components/schemas/update_linear_issue_task_params"
},
{
"$ref": "#/components/schemas/update_service_now_incident_task_params"
},
{
"$ref": "#/components/schemas/update_shortcut_story_task_params"
},
{
"$ref": "#/components/schemas/update_shortcut_task_task_params"
},
{
"$ref": "#/components/schemas/update_slack_channel_topic_task_params"
},
{
"$ref": "#/components/schemas/update_status_task_params"
},
{
"$ref": "#/components/schemas/update_incident_status_timestamp_task_params"
},
{
"$ref": "#/components/schemas/update_trello_card_task_params"
},
{
"$ref": "#/components/schemas/update_clickup_task_task_params"
},
{
"$ref": "#/components/schemas/update_motion_task_task_params"
},
{
"$ref": "#/components/schemas/update_zendesk_ticket_task_params"
},
{
"$ref": "#/components/schemas/update_attached_alerts_task_params"
},
{
"$ref": "#/components/schemas/trigger_workflow_task_params"
},
{
"$ref": "#/components/schemas/send_slack_blocks_task_params"
},
{
"$ref": "#/components/schemas/genius_create_openai_chat_completion_task_params"
},
{
"$ref": "#/components/schemas/genius_create_watsonx_chat_completion_task_params"
},
{
"$ref": "#/components/schemas/genius_create_google_gemini_chat_completion_task_params"
},
{
"$ref": "#/components/schemas/genius_create_anthropic_chat_completion_task_params"
}
]
}
},
"required": [
"task_params"
],
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_workflow_task": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflow_tasks"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the workflow task"
},
"position": {
"type": "integer",
"description": "The position of the workflow task"
},
"skip_on_failure": {
"type": "boolean",
"description": "Skip workflow task if any failures"
},
"enabled": {
"type": "boolean",
"description": "Enable/disable workflow task",
"default": true
},
"task_params": {
"anyOf": [
{
"$ref": "#/components/schemas/add_action_item_task_params"
},
{
"$ref": "#/components/schemas/update_action_item_task_params"
},
{
"$ref": "#/components/schemas/add_role_task_params"
},
{
"$ref": "#/components/schemas/add_slack_bookmark_task_params"
},
{
"$ref": "#/components/schemas/add_team_task_params"
},
{
"$ref": "#/components/schemas/add_to_timeline_task_params"
},
{
"$ref": "#/components/schemas/archive_slack_channels_task_params"
},
{
"$ref": "#/components/schemas/attach_datadog_dashboards_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_opsgenie_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_rootly_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_pagerduty_task_params"
},
{
"$ref": "#/components/schemas/update_pagerduty_incident_task_params"
},
{
"$ref": "#/components/schemas/create_pagerduty_status_update_task_params"
},
{
"$ref": "#/components/schemas/create_pagertree_alert_task_params"
},
{
"$ref": "#/components/schemas/update_pagertree_alert_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_victor_ops_task_params"
},
{
"$ref": "#/components/schemas/call_people_task_params"
},
{
"$ref": "#/components/schemas/create_airtable_table_record_task_params"
},
{
"$ref": "#/components/schemas/create_asana_subtask_task_params"
},
{
"$ref": "#/components/schemas/create_asana_task_task_params"
},
{
"$ref": "#/components/schemas/create_confluence_page_task_params"
},
{
"$ref": "#/components/schemas/create_datadog_notebook_task_params"
},
{
"$ref": "#/components/schemas/create_coda_page_task_params"
},
{
"$ref": "#/components/schemas/create_dropbox_paper_page_task_params"
},
{
"$ref": "#/components/schemas/create_github_issue_task_params"
},
{
"$ref": "#/components/schemas/create_gitlab_issue_task_params"
},
{
"$ref": "#/components/schemas/create_outlook_event_task_params"
},
{
"$ref": "#/components/schemas/create_google_calendar_event_task_params"
},
{
"$ref": "#/components/schemas/update_google_docs_page_task_params"
},
{
"$ref": "#/components/schemas/update_coda_page_task_params"
},
{
"$ref": "#/components/schemas/update_google_calendar_event_task_params"
},
{
"$ref": "#/components/schemas/create_sharepoint_page_task_params"
},
{
"$ref": "#/components/schemas/create_google_docs_page_task_params"
},
{
"$ref": "#/components/schemas/create_google_docs_permissions_task_params"
},
{
"$ref": "#/components/schemas/remove_google_docs_permissions_task_params"
},
{
"$ref": "#/components/schemas/create_quip_page_task_params"
},
{
"$ref": "#/components/schemas/create_google_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_go_to_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_incident_task_params"
},
{
"$ref": "#/components/schemas/create_incident_postmortem_task_params"
},
{
"$ref": "#/components/schemas/create_jira_issue_task_params"
},
{
"$ref": "#/components/schemas/create_jira_subtask_task_params"
},
{
"$ref": "#/components/schemas/create_linear_issue_task_params"
},
{
"$ref": "#/components/schemas/create_linear_subtask_issue_task_params"
},
{
"$ref": "#/components/schemas/create_linear_issue_comment_task_params"
},
{
"$ref": "#/components/schemas/create_microsoft_teams_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_microsoft_teams_channel_task_params"
},
{
"$ref": "#/components/schemas/add_microsoft_teams_tab_task_params"
},
{
"$ref": "#/components/schemas/archive_microsoft_teams_channels_task_params"
},
{
"$ref": "#/components/schemas/rename_microsoft_teams_channel_task_params"
},
{
"$ref": "#/components/schemas/invite_to_microsoft_teams_channel_task_params"
},
{
"$ref": "#/components/schemas/create_notion_page_task_params"
},
{
"$ref": "#/components/schemas/send_microsoft_teams_message_task_params"
},
{
"$ref": "#/components/schemas/send_microsoft_teams_blocks_task_params"
},
{
"$ref": "#/components/schemas/update_notion_page_task_params"
},
{
"$ref": "#/components/schemas/create_service_now_incident_task_params"
},
{
"$ref": "#/components/schemas/create_shortcut_story_task_params"
},
{
"$ref": "#/components/schemas/create_shortcut_task_task_params"
},
{
"$ref": "#/components/schemas/create_trello_card_task_params"
},
{
"$ref": "#/components/schemas/create_webex_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_zendesk_ticket_task_params"
},
{
"$ref": "#/components/schemas/create_zendesk_jira_link_task_params"
},
{
"$ref": "#/components/schemas/create_clickup_task_task_params"
},
{
"$ref": "#/components/schemas/create_motion_task_task_params"
},
{
"$ref": "#/components/schemas/create_zoom_meeting_task_params"
},
{
"$ref": "#/components/schemas/get_github_commits_task_params"
},
{
"$ref": "#/components/schemas/get_gitlab_commits_task_params"
},
{
"$ref": "#/components/schemas/get_pulses_task_params"
},
{
"$ref": "#/components/schemas/get_alerts_task_params"
},
{
"$ref": "#/components/schemas/http_client_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_opsgenie_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_rootly_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_pagerduty_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_victor_ops_task_params"
},
{
"$ref": "#/components/schemas/page_opsgenie_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/create_opsgenie_alert_task_params"
},
{
"$ref": "#/components/schemas/update_opsgenie_alert_task_params"
},
{
"$ref": "#/components/schemas/update_opsgenie_incident_task_params"
},
{
"$ref": "#/components/schemas/page_rootly_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/page_pagerduty_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/page_victor_ops_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/update_victor_ops_incident_task_params"
},
{
"$ref": "#/components/schemas/print_task_params"
},
{
"$ref": "#/components/schemas/publish_incident_task_params"
},
{
"$ref": "#/components/schemas/redis_client_task_params"
},
{
"$ref": "#/components/schemas/rename_slack_channel_task_params"
},
{
"$ref": "#/components/schemas/change_slack_channel_privacy_task_params"
},
{
"$ref": "#/components/schemas/run_command_heroku_task_params"
},
{
"$ref": "#/components/schemas/send_email_task_params"
},
{
"$ref": "#/components/schemas/send_dashboard_report_task_params"
},
{
"$ref": "#/components/schemas/create_slack_channel_task_params"
},
{
"$ref": "#/components/schemas/send_slack_message_task_params"
},
{
"$ref": "#/components/schemas/send_sms_task_params"
},
{
"$ref": "#/components/schemas/send_whatsapp_message_task_params"
},
{
"$ref": "#/components/schemas/snapshot_datadog_graph_task_params"
},
{
"$ref": "#/components/schemas/snapshot_grafana_dashboard_task_params"
},
{
"$ref": "#/components/schemas/snapshot_looker_look_task_params"
},
{
"$ref": "#/components/schemas/snapshot_new_relic_graph_task_params"
},
{
"$ref": "#/components/schemas/tweet_twitter_message_task_params"
},
{
"$ref": "#/components/schemas/update_airtable_table_record_task_params"
},
{
"$ref": "#/components/schemas/update_asana_task_task_params"
},
{
"$ref": "#/components/schemas/update_github_issue_task_params"
},
{
"$ref": "#/components/schemas/update_gitlab_issue_task_params"
},
{
"$ref": "#/components/schemas/update_incident_task_params"
},
{
"$ref": "#/components/schemas/update_incident_postmortem_task_params"
},
{
"$ref": "#/components/schemas/update_jira_issue_task_params"
},
{
"$ref": "#/components/schemas/update_linear_issue_task_params"
},
{
"$ref": "#/components/schemas/update_service_now_incident_task_params"
},
{
"$ref": "#/components/schemas/update_shortcut_story_task_params"
},
{
"$ref": "#/components/schemas/update_shortcut_task_task_params"
},
{
"$ref": "#/components/schemas/update_slack_channel_topic_task_params"
},
{
"$ref": "#/components/schemas/update_status_task_params"
},
{
"$ref": "#/components/schemas/update_incident_status_timestamp_task_params"
},
{
"$ref": "#/components/schemas/update_trello_card_task_params"
},
{
"$ref": "#/components/schemas/update_clickup_task_task_params"
},
{
"$ref": "#/components/schemas/update_motion_task_task_params"
},
{
"$ref": "#/components/schemas/update_zendesk_ticket_task_params"
},
{
"$ref": "#/components/schemas/update_attached_alerts_task_params"
},
{
"$ref": "#/components/schemas/trigger_workflow_task_params"
},
{
"$ref": "#/components/schemas/send_slack_blocks_task_params"
},
{
"$ref": "#/components/schemas/genius_create_openai_chat_completion_task_params"
},
{
"$ref": "#/components/schemas/genius_create_watsonx_chat_completion_task_params"
},
{
"$ref": "#/components/schemas/genius_create_google_gemini_chat_completion_task_params"
},
{
"$ref": "#/components/schemas/genius_create_anthropic_chat_completion_task_params"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"workflow_task": {
"type": "object",
"properties": {
"workflow_id": {
"type": "string",
"description": "The ID of the parent workflow"
},
"task_params": {
"oneOf": [
{
"$ref": "#/components/schemas/add_action_item_task_params"
},
{
"$ref": "#/components/schemas/update_action_item_task_params"
},
{
"$ref": "#/components/schemas/add_role_task_params"
},
{
"$ref": "#/components/schemas/add_slack_bookmark_task_params"
},
{
"$ref": "#/components/schemas/add_team_task_params"
},
{
"$ref": "#/components/schemas/add_to_timeline_task_params"
},
{
"$ref": "#/components/schemas/archive_slack_channels_task_params"
},
{
"$ref": "#/components/schemas/attach_datadog_dashboards_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_opsgenie_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_rootly_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_pagerduty_task_params"
},
{
"$ref": "#/components/schemas/update_pagerduty_incident_task_params"
},
{
"$ref": "#/components/schemas/create_pagerduty_status_update_task_params"
},
{
"$ref": "#/components/schemas/create_pagertree_alert_task_params"
},
{
"$ref": "#/components/schemas/update_pagertree_alert_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_victor_ops_task_params"
},
{
"$ref": "#/components/schemas/call_people_task_params"
},
{
"$ref": "#/components/schemas/create_airtable_table_record_task_params"
},
{
"$ref": "#/components/schemas/create_asana_subtask_task_params"
},
{
"$ref": "#/components/schemas/create_asana_task_task_params"
},
{
"$ref": "#/components/schemas/create_confluence_page_task_params"
},
{
"$ref": "#/components/schemas/create_datadog_notebook_task_params"
},
{
"$ref": "#/components/schemas/create_coda_page_task_params"
},
{
"$ref": "#/components/schemas/create_dropbox_paper_page_task_params"
},
{
"$ref": "#/components/schemas/create_github_issue_task_params"
},
{
"$ref": "#/components/schemas/create_gitlab_issue_task_params"
},
{
"$ref": "#/components/schemas/create_outlook_event_task_params"
},
{
"$ref": "#/components/schemas/create_google_calendar_event_task_params"
},
{
"$ref": "#/components/schemas/update_google_docs_page_task_params"
},
{
"$ref": "#/components/schemas/update_coda_page_task_params"
},
{
"$ref": "#/components/schemas/update_google_calendar_event_task_params"
},
{
"$ref": "#/components/schemas/create_sharepoint_page_task_params"
},
{
"$ref": "#/components/schemas/create_google_docs_page_task_params"
},
{
"$ref": "#/components/schemas/create_google_docs_permissions_task_params"
},
{
"$ref": "#/components/schemas/remove_google_docs_permissions_task_params"
},
{
"$ref": "#/components/schemas/create_quip_page_task_params"
},
{
"$ref": "#/components/schemas/create_google_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_go_to_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_incident_task_params"
},
{
"$ref": "#/components/schemas/create_incident_postmortem_task_params"
},
{
"$ref": "#/components/schemas/create_jira_issue_task_params"
},
{
"$ref": "#/components/schemas/create_jira_subtask_task_params"
},
{
"$ref": "#/components/schemas/create_linear_issue_task_params"
},
{
"$ref": "#/components/schemas/create_linear_subtask_issue_task_params"
},
{
"$ref": "#/components/schemas/create_linear_issue_comment_task_params"
},
{
"$ref": "#/components/schemas/create_microsoft_teams_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_microsoft_teams_channel_task_params"
},
{
"$ref": "#/components/schemas/add_microsoft_teams_tab_task_params"
},
{
"$ref": "#/components/schemas/archive_microsoft_teams_channels_task_params"
},
{
"$ref": "#/components/schemas/rename_microsoft_teams_channel_task_params"
},
{
"$ref": "#/components/schemas/invite_to_microsoft_teams_channel_task_params"
},
{
"$ref": "#/components/schemas/create_notion_page_task_params"
},
{
"$ref": "#/components/schemas/send_microsoft_teams_message_task_params"
},
{
"$ref": "#/components/schemas/send_microsoft_teams_blocks_task_params"
},
{
"$ref": "#/components/schemas/update_notion_page_task_params"
},
{
"$ref": "#/components/schemas/create_service_now_incident_task_params"
},
{
"$ref": "#/components/schemas/create_shortcut_story_task_params"
},
{
"$ref": "#/components/schemas/create_shortcut_task_task_params"
},
{
"$ref": "#/components/schemas/create_trello_card_task_params"
},
{
"$ref": "#/components/schemas/create_webex_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_zendesk_ticket_task_params"
},
{
"$ref": "#/components/schemas/create_zendesk_jira_link_task_params"
},
{
"$ref": "#/components/schemas/create_clickup_task_task_params"
},
{
"$ref": "#/components/schemas/create_motion_task_task_params"
},
{
"$ref": "#/components/schemas/create_zoom_meeting_task_params"
},
{
"$ref": "#/components/schemas/get_github_commits_task_params"
},
{
"$ref": "#/components/schemas/get_gitlab_commits_task_params"
},
{
"$ref": "#/components/schemas/get_pulses_task_params"
},
{
"$ref": "#/components/schemas/get_alerts_task_params"
},
{
"$ref": "#/components/schemas/http_client_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_opsgenie_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_rootly_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_pagerduty_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_victor_ops_task_params"
},
{
"$ref": "#/components/schemas/page_opsgenie_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/create_opsgenie_alert_task_params"
},
{
"$ref": "#/components/schemas/update_opsgenie_alert_task_params"
},
{
"$ref": "#/components/schemas/update_opsgenie_incident_task_params"
},
{
"$ref": "#/components/schemas/page_rootly_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/page_pagerduty_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/page_victor_ops_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/update_victor_ops_incident_task_params"
},
{
"$ref": "#/components/schemas/print_task_params"
},
{
"$ref": "#/components/schemas/publish_incident_task_params"
},
{
"$ref": "#/components/schemas/redis_client_task_params"
},
{
"$ref": "#/components/schemas/rename_slack_channel_task_params"
},
{
"$ref": "#/components/schemas/change_slack_channel_privacy_task_params"
},
{
"$ref": "#/components/schemas/run_command_heroku_task_params"
},
{
"$ref": "#/components/schemas/send_email_task_params"
},
{
"$ref": "#/components/schemas/send_dashboard_report_task_params"
},
{
"$ref": "#/components/schemas/create_slack_channel_task_params"
},
{
"$ref": "#/components/schemas/send_slack_message_task_params"
},
{
"$ref": "#/components/schemas/send_sms_task_params"
},
{
"$ref": "#/components/schemas/send_whatsapp_message_task_params"
},
{
"$ref": "#/components/schemas/snapshot_datadog_graph_task_params"
},
{
"$ref": "#/components/schemas/snapshot_grafana_dashboard_task_params"
},
{
"$ref": "#/components/schemas/snapshot_looker_look_task_params"
},
{
"$ref": "#/components/schemas/snapshot_new_relic_graph_task_params"
},
{
"$ref": "#/components/schemas/tweet_twitter_message_task_params"
},
{
"$ref": "#/components/schemas/update_airtable_table_record_task_params"
},
{
"$ref": "#/components/schemas/update_asana_task_task_params"
},
{
"$ref": "#/components/schemas/update_github_issue_task_params"
},
{
"$ref": "#/components/schemas/update_gitlab_issue_task_params"
},
{
"$ref": "#/components/schemas/update_incident_task_params"
},
{
"$ref": "#/components/schemas/update_incident_postmortem_task_params"
},
{
"$ref": "#/components/schemas/update_jira_issue_task_params"
},
{
"$ref": "#/components/schemas/update_linear_issue_task_params"
},
{
"$ref": "#/components/schemas/update_service_now_incident_task_params"
},
{
"$ref": "#/components/schemas/update_shortcut_story_task_params"
},
{
"$ref": "#/components/schemas/update_shortcut_task_task_params"
},
{
"$ref": "#/components/schemas/update_slack_channel_topic_task_params"
},
{
"$ref": "#/components/schemas/update_status_task_params"
},
{
"$ref": "#/components/schemas/update_incident_status_timestamp_task_params"
},
{
"$ref": "#/components/schemas/update_trello_card_task_params"
},
{
"$ref": "#/components/schemas/update_clickup_task_task_params"
},
{
"$ref": "#/components/schemas/update_motion_task_task_params"
},
{
"$ref": "#/components/schemas/update_zendesk_ticket_task_params"
},
{
"$ref": "#/components/schemas/update_attached_alerts_task_params"
},
{
"$ref": "#/components/schemas/trigger_workflow_task_params"
},
{
"$ref": "#/components/schemas/send_slack_blocks_task_params"
},
{
"$ref": "#/components/schemas/genius_create_openai_chat_completion_task_params"
},
{
"$ref": "#/components/schemas/genius_create_watsonx_chat_completion_task_params"
},
{
"$ref": "#/components/schemas/genius_create_google_gemini_chat_completion_task_params"
},
{
"$ref": "#/components/schemas/genius_create_anthropic_chat_completion_task_params"
}
]
},
"name": {
"type": "string",
"description": "Name of the workflow task"
},
"position": {
"type": "integer",
"description": "The position of the workflow task"
},
"skip_on_failure": {
"type": "boolean",
"description": "Skip workflow task if any failures"
},
"enabled": {
"type": "boolean",
"description": "Enable/disable workflow task",
"default": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"workflow_id",
"task_params",
"position",
"skip_on_failure",
"enabled",
"created_at",
"updated_at"
]
},
"workflow_task_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow task"
},
"type": {
"type": "string",
"enum": [
"workflow_tasks"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow_task"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"workflow_task_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow task"
},
"type": {
"type": "string",
"enum": [
"workflow_tasks"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow_task"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_workflow_custom_field_selection": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflow_custom_field_selections"
]
},
"attributes": {
"type": "object",
"properties": {
"workflow_id": {
"type": "string",
"description": "The workflow for this selection"
},
"custom_field_id": {
"type": "integer",
"description": "The custom field for this selection"
},
"incident_condition": {
"type": "string",
"description": "The trigger condition",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"values": {
"type": "array",
"items": {
"type": "string",
"description": "The value to associate with the custom field trigger"
}
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected option id for select and multi_select kinds"
}
}
},
"additionalProperties": false,
"required": [
"incident_condition",
"custom_field_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_workflow_custom_field_selection": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflow_custom_field_selections"
]
},
"attributes": {
"type": "object",
"properties": {
"incident_condition": {
"type": "string",
"description": "The trigger condition",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"values": {
"type": "array",
"items": {
"type": "string",
"description": "The value to associate with the custom field trigger"
}
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected option id for select and multi_select kinds"
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"workflow_custom_field_selection": {
"type": "object",
"properties": {
"workflow_id": {
"type": "string",
"description": "The workflow for this selection"
},
"custom_field_id": {
"type": "integer",
"description": "The custom field for this selection"
},
"incident_condition": {
"type": "string",
"description": "The trigger condition",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"values": {
"type": "array",
"items": {
"type": "string",
"description": "The value to associate with the custom field trigger"
}
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected option id for select and multi_select kinds"
}
}
},
"required": [
"workflow_id",
"custom_field_id",
"incident_condition",
"selected_option_ids"
]
},
"workflow_custom_field_selection_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow_custom_field_selection"
},
"type": {
"type": "string",
"enum": [
"workflow_custom_field_selections"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow_custom_field_selection"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"workflow_custom_field_selection_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow_custom_field_selection"
},
"type": {
"type": "string",
"enum": [
"workflow_custom_field_selections"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow_custom_field_selection"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_workflow_form_field_condition": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflow_form_field_conditions"
]
},
"attributes": {
"type": "object",
"properties": {
"workflow_id": {
"type": "string",
"description": "The workflow for this condition"
},
"form_field_id": {
"type": "string",
"description": "The custom field for this condition"
},
"incident_condition": {
"type": "string",
"description": "The trigger condition",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"values": {
"type": "array",
"items": {
"type": "string",
"description": "The value to associate with the custom field trigger"
}
},
"selected_catalog_entity_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected catalog entities for select and multi_select kinds"
}
},
"selected_functionality_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected functionalities for select and multi_select kinds"
}
},
"selected_group_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected groups (teams) for select and multi_select kinds"
}
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected option id for select and multi_select kinds"
}
},
"selected_service_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected services for select and multi_select kinds"
}
},
"selected_user_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected user id for select and multi_select kinds"
}
}
},
"additionalProperties": false,
"required": [
"incident_condition",
"form_field_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_workflow_form_field_condition": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflow_form_field_conditions"
]
},
"attributes": {
"type": "object",
"properties": {
"incident_condition": {
"type": "string",
"description": "The trigger condition",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"values": {
"type": "array",
"items": {
"type": "string",
"description": "The value to associate with the custom field trigger"
}
},
"selected_catalog_entity_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected catalog entities for select and multi_select kinds"
}
},
"selected_functionality_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected functionalities for select and multi_select kinds"
}
},
"selected_group_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected groups (teams) for select and multi_select kinds"
}
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected option id for select and multi_select kinds"
}
},
"selected_service_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected services for select and multi_select kinds"
}
},
"selected_user_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected user id for select and multi_select kinds"
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"workflow_form_field_condition": {
"type": "object",
"properties": {
"workflow_id": {
"type": "string",
"description": "The workflow for this condition"
},
"form_field_id": {
"type": "string",
"description": "The custom field for this condition"
},
"incident_condition": {
"type": "string",
"description": "The trigger condition",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"values": {
"type": "array",
"items": {
"type": "string",
"description": "The value to associate with the custom field trigger"
}
},
"selected_catalog_entity_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected catalog entities for select and multi_select kinds"
}
},
"selected_functionality_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected functionalities for select and multi_select kinds"
}
},
"selected_group_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected groups (teams) for select and multi_select kinds"
}
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected option id for select and multi_select kinds"
}
},
"selected_service_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected services for select and multi_select kinds"
}
},
"selected_user_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected user id for select and multi_select kinds"
}
}
},
"required": [
"workflow_id",
"form_field_id",
"incident_condition",
"selected_catalog_entity_ids",
"selected_option_ids",
"selected_user_ids"
]
},
"workflow_form_field_condition_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow_form_field_condition"
},
"type": {
"type": "string",
"enum": [
"workflow_form_field_conditions"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow_form_field_condition"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"workflow_form_field_condition_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow_form_field_condition"
},
"type": {
"type": "string",
"enum": [
"workflow_form_field_conditions"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow_form_field_condition"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_workflow_group": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflow_groups"
]
},
"attributes": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the workflow group",
"enum": [
"simple",
"incident",
"post_mortem",
"action_item",
"pulse",
"alert"
],
"nullable": true
},
"name": {
"type": "string",
"description": "The name of the workflow group."
},
"description": {
"type": "string",
"description": "A description of the workflow group.",
"nullable": true
},
"icon": {
"type": "string",
"description": "An emoji icon displayed next to the workflow group."
},
"expanded": {
"type": "boolean",
"description": "Whether the group is expanded or collapsed."
},
"position": {
"type": "integer",
"description": "The position of the workflow group"
}
},
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_workflow_group": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflow_groups"
]
},
"attributes": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the workflow group",
"enum": [
"simple",
"incident",
"post_mortem",
"action_item",
"pulse",
"alert"
],
"nullable": true
},
"name": {
"type": "string",
"description": "The name of the workflow group."
},
"description": {
"type": "string",
"description": "A description of the workflow group.",
"nullable": true
},
"icon": {
"type": "string",
"description": "An emoji icon displayed next to the workflow group."
},
"expanded": {
"type": "boolean",
"description": "Whether the group is expanded or collapsed."
},
"position": {
"type": "integer",
"description": "The position of the workflow group"
}
}
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"workflow_group": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the workflow group",
"enum": [
"simple",
"incident",
"post_mortem",
"action_item",
"pulse",
"alert"
],
"nullable": true
},
"name": {
"type": "string",
"description": "The name of the workflow group."
},
"slug": {
"type": "string",
"description": "The slug of the workflow group."
},
"description": {
"type": "string",
"description": "A description of the workflow group.",
"nullable": true
},
"icon": {
"type": "string",
"description": "An emoji icon displayed next to the workflow group."
},
"expanded": {
"type": "boolean",
"description": "Whether the group is expanded or collapsed."
},
"position": {
"type": "integer",
"description": "The position of the workflow group"
}
},
"required": [
"name",
"position"
]
},
"workflow_group_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow group"
},
"type": {
"type": "string",
"enum": [
"workflow_groups"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow_group"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"workflow_group_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow group"
},
"type": {
"type": "string",
"enum": [
"workflow_groups"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow_group"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_workflow_run": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflow_runs"
]
},
"attributes": {
"type": "object",
"anyOf": [
{
"properties": {
"immediate": {
"type": "boolean",
"nullable": true,
"default": true,
"description": "If false, this will respect wait time configured on the workflow."
},
"check_conditions": {
"type": "boolean",
"nullable": true,
"default": false,
"description": "If true, this will check conditions. If conditions are not satisfied the run will not be created."
},
"context": {
"type": "object",
"additionalProperties": true
}
}
},
{
"properties": {
"incident_id": {
"type": "string"
},
"immediate": {
"type": "boolean",
"nullable": true,
"default": true,
"description": "If false, this will respect wait time configured on the workflow"
},
"check_conditions": {
"type": "boolean",
"nullable": true,
"default": false,
"description": "If true, this will check conditions. If conditions are not satisfied the run will not be created"
},
"context": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"incident_id"
]
},
{
"properties": {
"post_mortem_id": {
"type": "string"
},
"immediate": {
"type": "boolean",
"nullable": true,
"default": true,
"description": "If false, this will respect wait time configured on the workflow"
},
"check_conditions": {
"type": "boolean",
"nullable": true,
"default": false,
"description": "If true, this will check conditions. If conditions are not satisfied the run will not be created"
},
"context": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"post_mortem_id"
]
},
{
"properties": {
"action_item_id": {
"type": "string"
},
"immediate": {
"type": "boolean",
"nullable": true,
"default": true,
"description": "If false, this will respect wait time configured on the workflow"
},
"check_conditions": {
"type": "boolean",
"nullable": true,
"default": false,
"description": "If true, this will check conditions. If conditions are not satisfied the run will not be created"
},
"context": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"action_item_id"
]
},
{
"properties": {
"alert_id": {
"type": "string"
},
"immediate": {
"type": "boolean",
"nullable": true,
"default": true,
"description": "If false, this will respect wait time configured on the workflow"
},
"check_conditions": {
"type": "boolean",
"nullable": true,
"default": false,
"description": "If true, this will check conditions. If conditions are not satisfied the run will not be created"
},
"context": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"alert_id"
]
},
{
"properties": {
"pulse_id": {
"type": "string"
},
"immediate": {
"type": "boolean",
"nullable": true,
"default": true,
"description": "If false, this will respect wait time configured on the workflow"
},
"check_conditions": {
"type": "boolean",
"nullable": true,
"default": false,
"description": "If true, this will check conditions. If conditions are not satisfied the run will not be created"
},
"context": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"pulse_id"
]
}
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"workflow_run": {
"type": "object",
"properties": {
"workflow_id": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"queued",
"started",
"completed",
"completed_with_errors",
"failed",
"canceled"
]
},
"status_message": {
"type": "string",
"nullable": true
},
"triggered_by": {
"type": "string",
"enum": [
"system",
"user",
"workflow"
]
},
"started_at": {
"type": "string",
"nullable": true
},
"completed_at": {
"type": "string",
"nullable": true
},
"failed_at": {
"type": "string",
"nullable": true
},
"canceled_at": {
"type": "string",
"nullable": true
},
"incident_id": {
"type": "string",
"nullable": true
},
"post_mortem_id": {
"type": "string",
"nullable": true
},
"action_item_id": {
"type": "string",
"nullable": true
},
"alert_id": {
"type": "string",
"nullable": true
},
"pulse_id": {
"type": "string",
"nullable": true
},
"context": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"status",
"triggered_by",
"workflow_id"
]
},
"workflow_run_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow run"
},
"type": {
"type": "string",
"enum": [
"workflow_runs"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow_run"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"workflow_runs_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow run"
},
"type": {
"type": "string",
"enum": [
"workflow_runs"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow_run"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_workflow": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflows"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The title of the workflow"
},
"slug": {
"type": "string",
"description": "The slug of the workflow"
},
"description": {
"type": "string",
"description": "The description of the workflow",
"nullable": true
},
"command": {
"type": "string",
"description": "Workflow command",
"nullable": true
},
"command_feedback_enabled": {
"type": "boolean",
"description": "This will notify you back when the workflow is starting",
"nullable": true
},
"wait": {
"type": "string",
"description": "Wait this duration before executing",
"nullable": true
},
"priority": {
"type": "string",
"description": "Priority",
"enum": [
"low",
"normal",
"high"
],
"nullable": true
},
"repeat_every_duration": {
"type": "string",
"description": "Repeat workflow every duration",
"nullable": true
},
"repeat_condition_duration_since_first_run": {
"type": "string",
"description": "The workflow will stop repeating if its runtime since it's first workflow run exceeds the duration set in this field",
"nullable": true
},
"repeat_condition_number_of_repeats": {
"type": "integer",
"description": "The workflow will stop repeating if the number of repeats exceeds the value set in this field"
},
"continuously_repeat": {
"type": "boolean",
"description": "When continuously repeat is true, repeat workflows aren't automatically stopped when conditions aren't met. This setting won't override your conditions set by repeat_condition_duration_since_first_run and repeat_condition_number_of_repeats parameters."
},
"repeat_on": {
"type": "array",
"items": {
"type": "string",
"description": "Repeat on weekdays",
"enum": [
"S",
"M",
"T",
"W",
"R",
"F",
"U"
]
}
},
"enabled": {
"type": "boolean"
},
"locked": {
"type": "boolean",
"description": "Restricts workflow edits to admins when turned on. Only admins can set this field."
},
"position": {
"type": "integer",
"description": "The order which the workflow should run with other workflows."
},
"workflow_group_id": {
"type": "string",
"description": "The group this workflow belongs to.",
"nullable": true
},
"trigger_params": {
"oneOf": [
{
"$ref": "#/components/schemas/incident_trigger_params"
},
{
"$ref": "#/components/schemas/action_item_trigger_params"
},
{
"$ref": "#/components/schemas/alert_trigger_params"
},
{
"$ref": "#/components/schemas/pulse_trigger_params"
},
{
"$ref": "#/components/schemas/simple_trigger_params"
}
]
},
"environment_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"severity_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"incident_type_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"incident_role_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"functionality_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"cause_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"sub_status_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_trigger_params": {
"type": "object",
"properties": {
"trigger_type": {
"type": "string",
"enum": [
"incident"
]
},
"triggers": {
"type": "array",
"items": {
"type": "string",
"description": "Actions that trigger the workflow. One of custom_fields.<slug>.updated, incident_in_triage, incident_created, incident_started, incident_updated, title_updated, summary_updated, status_updated, severity_updated, environments_added, environments_removed, environments_updated, incident_types_added, incident_types_removed, incident_types_updated, services_added, services_removed, services_updated, visibility_updated, functionalities_added, functionalities_removed, functionalities_updated, teams_added, teams_removed, teams_updated, causes_added, causes_removed, causes_updated, timeline_updated, status_page_timeline_updated, role_assignments_updated, role_assignments_added, role_assignments_removed, slack_command, slack_channel_created, slack_channel_converted, microsoft_teams_channel_created, subscribers_updated, subscribers_added, subscribers_removed, user_joined_slack_channel, user_left_slack_channel"
}
},
"incident_visibilities": {
"type": "array",
"items": {
"type": "boolean"
}
},
"incident_kinds": {
"type": "array",
"items": {
"type": "string",
"enum": [
"test",
"test_sub",
"example",
"example_sub",
"normal",
"normal_sub",
"backfilled",
"scheduled"
]
}
},
"incident_statuses": {
"type": "array",
"items": {
"type": "string",
"enum": [
"in_triage",
"started",
"detected",
"acknowledged",
"mitigated",
"resolved",
"closed",
"cancelled",
"scheduled",
"in_progress",
"completed"
]
}
},
"incident_inactivity_duration": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"description": "ex. 10 min, 1h, 3 days, 2 weeks"
}
]
},
"incident_condition": {
"type": "string",
"enum": [
"ALL",
"ANY",
"NONE"
],
"default": "ALL"
},
"incident_condition_visibility": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_kind": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "IS"
},
"incident_condition_status": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_sub_status": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_environment": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_severity": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_incident_type": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_incident_roles": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_service": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_functionality": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_group": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_cause": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_post_mortem_condition_cause": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY",
"description": "[DEPRECATED] Use incident_condition_cause instead"
},
"incident_condition_summary": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"enum": [
"SET",
"UNSET"
]
}
]
},
"incident_condition_started_at": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"enum": [
"SET",
"UNSET"
]
}
]
},
"incident_condition_detected_at": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"enum": [
"SET",
"UNSET"
]
}
]
},
"incident_condition_acknowledged_at": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"enum": [
"SET",
"UNSET"
]
}
]
},
"incident_condition_mitigated_at": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"enum": [
"SET",
"UNSET"
]
}
]
},
"incident_condition_resolved_at": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"enum": [
"SET",
"UNSET"
]
}
]
},
"incident_conditional_inactivity": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"enum": [
"IS"
]
}
]
}
},
"required": [
"trigger_type"
]
},
"post_mortem_trigger_params": {
"type": "object",
"properties": {
"trigger_type": {
"type": "string",
"enum": [
"post_mortem"
]
},
"triggers": {
"type": "array",
"items": {
"type": "string",
"description": "Actions that trigger the workflow. One of custom_fields.<slug>.updated, post_mortem_created, post_mortem_updated, status_updated, slack_command"
}
},
"incident_visibilities": {
"type": "array",
"items": {
"type": "boolean"
}
},
"incident_kinds": {
"type": "array",
"items": {
"type": "string",
"enum": [
"test",
"test_sub",
"example",
"example_sub",
"normal",
"normal_sub",
"backfilled",
"scheduled"
]
}
},
"incident_statuses": {
"type": "array",
"items": {
"type": "string",
"enum": [
"in_triage",
"started",
"detected",
"acknowledged",
"mitigated",
"resolved",
"closed",
"cancelled",
"scheduled",
"in_progress",
"completed"
]
}
},
"incident_inactivity_duration": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"description": "ex. 10 min, 1h, 3 days, 2 weeks"
}
]
},
"incident_condition": {
"type": "string",
"enum": [
"ALL",
"ANY",
"NONE"
],
"default": "ALL"
},
"incident_condition_visibility": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_kind": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "IS"
},
"incident_condition_status": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_sub_status": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_environment": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_severity": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_incident_type": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_incident_roles": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_service": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_functionality": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_group": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_cause": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_post_mortem_condition_cause": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY",
"description": "[DEPRECATED] Use incident_condition_cause instead"
},
"incident_condition_summary": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"enum": [
"SET",
"UNSET"
]
}
]
},
"incident_condition_started_at": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"enum": [
"SET",
"UNSET"
]
}
]
},
"incident_condition_detected_at": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"enum": [
"SET",
"UNSET"
]
}
]
},
"incident_condition_acknowledged_at": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"enum": [
"SET",
"UNSET"
]
}
]
},
"incident_condition_mitigated_at": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"enum": [
"SET",
"UNSET"
]
}
]
},
"incident_condition_resolved_at": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"enum": [
"SET",
"UNSET"
]
}
]
},
"incident_conditional_inactivity": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"enum": [
"IS"
]
}
]
},
"incident_post_mortem_condition": {
"type": "string",
"enum": [
"ALL",
"ANY",
"NONE"
]
},
"incident_post_mortem_condition_status": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_post_mortem_statuses": {
"type": "array",
"items": {
"type": "string",
"enum": [
"draft",
"published"
]
}
}
},
"required": [
"trigger_type"
]
},
"action_item_trigger_params": {
"type": "object",
"properties": {
"trigger_type": {
"type": "string",
"enum": [
"action_item"
]
},
"triggers": {
"type": "array",
"items": {
"type": "string",
"description": "Actions that trigger the workflow. One of custom_fields.<slug>.updated, incident_updated, action_item_created, action_item_updated, assigned_user_updated, summary_updated, description_updated, status_updated, priority_updated, due_date_updated, teams_updated, slack_command"
}
},
"incident_visibilities": {
"type": "array",
"items": {
"type": "boolean"
}
},
"incident_kinds": {
"type": "array",
"items": {
"type": "string",
"enum": [
"test",
"test_sub",
"example",
"example_sub",
"normal",
"normal_sub",
"backfilled",
"scheduled"
]
}
},
"incident_statuses": {
"type": "array",
"items": {
"type": "string",
"enum": [
"in_triage",
"started",
"detected",
"acknowledged",
"mitigated",
"resolved",
"closed",
"cancelled",
"scheduled",
"in_progress",
"completed"
]
}
},
"incident_inactivity_duration": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"description": "ex. 10 min, 1h, 3 days, 2 weeks"
}
]
},
"incident_condition": {
"type": "string",
"enum": [
"ALL",
"ANY",
"NONE"
],
"default": "ALL"
},
"incident_condition_visibility": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_kind": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "IS"
},
"incident_condition_status": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_sub_status": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_environment": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_severity": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_incident_type": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_incident_roles": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_service": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_functionality": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_group": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_summary": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"enum": [
"SET",
"UNSET"
]
}
]
},
"incident_condition_started_at": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"enum": [
"SET",
"UNSET"
]
}
]
},
"incident_condition_detected_at": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"enum": [
"SET",
"UNSET"
]
}
]
},
"incident_condition_acknowledged_at": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"enum": [
"SET",
"UNSET"
]
}
]
},
"incident_condition_mitigated_at": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"enum": [
"SET",
"UNSET"
]
}
]
},
"incident_condition_resolved_at": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"enum": [
"SET",
"UNSET"
]
}
]
},
"incident_conditional_inactivity": {
"anyOf": [
{
"enum": [
null
]
},
{
"type": "string",
"enum": [
"IS"
]
}
]
},
"incident_action_item_condition": {
"type": "string",
"enum": [
"ALL",
"ANY",
"NONE"
]
},
"incident_action_item_condition_kind": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_action_item_kinds": {
"type": "array",
"items": {
"type": "string",
"enum": [
"task",
"follow_up"
]
}
},
"incident_action_item_condition_status": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_action_item_statuses": {
"type": "array",
"items": {
"type": "string",
"enum": [
"open",
"in_progress",
"cancelled",
"done"
]
}
},
"incident_action_item_condition_priority": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_action_item_priorities": {
"type": "array",
"items": {
"type": "string",
"enum": [
"high",
"medium",
"low"
]
}
},
"incident_action_item_condition_group": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_action_item_group_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"trigger_type"
]
},
"alert_trigger_params": {
"type": "object",
"properties": {
"trigger_type": {
"type": "string",
"enum": [
"alert"
]
},
"triggers": {
"type": "array",
"items": {
"type": "string",
"description": "Actions that trigger the workflow",
"enum": [
"alert_created",
"alert_status_updated"
]
}
},
"alert_condition": {
"type": "string",
"enum": [
"ALL",
"ANY",
"NONE"
]
},
"alert_condition_source": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"alert_condition_source_use_regexp": {
"type": "boolean",
"default": false
},
"alert_sources": {
"type": "array",
"items": {
"type": "string"
}
},
"alert_condition_label": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"alert_condition_label_use_regexp": {
"type": "boolean",
"default": false
},
"alert_condition_status": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"alert_condition_status_use_regexp": {
"type": "boolean",
"default": false
},
"alert_statuses": {
"type": "array",
"items": {
"type": "string"
}
},
"alert_labels": {
"type": "array",
"items": {
"type": "string"
}
},
"alert_condition_payload": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"alert_condition_payload_use_regexp": {
"type": "boolean",
"default": false
},
"alert_payload": {
"type": "array",
"items": {
"type": "string"
}
},
"alert_query_payload": {
"type": "string",
"description": "You can use jsonpath syntax. eg: $.incident.teams[*]",
"nullable": true
}
},
"required": [
"trigger_type"
]
},
"pulse_trigger_params": {
"type": "object",
"properties": {
"trigger_type": {
"type": "string",
"enum": [
"pulse"
]
},
"triggers": {
"type": "array",
"items": {
"type": "string",
"description": "Actions that trigger the workflow",
"enum": [
"pulse_created"
]
}
},
"pulse_condition": {
"type": "string",
"enum": [
"ALL",
"ANY",
"NONE"
]
},
"pulse_condition_source": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"pulse_condition_source_use_regexp": {
"type": "boolean",
"default": false
},
"pulse_sources": {
"type": "array",
"items": {
"type": "string"
}
},
"pulse_condition_label": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"pulse_condition_label_use_regexp": {
"type": "boolean",
"default": false
},
"pulse_labels": {
"type": "array",
"items": {
"type": "string"
}
},
"pulse_condition_payload": {
"type": "string",
"enum": [
"IS",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"pulse_condition_payload_use_regexp": {
"type": "boolean",
"default": false
},
"pulse_payload": {
"type": "array",
"items": {
"type": "string"
}
},
"pulse_query_payload": {
"type": "string",
"description": "You can use jsonpath syntax. eg: $.incident.teams[*]",
"nullable": true
}
},
"required": [
"trigger_type"
]
},
"simple_trigger_params": {
"type": "object",
"properties": {
"trigger_type": {
"type": "string",
"enum": [
"simple"
]
},
"triggers": {
"type": "array",
"items": {
"type": "string",
"description": "Actions that trigger the workflow",
"enum": [
"slack_command"
]
}
}
},
"required": [
"trigger_type"
]
},
"update_workflow": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflows"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The title of the workflow"
},
"slug": {
"type": "string",
"description": "The slug of the workflow"
},
"description": {
"type": "string",
"description": "The description of the workflow",
"nullable": true
},
"command": {
"type": "string",
"description": "Workflow command",
"nullable": true
},
"command_feedback_enabled": {
"type": "boolean",
"description": "This will notify you back when the workflow is starting",
"nullable": true
},
"wait": {
"type": "string",
"description": "Wait this duration before executing",
"nullable": true
},
"repeat_every_duration": {
"type": "string",
"description": "Repeat workflow every duration",
"nullable": true
},
"repeat_condition_duration_since_first_run": {
"type": "string",
"description": "The workflow will stop repeating if its runtime since it's first workflow run exceeds the duration set in this field",
"nullable": true
},
"repeat_condition_number_of_repeats": {
"type": "integer",
"description": "The workflow will stop repeating if the number of repeats exceeds the value set in this field"
},
"continuously_repeat": {
"type": "boolean",
"description": "When continuously repeat is true, repeat workflows aren't automatically stopped when conditions aren't met. This setting won't override your conditions set by repeat_condition_duration_since_first_run and repeat_condition_number_of_repeats parameters."
},
"enabled": {
"type": "boolean"
},
"locked": {
"type": "boolean",
"description": "Restricts workflow edits to admins when turned on. Only admins can set this field."
},
"position": {
"type": "integer",
"description": "The order which the workflow should run with other workflows."
},
"workflow_group_id": {
"type": "string",
"description": "The group this workflow belongs to.",
"nullable": true
},
"trigger_params": {
"oneOf": [
{
"$ref": "#/components/schemas/incident_trigger_params"
},
{
"$ref": "#/components/schemas/action_item_trigger_params"
},
{
"$ref": "#/components/schemas/alert_trigger_params"
},
{
"$ref": "#/components/schemas/pulse_trigger_params"
},
{
"$ref": "#/components/schemas/simple_trigger_params"
}
]
},
"environment_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"severity_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"incident_type_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"incident_role_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"functionality_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"cause_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"sub_status_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"workflow": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The title of the workflow"
},
"slug": {
"type": "string",
"description": "The slug of the workflow"
},
"description": {
"type": "string",
"description": "The description of the workflow",
"nullable": true
},
"command": {
"type": "string",
"description": "Workflow command",
"nullable": true
},
"command_feedback_enabled": {
"type": "boolean",
"description": "This will notify you back when the workflow is starting",
"nullable": true
},
"wait": {
"type": "string",
"description": "Wait this duration before executing",
"nullable": true
},
"repeat_every_duration": {
"type": "string",
"description": "Repeat workflow every duration",
"nullable": true
},
"repeat_condition_duration_since_first_run": {
"type": "string",
"description": "The workflow will stop repeating if its runtime since it's first workflow run exceeds the duration set in this field",
"nullable": true
},
"repeat_condition_number_of_repeats": {
"type": "integer",
"description": "The workflow will stop repeating if the number of repeats exceeds the value set in this field"
},
"continuously_repeat": {
"type": "boolean",
"description": "When continuously repeat is true, repeat workflows aren't automatically stopped when conditions aren't met. This setting won't override your conditions set by repeat_condition_duration_since_first_run and repeat_condition_number_of_repeats parameters."
},
"repeat_on": {
"type": "array",
"items": {
"type": "string",
"description": "Repeat on weekdays",
"enum": [
"S",
"M",
"T",
"W",
"R",
"F",
"U"
]
},
"nullable": true
},
"enabled": {
"type": "boolean"
},
"locked": {
"type": "boolean",
"description": "Restricts workflow edits to admins when turned on. Only admins can set this field."
},
"position": {
"type": "integer",
"description": "The order which the workflow should run with other workflows."
},
"workflow_group_id": {
"type": "string",
"description": "The group this workflow belongs to.",
"nullable": true
},
"trigger_params": {
"oneOf": [
{
"$ref": "#/components/schemas/incident_trigger_params"
},
{
"$ref": "#/components/schemas/action_item_trigger_params"
},
{
"$ref": "#/components/schemas/alert_trigger_params"
},
{
"$ref": "#/components/schemas/pulse_trigger_params"
},
{
"$ref": "#/components/schemas/simple_trigger_params"
}
]
},
"environment_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"severity_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"incident_type_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"incident_role_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"functionality_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"cause_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"sub_status_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"workflow_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow"
},
"type": {
"type": "string",
"enum": [
"workflows"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"workflow_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow"
},
"type": {
"type": "string",
"enum": [
"workflows"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_live_call_router": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"live_call_routers"
]
},
"attributes": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the live_call_router",
"enum": [
"voicemail",
"live"
]
},
"enabled": {
"type": "boolean",
"description": "Whether the live_call_router is enabled"
},
"name": {
"type": "string",
"description": "The name of the live_call_router"
},
"country_code": {
"type": "string",
"description": "The country code of the live_call_router",
"enum": [
"AU",
"CA",
"NL",
"NZ",
"GB",
"US"
]
},
"phone_type": {
"type": "string",
"description": "The phone type of the live_call_router",
"enum": [
"local",
"toll_free",
"mobile"
]
},
"phone_number": {
"type": "string",
"description": "You can select a phone number using [generate_phone_number](#//api/v1/live_call_routers/generate_phone_number) API and pass that phone number here to register"
},
"voicemail_greeting": {
"type": "string",
"description": "The voicemail greeting of the live_call_router"
},
"caller_greeting": {
"type": "string",
"description": "The caller greeting message of the live_call_router"
},
"waiting_music_url": {
"type": "string",
"description": "The waiting music URL of the live_call_router",
"enum": [
"https://storage.rootly.com/twilio/voicemail/ClockworkWaltz.mp3",
"https://storage.rootly.com/twilio/voicemail/ith_brahms-116-4.mp3",
"https://storage.rootly.com/twilio/voicemail/Mellotroniac_-_Flight_Of_Young_Hearts_Flute.mp3",
"https://storage.rootly.com/twilio/voicemail/BusyStrings.mp3",
"https://storage.rootly.com/twilio/voicemail/oldDog_-_endless_goodbye_%28instr.%29.mp3",
"https://storage.rootly.com/twilio/voicemail/MARKOVICHAMP-Borghestral.mp3",
"https://storage.rootly.com/twilio/voicemail/ith_chopin-15-2.mp3"
]
},
"sent_to_voicemail_delay": {
"type": "integer",
"description": "The delay (seconds) after which the caller in redirected to voicemail"
},
"should_redirect_to_voicemail_on_no_answer": {
"type": "boolean",
"description": "This prompts the caller to choose voicemail or connect live"
},
"escalation_level_delay_in_seconds": {
"type": "integer",
"description": "This overrides the delay (seconds) in escalation levels"
},
"should_auto_resolve_alert_on_call_end": {
"type": "boolean",
"description": "This overrides the delay (seconds) in escalation levels"
},
"alert_urgency_id": {
"type": "string",
"description": "This is used in escalation paths to determine who to page"
},
"calling_tree_prompt": {
"type": "string",
"description": "The audio instructions callers will hear when they call this number, prompting them to select from available options to route their call"
},
"paging_targets": {
"type": "array",
"description": "Paging targets that callers can select from when this live call router is configured as a phone tree.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of paging target"
},
"type": {
"type": "string",
"description": "The type of the paging target",
"enum": [
"service",
"team",
"escalation_policy"
]
},
"alert_urgency_id": {
"type": "string",
"description": "This is used in escalation paths to determine who to page"
}
},
"required": [
"id",
"type",
"alert_urgency_id"
],
"nullable": false
}
},
"escalation_policy_trigger_params": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of notification target"
},
"type": {
"type": "string",
"description": "The type of the notification target",
"enum": [
"service",
"group",
"escalation_policy"
]
}
},
"required": [
"id",
"type"
]
}
},
"additionalProperties": false,
"required": [
"kind",
"name",
"country_code",
"phone_type",
"phone_number"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_live_call_router": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"live_call_routers"
]
},
"attributes": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the live_call_router",
"enum": [
"voicemail",
"live"
]
},
"enabled": {
"type": "boolean",
"description": "Whether the live_call_router is enabled"
},
"name": {
"type": "string",
"description": "The name of the live_call_router"
},
"country_code": {
"type": "string",
"description": "The country code of the live_call_router",
"enum": [
"AU",
"CA",
"NL",
"NZ",
"GB",
"US"
]
},
"phone_type": {
"type": "string",
"description": "The phone type of the live_call_router",
"enum": [
"local",
"toll_free",
"mobile"
]
},
"voicemail_greeting": {
"type": "string",
"description": "The voicemail greeting of the live_call_router"
},
"caller_greeting": {
"type": "string",
"description": "The caller greeting message of the live_call_router"
},
"waiting_music_url": {
"type": "string",
"description": "The waiting music URL of the live_call_router",
"enum": [
"https://storage.rootly.com/twilio/voicemail/ClockworkWaltz.mp3",
"https://storage.rootly.com/twilio/voicemail/ith_brahms-116-4.mp3",
"https://storage.rootly.com/twilio/voicemail/Mellotroniac_-_Flight_Of_Young_Hearts_Flute.mp3",
"https://storage.rootly.com/twilio/voicemail/BusyStrings.mp3",
"https://storage.rootly.com/twilio/voicemail/oldDog_-_endless_goodbye_%28instr.%29.mp3",
"https://storage.rootly.com/twilio/voicemail/MARKOVICHAMP-Borghestral.mp3",
"https://storage.rootly.com/twilio/voicemail/ith_chopin-15-2.mp3"
]
},
"sent_to_voicemail_delay": {
"type": "integer",
"description": "The delay (seconds) after which the caller in redirected to voicemail"
},
"should_redirect_to_voicemail_on_no_answer": {
"type": "boolean",
"description": "This prompts the caller to choose voicemail or connect live"
},
"escalation_level_delay_in_seconds": {
"type": "integer",
"description": "This overrides the delay (seconds) in escalation levels"
},
"should_auto_resolve_alert_on_call_end": {
"type": "boolean",
"description": "This overrides the delay (seconds) in escalation levels"
},
"alert_urgency_id": {
"type": "string",
"description": "This is used in escalation paths to determine who to page"
},
"calling_tree_prompt": {
"type": "string",
"description": "The audio instructions callers will hear when they call this number, prompting them to select from available options to route their call"
},
"paging_targets": {
"type": "array",
"description": "Paging targets that callers can select from when this live call router is configured as a phone tree.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of paging target"
},
"type": {
"type": "string",
"description": "The type of the paging target",
"enum": [
"service",
"team",
"escalation_policy"
]
},
"alert_urgency_id": {
"type": "string",
"description": "This is used in escalation paths to determine who to page"
}
},
"required": [
"id",
"type",
"alert_urgency_id"
],
"nullable": false
}
},
"escalation_policy_trigger_params": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of notification target"
},
"type": {
"type": "string",
"description": "The type of the notification target",
"enum": [
"Service",
"Group",
"EscalationPolicy"
]
}
},
"required": [
"id",
"type"
]
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"live_call_router": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the live_call_router",
"enum": [
"voicemail",
"live"
]
},
"enabled": {
"type": "boolean",
"description": "Whether the live_call_router is enabled"
},
"name": {
"type": "string",
"description": "The name of the live_call_router"
},
"country_code": {
"type": "string",
"description": "The country code of the live_call_router",
"enum": [
"AU",
"CA",
"NL",
"NZ",
"GB",
"US"
]
},
"phone_type": {
"type": "string",
"description": "The phone type of the live_call_router",
"enum": [
"local",
"toll_free",
"mobile"
]
},
"phone_number": {
"type": "string",
"description": "You can select a phone number using [generate_phone_number](#//api/v1/live_call_routers/generate_phone_number) API and pass that phone number here to register"
},
"voicemail_greeting": {
"type": "string",
"description": "The voicemail greeting of the live_call_router"
},
"caller_greeting": {
"type": "string",
"description": "The caller greeting message of the live_call_router"
},
"waiting_music_url": {
"type": "string",
"description": "The waiting music URL of the live_call_router",
"enum": [
"https://storage.rootly.com/twilio/voicemail/ClockworkWaltz.mp3",
"https://storage.rootly.com/twilio/voicemail/ith_brahms-116-4.mp3",
"https://storage.rootly.com/twilio/voicemail/Mellotroniac_-_Flight_Of_Young_Hearts_Flute.mp3",
"https://storage.rootly.com/twilio/voicemail/BusyStrings.mp3",
"https://storage.rootly.com/twilio/voicemail/oldDog_-_endless_goodbye_%28instr.%29.mp3",
"https://storage.rootly.com/twilio/voicemail/MARKOVICHAMP-Borghestral.mp3",
"https://storage.rootly.com/twilio/voicemail/ith_chopin-15-2.mp3"
]
},
"sent_to_voicemail_delay": {
"type": "integer",
"description": "The delay (seconds) after which the caller in redirected to voicemail"
},
"should_redirect_to_voicemail_on_no_answer": {
"type": "boolean",
"description": "This prompts the caller to choose voicemail or connect live"
},
"escalation_level_delay_in_seconds": {
"type": "integer",
"description": "This overrides the delay (seconds) in escalation levels"
},
"should_auto_resolve_alert_on_call_end": {
"type": "boolean",
"description": "This overrides the delay (seconds) in escalation levels"
},
"alert_urgency_id": {
"type": "string",
"description": "This is used in escalation paths to determine who to page"
},
"calling_tree_prompt": {
"type": "string",
"description": "The audio instructions callers will hear when they call this number, prompting them to select from available options to route their call"
},
"paging_targets": {
"type": "array",
"description": "Paging targets that callers can select from when this live call router is configured as a phone tree.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of paging target"
},
"type": {
"type": "string",
"description": "The type of the paging target",
"enum": [
"service",
"team",
"escalation_policy"
]
},
"alert_urgency_id": {
"type": "string",
"description": "This is used in escalation paths to determine who to page"
}
},
"required": [
"id",
"type",
"alert_urgency_id"
],
"nullable": false
}
},
"escalation_policy_trigger_params": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of notification target"
},
"type": {
"type": "string",
"description": "The type of the notification target",
"enum": [
"Service",
"Group",
"EscalationPolicy"
]
}
},
"required": [
"id",
"type"
]
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"live_call_router_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the live_call_router"
},
"type": {
"type": "string",
"enum": [
"live_call_routers"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/live_call_router"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"live_call_router_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the live_call_router"
},
"type": {
"type": "string",
"enum": [
"live_call_routers"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/live_call_router"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_heartbeat": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"heartbeats"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the heartbeat"
},
"description": {
"type": "string",
"description": "The description of the heartbeat",
"nullable": true
},
"alert_summary": {
"type": "string",
"description": "Summary of alerts triggered when heartbeat expires."
},
"alert_urgency_id": {
"type": "string",
"description": "Urgency of alerts triggered when heartbeat expires.",
"nullable": true
},
"interval": {
"type": "integer"
},
"interval_unit": {
"type": "string",
"enum": [
"seconds",
"minutes",
"hours"
]
},
"notification_target_id": {
"type": "string"
},
"notification_target_type": {
"type": "string",
"enum": [
"User",
"Group",
"Service",
"EscalationPolicy"
]
},
"enabled": {
"type": "boolean",
"description": "Whether to trigger alerts when heartbeat is expired."
}
},
"additionalProperties": false,
"required": [
"name",
"alert_summary",
"interval",
"interval_unit",
"notification_target_id",
"notification_target_type"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_heartbeat": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"heartbeats"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the heartbeat"
},
"description": {
"type": "string",
"description": "The description of the heartbeat",
"nullable": true
},
"alert_summary": {
"type": "string",
"description": "Summary of alerts triggered when heartbeat expires."
},
"alert_urgency_id": {
"type": "string",
"description": "Urgency of alerts triggered when heartbeat expires.",
"nullable": true
},
"interval": {
"type": "integer"
},
"interval_unit": {
"type": "string",
"enum": [
"seconds",
"minutes",
"hours"
]
},
"notification_target_id": {
"type": "string"
},
"notification_target_type": {
"type": "string",
"enum": [
"User",
"Group",
"Service",
"EscalationPolicy"
]
},
"enabled": {
"type": "boolean",
"description": "Whether to trigger alerts when heartbeat is expired."
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"heartbeat": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the heartbeat"
},
"description": {
"type": "string",
"description": "The description of the heartbeat",
"nullable": true
},
"alert_summary": {
"type": "string",
"description": "Summary of alerts triggered when heartbeat expires."
},
"alert_urgency_id": {
"type": "string",
"description": "Urgency of alerts triggered when heartbeat expires.",
"nullable": true
},
"interval": {
"type": "integer"
},
"interval_unit": {
"type": "string",
"enum": [
"seconds",
"minutes",
"hours"
]
},
"notification_target_id": {
"type": "string"
},
"notification_target_type": {
"type": "string",
"enum": [
"User",
"Group",
"Service",
"EscalationPolicy"
]
},
"enabled": {
"type": "boolean",
"description": "Whether to trigger alerts when heartbeat is expired."
},
"status": {
"type": "string",
"enum": [
"waiting",
"active",
"expired"
]
},
"ping_url": {
"type": "string",
"nullable": true,
"description": "URL to receive heartbeat pings."
},
"secret": {
"type": "string",
"nullable": true,
"description": "Secret used as bearer token when pinging heartbeat."
},
"last_pinged_at": {
"type": "string",
"description": "When the heartbeat was last pinged.",
"nullable": true
},
"expires_at": {
"type": "string",
"description": "When heartbeat expires",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"alert_summary",
"interval",
"interval_unit",
"notification_target_id",
"notification_target_type",
"enabled",
"status",
"created_at",
"updated_at"
]
},
"heartbeat_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the heartbeat"
},
"type": {
"type": "string",
"enum": [
"heartbeats"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/heartbeat"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"heartbeat_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the heartbeat"
},
"type": {
"type": "string",
"enum": [
"heartbeats"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/heartbeat"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_incident_action_item": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_action_items"
]
},
"attributes": {
"type": "object",
"properties": {
"summary": {
"type": "string",
"description": "The summary of the action item"
},
"description": {
"type": "string",
"description": "The description of the action item",
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the action item",
"enum": [
"task",
"follow_up"
]
},
"assigned_to_user_id": {
"type": "integer",
"description": "ID of user you wish to assign this action item",
"nullable": true
},
"assigned_to_group_ids": {
"type": "array",
"description": "IDs of groups you wish to assign this action item",
"items": {
"type": "string"
}
},
"priority": {
"type": "string",
"description": "The priority of the action item",
"enum": [
"high",
"medium",
"low"
]
},
"status": {
"type": "string",
"description": "The status of the action item",
"enum": [
"open",
"in_progress",
"cancelled",
"done"
]
},
"due_date": {
"type": "string",
"description": "The due date of the action item",
"nullable": true
},
"jira_issue_id": {
"type": "string",
"description": "The Jira issue ID.",
"nullable": true
},
"jira_issue_key": {
"type": "string",
"description": "The Jira issue key.",
"nullable": true
},
"jira_issue_url": {
"type": "string",
"description": "The Jira issue URL.",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"summary"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_action_item": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_action_items"
]
},
"attributes": {
"type": "object",
"properties": {
"summary": {
"type": "string",
"description": "The summary of the action item"
},
"description": {
"type": "string",
"description": "The description of the action item",
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the action item",
"enum": [
"task",
"follow_up"
]
},
"assigned_to_user_id": {
"type": "integer",
"description": "ID of user you wish to assign this action item",
"nullable": true
},
"assigned_to_group_ids": {
"type": "array",
"description": "IDs of groups you wish to assign this action item",
"items": {
"type": "string"
},
"nullable": true
},
"priority": {
"type": "string",
"description": "The priority of the action item",
"enum": [
"high",
"medium",
"low"
]
},
"status": {
"type": "string",
"description": "The status of the action item",
"enum": [
"open",
"in_progress",
"cancelled",
"done"
]
},
"due_date": {
"type": "string",
"description": "The due date of the action item",
"nullable": true
},
"jira_issue_id": {
"type": "string",
"description": "The Jira issue ID.",
"nullable": true
},
"jira_issue_key": {
"type": "string",
"description": "The Jira issue key.",
"nullable": true
},
"jira_issue_url": {
"type": "string",
"description": "The Jira issue URL.",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_action_item": {
"type": "object",
"properties": {
"summary": {
"type": "string",
"description": "The summary of the action item"
},
"description": {
"type": "string",
"description": "The description of incident action item",
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the action item",
"enum": [
"task",
"follow_up"
]
},
"assigned_to": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user_flat_response"
}
],
"description": "User assigned to this action item",
"nullable": true
},
"assigned_to_group_ids": {
"type": "array",
"description": "IDs of groups you wish to assign this action item",
"items": {
"type": "string"
},
"nullable": true
},
"priority": {
"type": "string",
"description": "The priority of the action item",
"enum": [
"high",
"medium",
"low"
]
},
"status": {
"type": "string",
"description": "The status of the action item",
"enum": [
"open",
"in_progress",
"cancelled",
"done"
]
},
"due_date": {
"type": "string",
"description": "The due date of the action item",
"nullable": true
},
"jira_issue_id": {
"type": "string",
"description": "The Jira issue ID.",
"nullable": true
},
"jira_issue_key": {
"type": "string",
"description": "The Jira issue key.",
"nullable": true
},
"jira_issue_url": {
"type": "string",
"description": "The Jira issue URL.",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"summary",
"created_at",
"updated_at"
]
},
"incident_action_item_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the action item"
},
"type": {
"type": "string",
"enum": [
"incident_action_items"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_action_item"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_action_item_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the action item"
},
"type": {
"type": "string",
"enum": [
"incident_action_items"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_action_item"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_incident_custom_field_selection": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_custom_field_selections"
]
},
"attributes": {
"type": "object",
"properties": {
"custom_field_id": {
"type": "integer",
"description": "The custom field for this selection"
},
"value": {
"type": "string",
"description": "The selected value for text kind custom fields",
"nullable": true
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected option id for select and multi_select kinds"
}
}
},
"additionalProperties": false,
"required": [
"value",
"custom_field_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_custom_field_selection": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_custom_field_selections"
]
},
"attributes": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The selected value for text kind custom fields",
"nullable": true
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected option id for select and multi_select kinds"
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_custom_field_selection": {
"type": "object",
"properties": {
"incident_id": {
"type": "string"
},
"custom_field_id": {
"type": "integer"
},
"value": {
"type": "string",
"description": "The value of the incident_custom_field_selection",
"nullable": true
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected option id for select and multi_select kinds"
}
}
},
"required": [
"value",
"selected_option_ids"
]
},
"incident_custom_field_selection_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident_custom_field_selection"
},
"type": {
"type": "string",
"enum": [
"incident_custom_field_selections"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_custom_field_selection"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_custom_field_selection_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident_custom_field_selection"
},
"type": {
"type": "string",
"enum": [
"incident_custom_field_selections"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_custom_field_selection"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_incident_event_functionality": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_event_functionalities"
]
},
"attributes": {
"type": "object",
"properties": {
"incident_event_id": {
"type": "string",
"description": "The ID of the incident event."
},
"functionality_id": {
"type": "string",
"description": "The ID of the functionality."
},
"status": {
"type": "string",
"description": "The status of the affected functionality",
"enum": [
"operational",
"partial_outage",
"major_outage"
]
}
},
"additionalProperties": false,
"required": [
"incident_event_id",
"functionality_id",
"status"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_event_functionality": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_event_functionalities"
]
},
"attributes": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the affected functionality",
"enum": [
"operational",
"partial_outage",
"major_outage"
]
}
},
"additionalProperties": false,
"required": [
"status"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_event_functionality": {
"type": "object",
"properties": {
"incident_event_id": {
"type": "string",
"description": "The ID of the incident event."
},
"functionality_id": {
"type": "string",
"description": "The ID of the functionality."
},
"status": {
"type": "string",
"description": "The status of the affected functionality",
"enum": [
"operational",
"partial_outage",
"major_outage"
]
}
},
"additionalProperties": false,
"required": [
"incident_event_id",
"functionality_id",
"status"
]
},
"incident_event_functionality_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident event functionality"
},
"type": {
"type": "string",
"enum": [
"incident_event_functionalities"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_event_functionality"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_event_functionality_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident event functionality"
},
"type": {
"type": "string",
"enum": [
"incident_event_functionalities"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_event_functionality"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_incident_event_service": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_event_services"
]
},
"attributes": {
"type": "object",
"properties": {
"incident_event_id": {
"type": "string",
"description": "The ID of the incident event."
},
"service_id": {
"type": "string",
"description": "The ID of the service."
},
"status": {
"type": "string",
"description": "The status of the affected service",
"enum": [
"operational",
"partial_outage",
"major_outage"
]
}
},
"additionalProperties": false,
"required": [
"incident_event_id",
"service_id",
"status"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_event_service": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_event_services"
]
},
"attributes": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the affected service",
"enum": [
"operational",
"partial_outage",
"major_outage"
]
}
},
"additionalProperties": false,
"required": [
"status"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_event_service": {
"type": "object",
"properties": {
"incident_event_id": {
"type": "string",
"description": "The ID of the incident event."
},
"service_id": {
"type": "string",
"description": "The ID of the service."
},
"status": {
"type": "string",
"description": "The status of the affected service",
"enum": [
"operational",
"partial_outage",
"major_outage"
]
}
},
"additionalProperties": false,
"required": [
"incident_event_id",
"service_id",
"status"
]
},
"incident_event_service_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident event service"
},
"type": {
"type": "string",
"enum": [
"incident_event_services"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_event_service"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_event_service_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident event service"
},
"type": {
"type": "string",
"enum": [
"incident_event_services"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_event_service"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_incident_event": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_events"
]
},
"attributes": {
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "The summary of the incident event"
},
"visibility": {
"type": "string",
"description": "The visibility of the incident action item",
"enum": [
"internal",
"external"
]
}
},
"additionalProperties": false,
"required": [
"event"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_event": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_events"
]
},
"attributes": {
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "The summary of the incident event"
},
"visibility": {
"type": "string",
"description": "The visibility of the incident action item",
"enum": [
"internal",
"external"
]
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_event": {
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "The summary of the incident event"
},
"visibility": {
"type": "string",
"description": "The visibility of the incident action item",
"enum": [
"internal",
"external"
]
},
"occurred_at": {
"type": "string",
"description": "Date of occurence"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"event",
"occurred_at",
"created_at",
"updated_at"
]
},
"incident_event_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident event"
},
"type": {
"type": "string",
"enum": [
"incident_events"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_event"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_event_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident event"
},
"type": {
"type": "string",
"enum": [
"incident_events"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_event"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_incident_feedback": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_feedbacks"
]
},
"attributes": {
"type": "object",
"properties": {
"feedback": {
"type": "string",
"description": "The feedback of the incident feedback"
},
"rating": {
"type": "integer",
"description": "The rating of the incident feedback",
"enum": [
4,
3,
2,
1,
0
]
},
"anonymous": {
"type": "boolean",
"description": "Is the feedback anonymous?"
}
},
"additionalProperties": false,
"required": [
"rating",
"feedback"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_feedback": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_feedbacks"
]
},
"attributes": {
"type": "object",
"properties": {
"feedback": {
"type": "string",
"description": "The feedback of the incident feedback"
},
"rating": {
"type": "integer",
"description": "The rating of the incident feedback",
"enum": [
4,
3,
2,
1,
0
]
},
"anonymous": {
"type": "boolean",
"description": "Is the feedback anonymous?"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_feedback": {
"type": "object",
"properties": {
"feedback": {
"type": "string",
"description": "The feedback of the incident feedback"
},
"rating": {
"type": "integer",
"description": "The rating of the incident feedback",
"enum": [
4,
3,
2,
1,
0
]
},
"anonymous": {
"type": "boolean",
"description": "Is the feedback anonymous?"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"rating",
"feedback",
"anonymous",
"created_at",
"updated_at"
]
},
"incident_feedback_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident feedback"
},
"type": {
"type": "string",
"enum": [
"incident_feedbacks"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_feedback"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_feedback_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident feedback"
},
"type": {
"type": "string",
"enum": [
"incident_feedbacks"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_feedback"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_incident_form_field_selection": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_form_field_selections"
]
},
"attributes": {
"type": "object",
"properties": {
"incident_id": {
"type": "string"
},
"form_field_id": {
"type": "string",
"description": "The custom field for this selection"
},
"value": {
"type": "string",
"description": "The selected value for text kind custom fields",
"nullable": true
},
"selected_catalog_entity_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected catalog entities for select and multi_select kinds"
}
},
"selected_group_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected groups (teams) for select and multi_select kinds"
}
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected options for select and multi_select kinds"
}
},
"selected_service_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected services for select and multi_select kinds"
}
},
"selected_functionality_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected functionalities for select and multi_select kinds"
}
},
"selected_user_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected users for select and multi_select kinds"
}
}
},
"additionalProperties": false,
"required": [
"form_field_id",
"incident_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_form_field_selection": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_form_field_selections"
]
},
"attributes": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The selected value for text kind custom fields",
"nullable": true
},
"selected_catalog_entity_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected catalog entities for select and multi_select kinds"
}
},
"selected_group_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected groups (teams) for select and multi_select kinds"
}
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected options for select and multi_select kinds"
}
},
"selected_service_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected services for select and multi_select kinds"
}
},
"selected_functionality_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected functionalities for select and multi_select kinds"
}
},
"selected_user_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected users for select and multi_select kinds"
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_form_field_selection": {
"type": "object",
"properties": {
"incident_id": {
"type": "string"
},
"form_field_id": {
"type": "string",
"description": "The custom field for this selection"
},
"value": {
"type": "string",
"description": "The selected value for text kind custom fields",
"nullable": true
},
"selected_catalog_entity_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected catalog entities for select and multi_select kinds"
}
},
"selected_group_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected groups (teams) for select and multi_select kinds"
}
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected options for select and multi_select kinds"
}
},
"selected_service_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected services for select and multi_select kinds"
}
},
"selected_functionality_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected functionalities for select and multi_select kinds"
}
},
"selected_user_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected users for select and multi_select kinds"
}
}
},
"required": [
"incident_id",
"form_field_id"
]
},
"incident_form_field_selection_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident_form_field_selection"
},
"type": {
"type": "string",
"enum": [
"incident_form_field_selections"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_form_field_selection"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_form_field_selection_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident_form_field_selection"
},
"type": {
"type": "string",
"enum": [
"incident_form_field_selections"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_form_field_selection"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_incident_permission_set_boolean": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_permission_set_booleans"
]
},
"attributes": {
"type": "object",
"properties": {
"incident_permission_set_id": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"publish_to_status_page",
"assign_incident_roles",
"invite_subscribers",
"update_summary",
"update_timeline",
"trigger_workflows",
"create_communications",
"read_communications",
"update_communications",
"delete_communications",
"send_communications",
"modify_custom_fields"
]
},
"private": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"severity_params": {
"type": "object",
"properties": {
"fully_enabled": {
"type": "boolean",
"description": "Whether permissions are enabled for any severity incident",
"default": true
},
"create_enabled": {
"type": "boolean",
"description": "Whether permissions are enabled when creating incident",
"default": false
},
"applies_to_unassigned": {
"type": "boolean",
"description": "Whether permissions are enabled for incident without severity",
"default": true
},
"severity_ids": {
"type": "array",
"description": "Severity ids that determine if an incident is permitted based on matching severity",
"items": {
"type": "string"
},
"nullable": true
}
}
}
},
"additionalProperties": false,
"required": [
"kind",
"incident_permission_set_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_permission_set_boolean": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_permission_set_booleans"
]
},
"attributes": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"publish_to_status_page",
"assign_incident_roles",
"invite_subscribers",
"update_summary",
"update_timeline",
"trigger_workflows",
"create_communications",
"read_communications",
"update_communications",
"delete_communications",
"send_communications",
"modify_custom_fields"
]
},
"private": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"severity_params": {
"type": "object",
"properties": {
"fully_enabled": {
"type": "boolean",
"description": "Whether permissions are enabled for any severity incident",
"default": true
},
"applies_to_unassigned": {
"type": "boolean",
"description": "Whether permissions are enabled for incident without severity",
"default": true
},
"create_enabled": {
"type": "boolean",
"description": "Whether permissions are enabled when creating incident",
"default": false
},
"severity_ids": {
"type": "array",
"description": "Severity ids that determine if an incident is permitted based on matching severity",
"items": {
"type": "string"
},
"nullable": true
}
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_permission_set_boolean": {
"type": "object",
"properties": {
"incident_permission_set_id": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"publish_to_status_page",
"assign_incident_roles",
"invite_subscribers",
"update_summary",
"update_timeline",
"trigger_workflows",
"create_communications",
"read_communications",
"update_communications",
"delete_communications",
"send_communications",
"modify_custom_fields"
]
},
"private": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"kind",
"created_at",
"updated_at"
]
},
"incident_permission_set_boolean_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident permission set boolean"
},
"type": {
"type": "string",
"enum": [
"incident_permission_set_booleans"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_permission_set_boolean"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_permission_set_boolean_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident permission set boolean"
},
"type": {
"type": "string",
"enum": [
"incident_permission_set_booleans"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_permission_set_boolean"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_incident_permission_set_resource": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_permission_set_resources"
]
},
"attributes": {
"type": "object",
"properties": {
"incident_permission_set_id": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"severities",
"incident_types",
"statuses",
"sub_statuses"
]
},
"private": {
"type": "boolean"
},
"resource_id": {
"type": "string"
},
"resource_type": {
"type": "string"
},
"severity_params": {
"type": "object",
"properties": {
"fully_enabled": {
"type": "boolean",
"description": "Whether permissions are enabled for any severity incident",
"default": true
},
"create_enabled": {
"type": "boolean",
"description": "Whether permissions are enabled when creating incident",
"default": false
},
"applies_to_unassigned": {
"type": "boolean",
"description": "Whether permissions are enabled for incident without severity",
"default": true
},
"severity_ids": {
"type": "array",
"description": "Severity ids that determine if an incident is permitted based on matching severity",
"items": {
"type": "string"
},
"nullable": true
}
}
}
},
"additionalProperties": false,
"required": [
"incident_permission_set_id",
"kind"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_permission_set_resource": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_permission_set_resources"
]
},
"attributes": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"severities",
"incident_types",
"statuses",
"sub_statuses"
]
},
"private": {
"type": "boolean"
},
"resource_id": {
"type": "string"
},
"resource_type": {
"type": "string"
},
"severity_params": {
"type": "object",
"properties": {
"fully_enabled": {
"type": "boolean",
"description": "Whether permissions are enabled for any severity incident",
"default": true
},
"create_enabled": {
"type": "boolean",
"description": "Whether permissions are enabled when creating incident",
"default": false
},
"applies_to_unassigned": {
"type": "boolean",
"description": "Whether permissions are enabled for incident without severity",
"default": true
},
"severity_ids": {
"type": "array",
"description": "Severity ids that determine if an incident is permitted based on matching severity",
"items": {
"type": "string"
},
"nullable": true
}
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_permission_set_resource": {
"type": "object",
"properties": {
"incident_permission_set_id": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"severities",
"incident_types",
"statuses",
"sub_statuses"
]
},
"private": {
"type": "boolean"
},
"resource_id": {
"type": "string"
},
"resource_type": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"incident_permission_set_id",
"kind",
"created_at",
"updated_at"
]
},
"incident_permission_set_resource_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident permission set resource"
},
"type": {
"type": "string",
"enum": [
"incident_permission_set_resources"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_permission_set_resource"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_permission_set_resource_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident permission set resource"
},
"type": {
"type": "string",
"enum": [
"incident_permission_set_resources"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_permission_set_resource"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_incident_permission_set": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_permission_sets"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The incident permission set name."
},
"slug": {
"type": "string",
"description": "The incident permission set slug."
},
"description": {
"type": "string",
"description": "The incident permission set description.",
"nullable": true
},
"private_incident_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"public_incident_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_permission_set": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_permission_sets"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The incident permission set name."
},
"slug": {
"type": "string",
"description": "The incident permission set slug."
},
"description": {
"type": "string",
"description": "The incident permission set description.",
"nullable": true
},
"private_incident_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"public_incident_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_permission_set": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The incident permission set name."
},
"slug": {
"type": "string",
"description": "The incident permission set slug."
},
"description": {
"type": "string",
"description": "The incident permission set description.",
"nullable": true
},
"private_incident_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"public_incident_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"name",
"slug",
"created_at",
"updated_at"
]
},
"incident_permission_set_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident permission set"
},
"type": {
"type": "string",
"enum": [
"incident_permission_sets"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_permission_set"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_permission_set_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident permission set"
},
"type": {
"type": "string",
"enum": [
"incident_permission_sets"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_permission_set"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"update_incident_post_mortem": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_post_mortems"
]
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the incident retrospective"
},
"status": {
"type": "string",
"description": "The status of the incident retrospective",
"enum": [
"draft",
"published"
]
},
"started_at": {
"type": "string",
"description": "Date of started at",
"nullable": true
},
"mitigated_at": {
"type": "string",
"description": "Date of mitigation",
"nullable": true
},
"resolved_at": {
"type": "string",
"description": "Date of resolution",
"nullable": true
},
"show_timeline": {
"type": "boolean",
"description": "Show events timeline of the incident retrospective"
},
"show_timeline_trail": {
"type": "boolean",
"description": "Show trail events in the timeline of the incident retrospective"
},
"show_timeline_genius": {
"type": "boolean",
"description": "Show workflow events in the timeline of the incident retrospective"
},
"show_timeline_tasks": {
"type": "boolean",
"description": "Show tasks in the timeline of the incident retrospective"
},
"show_timeline_action_items": {
"type": "boolean",
"description": "Show action items in the timeline of the incident retrospective"
},
"show_services_impacted": {
"type": "boolean",
"description": "Show functionalities impacted of the incident retrospective"
},
"show_functionalities_impacted": {
"type": "boolean",
"description": "Show services impacted of the incident retrospective"
},
"show_groups_impacted": {
"type": "boolean",
"description": "Show groups impacted of the incident retrospective"
},
"show_alerts_attached": {
"type": "boolean",
"description": "Show alerts attached to the incident"
},
"show_action_items": {
"type": "boolean",
"description": "Show action items (follow-ups) in the incident retrospective"
},
"cause_ids": {
"type": "array",
"description": "The Cause ID's to attach to the incident retrospective",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_post_mortem": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the incident retrospective"
},
"content": {
"type": "string",
"description": "The content of the incident retrospective (Only if internal)",
"nullable": true
},
"status": {
"type": "string",
"description": "The status of the incident retrospective",
"enum": [
"draft",
"published"
]
},
"started_at": {
"type": "string",
"description": "Date of started at",
"nullable": true
},
"mitigated_at": {
"type": "string",
"description": "Date of mitigation",
"nullable": true
},
"resolved_at": {
"type": "string",
"description": "Date of resolution",
"nullable": true
},
"show_timeline": {
"type": "boolean",
"description": "Show events timeline of the incident retrospective"
},
"show_timeline_trail": {
"type": "boolean",
"description": "Show trail events in the timeline of the incident retrospective"
},
"show_timeline_genius": {
"type": "boolean",
"description": "Show workflow events in the timeline of the incident retrospective"
},
"show_timeline_tasks": {
"type": "boolean",
"description": "Show tasks in the timeline of the incident retrospective"
},
"show_timeline_action_items": {
"type": "boolean",
"description": "Show action items in the timeline of the incident retrospective"
},
"show_timeline_order": {
"type": "string",
"description": "The order of the incident retrospective timeline",
"enum": [
"asc",
"desc"
],
"default": "desc"
},
"show_services_impacted": {
"type": "boolean",
"description": "Show functionalities impacted of the incident retrospective"
},
"show_functionalities_impacted": {
"type": "boolean",
"description": "Show services impacted of the incident retrospective"
},
"show_groups_impacted": {
"type": "boolean",
"description": "Show groups impacted of the incident retrospective"
},
"show_alerts_attached": {
"type": "boolean",
"description": "Show alerts attached to the incident"
},
"url": {
"type": "string",
"description": "The url to the incident retrospective"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"title",
"created_at",
"updated_at"
]
},
"incident_post_mortem_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident retrospective"
},
"type": {
"type": "string",
"enum": [
"incident_post_mortems"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_post_mortem"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_post_mortem_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident retrospective"
},
"type": {
"type": "string",
"enum": [
"incident_post_mortems"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_post_mortem"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"update_incident_retrospective_step": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_retrospective_steps"
]
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The name of the incident retrospective step"
},
"description": {
"type": "string",
"description": "The description of the incident retrospective step",
"nullable": true
},
"due_date": {
"type": "string",
"description": "Due date",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the step",
"nullable": true
},
"skippable": {
"type": "boolean",
"description": "Is the step skippable?",
"nullable": false
},
"status": {
"type": "string",
"description": "Status of the incident retrospective step",
"enum": [
"todo",
"in_progress",
"completed",
"skipped"
],
"nullable": false
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_retrospective_step": {
"type": "object",
"properties": {
"retrospective_step_id": {
"type": "string"
},
"incident_id": {
"type": "string"
},
"title": {
"type": "string",
"description": "The name of the step"
},
"description": {
"type": "string",
"description": "The description of the step",
"nullable": true
},
"status": {
"type": "string",
"description": "Status of the incident retrospective step",
"enum": [
"todo",
"in_progress",
"completed",
"skipped"
],
"nullable": false
},
"kind": {
"type": "string",
"description": "Due date",
"nullable": true
},
"due_date": {
"type": "string",
"description": "Due date",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the step"
},
"skippable": {
"type": "boolean",
"description": "Is the step skippable?"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"retrospective_step_id",
"incident_id",
"title",
"created_at",
"updated_at"
]
},
"incident_retrospective_step_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the step"
},
"type": {
"type": "string",
"enum": [
"incident_retrospective_steps"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_retrospective_step"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"new_incident_role_task": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_role_tasks"
]
},
"attributes": {
"type": "object",
"properties": {
"incident_role_id": {
"type": "string"
},
"task": {
"type": "string",
"description": "The task of the incident task"
},
"description": {
"type": "string",
"description": "The description of the incident task",
"nullable": true
},
"priority": {
"type": "string",
"description": "The priority of the incident task",
"enum": [
"high",
"medium",
"low"
]
}
},
"additionalProperties": false,
"required": [
"task"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_role_task": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_role_tasks"
]
},
"attributes": {
"type": "object",
"properties": {
"task": {
"type": "string",
"description": "The task of the incident task"
},
"description": {
"type": "string",
"description": "The description of the incident task",
"nullable": true
},
"priority": {
"type": "string",
"description": "The priority of the incident task",
"enum": [
"high",
"medium",
"low"
]
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_role_task": {
"type": "object",
"properties": {
"incident_role_id": {
"type": "string"
},
"task": {
"type": "string",
"description": "The task of the incident task"
},
"description": {
"type": "string",
"description": "The description of incident task",
"nullable": true
},
"priority": {
"type": "string",
"description": "The priority of the incident task",
"enum": [
"high",
"medium",
"low"
]
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"task",
"created_at",
"updated_at"
]
},
"incident_role_task_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident task"
},
"type": {
"type": "string",
"enum": [
"incident_role_tasks"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_role_task"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_role_task_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident task"
},
"type": {
"type": "string",
"enum": [
"incident_role_tasks"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_role_task"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_incident_role": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_roles"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the incident role"
},
"summary": {
"type": "string",
"description": "The summary of the incident role",
"nullable": true
},
"description": {
"type": "string",
"description": "The description of the incident role",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the incident role",
"nullable": true
},
"optional": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"allow_multi_user_assignment": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_role": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_roles"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the incident role"
},
"summary": {
"type": "string",
"description": "The summary of the incident role",
"nullable": true
},
"description": {
"type": "string",
"description": "The description of the incident role",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the incident role",
"nullable": true
},
"optional": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"allow_multi_user_assignment": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_role": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the incident role"
},
"slug": {
"type": "string",
"description": "The slug of the incident role"
},
"summary": {
"type": "string",
"description": "The summary of the incident role",
"nullable": true
},
"description": {
"type": "string",
"description": "The description of the incident role",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the incident role",
"nullable": true
},
"optional": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"allow_multi_user_assignment": {
"type": "boolean"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"incident_role_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident role"
},
"type": {
"type": "string",
"enum": [
"incident_roles"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_role"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_role_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident role"
},
"type": {
"type": "string",
"enum": [
"incident_roles"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_role"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_incident_status_page_event": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_status_page_events"
]
},
"attributes": {
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "The summary of the incident event"
},
"status_page_id": {
"type": "string",
"description": "Unique ID of the status page you wish to post the event to"
},
"status": {
"type": "string",
"description": "The status of the incident event",
"enum": [
"investigating",
"identified",
"monitoring",
"resolved",
"scheduled",
"in_progress",
"verifying",
"completed"
]
},
"notify_subscribers": {
"type": "boolean",
"description": "Notify all status pages subscribers",
"default": false,
"nullable": true
},
"should_tweet": {
"type": "boolean",
"description": "For Statuspage.io integrated pages auto publishes a tweet for your update",
"default": false,
"nullable": true
}
},
"additionalProperties": false,
"required": [
"event"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_status_page_event": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_status_page_events"
]
},
"attributes": {
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "The summary of the incident event"
},
"status_page_id": {
"type": "string",
"description": "Unique ID of the status page you wish to post the event to"
},
"status": {
"type": "string",
"description": "The status of the incident event",
"enum": [
"investigating",
"identified",
"monitoring",
"resolved",
"scheduled",
"in_progress",
"verifying",
"completed"
]
},
"notify_subscribers": {
"type": "boolean",
"description": "Notify all status pages subscribers",
"default": false,
"nullable": true
},
"should_tweet": {
"type": "boolean",
"description": "For Statuspage.io integrated pages auto publishes a tweet for your update",
"default": false,
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_status_page_event": {
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "The summary of the incident event"
},
"status_page_id": {
"type": "string",
"description": "Unique ID of the status page you wish to post the event to"
},
"status": {
"type": "string",
"description": "The status of the incident event",
"enum": [
"investigating",
"identified",
"monitoring",
"resolved",
"scheduled",
"in_progress",
"verifying",
"completed"
]
},
"notify_subscribers": {
"type": "boolean",
"description": "Notify all status pages subscribers"
},
"should_tweet": {
"type": "boolean",
"description": "For Statuspage.io integrated pages auto publishes a tweet for your update"
},
"started_at": {
"type": "string",
"description": "Date of start"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"event",
"started_at",
"created_at",
"updated_at"
]
},
"incident_status_page_event_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident event"
},
"type": {
"type": "string",
"enum": [
"incident_status_page_events"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_status_page_event"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_status_page_event_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident event"
},
"type": {
"type": "string",
"enum": [
"incident_status_page_events"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_status_page_event"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_incident_type": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_types"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the incident type"
},
"description": {
"type": "string",
"description": "The description of the incident type",
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the incident type",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the incident type",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the incident type",
"items": {
"type": "string"
},
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this incident type",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this incident type",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_type": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_types"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the incident type"
},
"description": {
"type": "string",
"description": "The description of the incident type",
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the incident type",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the incident type",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the incident type",
"items": {
"type": "string"
},
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this incident type",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this incident type",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_type": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the incident type"
},
"slug": {
"type": "string",
"description": "The slug of the incident type"
},
"description": {
"type": "string",
"description": "The description of the incident type",
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the incident type",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the incident type",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the incident type",
"items": {
"type": "string"
},
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this incident type",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this incident type",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"incident_type_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident type"
},
"type": {
"type": "string",
"enum": [
"incident_types"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_type"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_type_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident type"
},
"type": {
"type": "string",
"enum": [
"incident_types"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_type"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_incident": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the incident. We will autogenerate one if null",
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the incident",
"enum": [
"test",
"test_sub",
"example",
"example_sub",
"normal",
"normal_sub",
"backfilled",
"scheduled"
],
"default": "normal",
"nullable": true
},
"parent_incident_id": {
"type": "string",
"description": "ID of parent incident",
"nullable": true
},
"duplicate_incident_id": {
"type": "string",
"description": "ID of duplicated incident",
"nullable": true
},
"private": {
"type": "boolean",
"description": "Create an incident as private. Once an incident is made as private it cannot be undone",
"default": false,
"nullable": true
},
"summary": {
"type": "string",
"description": "The summary of the incident",
"nullable": true
},
"user_id": {
"type": "string",
"description": "User ID of the creator of the incident. Default to the user attached to the Api Key",
"nullable": true
},
"severity_id": {
"type": "string",
"description": "The Severity ID to attach to the incident",
"nullable": true
},
"public_title": {
"type": "string",
"description": "The public title of the incident",
"nullable": true
},
"alert_ids": {
"type": "array",
"description": "The Alert ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "The Environment ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"incident_type_ids": {
"type": "array",
"description": "The Incident Type ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"description": "The Service ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"functionality_ids": {
"type": "array",
"description": "The Functionality ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"group_ids": {
"type": "array",
"description": "The Team ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"cause_ids": {
"type": "array",
"description": "The Cause ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"labels": {
"type": "object",
"description": "Labels to attach to the incidents. eg: {\"platform\":\"osx\", \"version\": \"1.29\"}",
"nullable": true
},
"slack_channel_name": {
"type": "string",
"description": "Slack channel name",
"nullable": true
},
"slack_channel_id": {
"type": "string",
"description": "Slack channel id",
"nullable": true
},
"slack_channel_url": {
"type": "string",
"description": "Slack channel url",
"nullable": true
},
"slack_channel_archived": {
"type": "boolean",
"description": "Whether the Slack channel is archived",
"nullable": true
},
"google_drive_parent_id": {
"type": "string",
"description": "Google Drive parent folder ID",
"nullable": true
},
"google_drive_url": {
"type": "string",
"description": "Google Drive URL",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails you want to notify",
"items": {
"type": "string"
},
"nullable": true
},
"status": {
"type": "string",
"description": "The status of the incident",
"enum": [
"in_triage",
"started",
"detected",
"acknowledged",
"mitigated",
"resolved",
"closed",
"cancelled",
"scheduled",
"in_progress",
"completed"
]
},
"url": {
"type": "string",
"description": "The url to the incident"
},
"scheduled_for": {
"type": "string",
"description": "Date of when the maintenance begins",
"nullable": true
},
"scheduled_until": {
"type": "string",
"description": "Date of when the maintenance ends",
"nullable": true
},
"in_triage_at": {
"type": "string",
"description": "Date of triage",
"nullable": true
},
"started_at": {
"type": "string",
"description": "Date of start",
"nullable": true
},
"detected_at": {
"type": "string",
"description": "Date of detection",
"nullable": true
},
"acknowledged_at": {
"type": "string",
"description": "Date of acknowledgment",
"nullable": true
},
"mitigated_at": {
"type": "string",
"description": "Date of mitigation",
"nullable": true
},
"resolved_at": {
"type": "string",
"description": "Date of resolution",
"nullable": true
},
"closed_at": {
"type": "string",
"description": "Date of closure",
"nullable": true
},
"cancelled_at": {
"type": "string",
"description": "Date of cancellation",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the incident",
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the incident",
"enum": [
"test",
"test_sub",
"example",
"example_sub",
"normal",
"normal_sub",
"backfilled",
"scheduled"
],
"default": "normal",
"nullable": true
},
"parent_incident_id": {
"type": "string",
"description": "ID of parent incident",
"nullable": true
},
"duplicate_incident_id": {
"type": "string",
"description": "ID of duplicated incident",
"nullable": true
},
"summary": {
"type": "string",
"description": "The summary of the incident",
"nullable": true
},
"status": {
"type": "string",
"description": "The status of the incident",
"enum": [
"in_triage",
"started",
"detected",
"acknowledged",
"mitigated",
"resolved",
"closed",
"cancelled",
"scheduled",
"in_progress",
"completed"
],
"nullable": true
},
"private": {
"type": "boolean",
"description": "Convert the incident as private. Once an incident is updated as private it cannot be undone",
"default": false,
"nullable": true
},
"severity_id": {
"type": "string",
"description": "The Severity ID to attach to the incident",
"nullable": true
},
"public_title": {
"type": "string",
"description": "The public title of the incident",
"nullable": true
},
"alert_ids": {
"type": "array",
"description": "The Alert ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "The Environment ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"incident_type_ids": {
"type": "array",
"description": "The Incident Type ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"description": "The Service ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"functionality_ids": {
"type": "array",
"description": "The Functionality ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"group_ids": {
"type": "array",
"description": "The Team ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"cause_ids": {
"type": "array",
"description": "The Cause ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"labels": {
"type": "object",
"description": "Labels to attach to the incidents. eg: {\"platform\":\"osx\", \"version\": \"1.29\"}",
"nullable": true
},
"slack_channel_id": {
"type": "string",
"description": "Slack channel id",
"nullable": true
},
"slack_channel_name": {
"type": "string",
"description": "Slack channel name",
"nullable": true
},
"slack_channel_url": {
"type": "string",
"description": "Slack channel url",
"nullable": true
},
"slack_channel_archived": {
"type": "boolean",
"description": "Whether the Slack channel is archived",
"nullable": true
},
"google_drive_parent_id": {
"type": "string",
"description": "Google Drive parent folder ID",
"nullable": true
},
"google_drive_url": {
"type": "string",
"description": "Google Drive URL",
"nullable": true
},
"scheduled_for": {
"type": "string",
"description": "Date of when the maintenance begins",
"nullable": true
},
"scheduled_until": {
"type": "string",
"description": "Date of when the maintenance ends",
"nullable": true
},
"in_triage_at": {
"type": "string",
"description": "Date of triage",
"nullable": true
},
"started_at": {
"type": "string",
"description": "Date of start",
"nullable": true
},
"detected_at": {
"type": "string",
"description": "Date of detection",
"nullable": true
},
"acknowledged_at": {
"type": "string",
"description": "Date of acknowledgment",
"nullable": true
},
"mitigated_at": {
"type": "string",
"description": "Date of mitigation",
"nullable": true
},
"resolved_at": {
"type": "string",
"description": "Date of resolution",
"nullable": true
},
"closed_at": {
"type": "string",
"description": "Date of closure",
"nullable": true
},
"cancelled_at": {
"type": "string",
"description": "Date of cancellation",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"in_triage_incident": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
}
},
"required": [
"type"
]
}
},
"required": [
"data"
]
},
"restart_incident": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": false
}
},
"required": [
"type"
]
}
},
"required": [
"data"
]
},
"mitigate_incident": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"properties": {
"mitigation_message": {
"type": "string",
"description": "How was the incident mitigated?",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"resolve_incident": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"properties": {
"resolution_message": {
"type": "string",
"description": "How was the incident resolved?",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"cancel_incident": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"properties": {
"cancellation_message": {
"type": "string",
"description": "Why was the incident cancelled?",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"duplicate_incident": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"properties": {
"duplicate_incident_id": {
"type": "string"
},
"auto_cancel_incident": {
"type": "boolean",
"default": true,
"nullable": true
},
"reason_for_cancellation": {
"type": "string",
"description": "Why was the incident cancelled?",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"add_subscribers": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"properties": {
"user_ids": {
"type": "array",
"description": "IDs of users you wish to add to list of subscribers for this incident",
"items": {
"type": "string"
},
"nullable": true
},
"remove_users_with_no_private_incident_access": {
"description": "Users without read permissions for private incidents will be removed from the subscriber list of this incident",
"type": "boolean",
"default": false,
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"remove_subscribers": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"properties": {
"user_ids": {
"type": "array",
"description": "IDs of users you wish to remove from the list of subscribers for this incident",
"items": {
"type": "string"
},
"nullable": true
},
"remove_users_with_no_private_incident_access": {
"description": "Users without read permissions for private incidents will be removed from the subscriber list of this incident",
"type": "boolean",
"default": false,
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"assign_role_to_user": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"properties": {
"user_id": {
"type": "string",
"description": "ID of user you wish to assign this incident",
"nullable": false
},
"incident_role_id": {
"type": "string",
"description": "ID of the incident role",
"nullable": false
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"unassign_role_from_user": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"properties": {
"user_id": {
"type": "string",
"description": "ID of user you wish to remove as assigned user from this incident",
"nullable": false
},
"incident_role_id": {
"type": "string",
"description": "ID of the incident role",
"nullable": false
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident"
},
"sequential_id": {
"type": "integer",
"description": "Sequential ID of the incident"
},
"title": {
"type": "string",
"description": "The title of the incident"
},
"kind": {
"type": "string",
"description": "The kind of the incident"
},
"slug": {
"type": "string",
"description": "The slug of the incident"
},
"parent_incident_id": {
"type": "string",
"description": "ID of parent incident",
"nullable": true
},
"duplicate_incident_id": {
"type": "string",
"description": "ID of duplicated incident",
"nullable": true
},
"summary": {
"type": "string",
"description": "The summary of the incident",
"nullable": true
},
"private": {
"type": "boolean",
"description": "Create an incident as private",
"default": false,
"nullable": true
},
"source": {
"type": "string",
"description": "The source of the incident",
"nullable": true
},
"status": {
"type": "string",
"description": "The status of the incident",
"nullable": true
},
"url": {
"type": "string",
"description": "The url to the incident",
"nullable": true
},
"short_url": {
"type": "string",
"description": "The short url to the incident",
"nullable": true
},
"public_title": {
"type": "string",
"description": "The public title of the incident",
"nullable": true
},
"user": {
"type": "object",
"description": "The user who created the incident",
"nullable": true
},
"severity": {
"type": "object",
"description": "The Severity of the incident",
"allOf": [
{
"$ref": "#/components/schemas/severity_response"
}
],
"nullable": true
},
"environments": {
"type": "array",
"description": "The Environments of the incident",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/environment_response"
}
]
},
"nullable": true
},
"incident_types": {
"type": "array",
"description": "The Incident Types of the incident",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_type_response"
}
]
},
"nullable": true
},
"services": {
"type": "array",
"description": "The Services of the incident",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/service_response"
}
]
},
"nullable": true
},
"functionalities": {
"type": "array",
"description": "The Functionalities of the incident",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/functionality_response"
}
]
},
"nullable": true
},
"groups": {
"type": "array",
"description": "The Teams of to the incident",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/team_response"
}
]
},
"nullable": true
},
"labels": {
"type": "object",
"description": "Labels to attach to the incidents. eg: {\"platform\":\"osx\", \"version\": \"1.29\"}",
"nullable": true
},
"slack_channel_id": {
"type": "string",
"description": "Slack channel id",
"nullable": true
},
"slack_channel_name": {
"type": "string",
"description": "Slack channel name",
"nullable": true
},
"slack_channel_url": {
"type": "string",
"description": "Slack channel url",
"nullable": true
},
"slack_channel_short_url": {
"type": "string",
"description": "Slack channel short url",
"nullable": true
},
"slack_channel_deep_link": {
"type": "string",
"description": "Slack channel deep link",
"nullable": true
},
"slack_channel_archived": {
"type": "boolean",
"description": "Whether the Slack channel is archived",
"nullable": true
},
"slack_last_message_ts": {
"type": "string",
"description": "Timestamp of last Slack message",
"nullable": true
},
"zoom_meeting_id": {
"type": "string",
"description": "Zoom meeting ID",
"nullable": true
},
"zoom_meeting_start_url": {
"type": "string",
"description": "Zoom meeting start URL",
"nullable": true
},
"zoom_meeting_join_url": {
"type": "string",
"description": "Zoom meeting join URL",
"nullable": true
},
"zoom_meeting_password": {
"type": "string",
"description": "Zoom meeting password",
"nullable": true
},
"zoom_meeting_pstn_password": {
"type": "string",
"description": "Zoom meeting PSTN password",
"nullable": true
},
"zoom_meeting_h323_password": {
"type": "string",
"description": "Zoom meeting H323 password",
"nullable": true
},
"zoom_meeting_global_dial_in_numbers": {
"type": "array",
"description": "Zoom meeting global dial-in numbers",
"items": {
"type": "string"
},
"nullable": true
},
"google_drive_id": {
"type": "string",
"description": "Google Drive document ID",
"nullable": true
},
"google_drive_parent_id": {
"type": "string",
"description": "Google Drive parent folder ID",
"nullable": true
},
"google_drive_url": {
"type": "string",
"description": "Google Drive URL",
"nullable": true
},
"google_meeting_id": {
"type": "string",
"description": "Google meeting ID",
"nullable": true
},
"google_meeting_url": {
"type": "string",
"description": "Google meeting URL",
"nullable": true
},
"jira_issue_key": {
"type": "string",
"description": "Jira issue key",
"nullable": true
},
"jira_issue_id": {
"type": "string",
"description": "Jira issue ID",
"nullable": true
},
"jira_issue_url": {
"type": "string",
"description": "Jira issue URL",
"nullable": true
},
"github_issue_id": {
"type": "string",
"description": "GitHub issue ID",
"nullable": true
},
"github_issue_url": {
"type": "string",
"description": "GitHub issue URL",
"nullable": true
},
"gitlab_issue_id": {
"type": "string",
"description": "GitLab issue ID",
"nullable": true
},
"gitlab_issue_url": {
"type": "string",
"description": "GitLab issue URL",
"nullable": true
},
"asana_task_id": {
"type": "string",
"description": "Asana task ID",
"nullable": true
},
"asana_task_url": {
"type": "string",
"description": "Asana task URL",
"nullable": true
},
"linear_issue_id": {
"type": "string",
"description": "Linear issue ID",
"nullable": true
},
"linear_issue_url": {
"type": "string",
"description": "Linear issue URL",
"nullable": true
},
"trello_card_id": {
"type": "string",
"description": "Trello card ID",
"nullable": true
},
"trello_card_url": {
"type": "string",
"description": "Trello card URL",
"nullable": true
},
"zendesk_ticket_id": {
"type": "string",
"description": "Zendesk ticket ID",
"nullable": true
},
"zendesk_ticket_url": {
"type": "string",
"description": "Zendesk ticket URL",
"nullable": true
},
"pagerduty_incident_id": {
"type": "string",
"description": "PagerDuty incident ID",
"nullable": true
},
"pagerduty_incident_number": {
"type": "string",
"description": "PagerDuty incident number",
"nullable": true
},
"pagerduty_incident_url": {
"type": "string",
"description": "PagerDuty incident URL",
"nullable": true
},
"opsgenie_incident_id": {
"type": "string",
"description": "Opsgenie incident ID",
"nullable": true
},
"opsgenie_incident_url": {
"type": "string",
"description": "Opsgenie incident URL",
"nullable": true
},
"opsgenie_alert_id": {
"type": "string",
"description": "Opsgenie alert ID",
"nullable": true
},
"opsgenie_alert_url": {
"type": "string",
"description": "Opsgenie alert URL",
"nullable": true
},
"service_now_incident_id": {
"type": "string",
"description": "ServiceNow incident ID",
"nullable": true
},
"service_now_incident_key": {
"type": "string",
"description": "ServiceNow incident key",
"nullable": true
},
"service_now_incident_url": {
"type": "string",
"description": "ServiceNow incident URL",
"nullable": true
},
"mattermost_channel_id": {
"type": "string",
"description": "Mattermost channel ID",
"nullable": true
},
"mattermost_channel_name": {
"type": "string",
"description": "Mattermost channel name",
"nullable": true
},
"mattermost_channel_url": {
"type": "string",
"description": "Mattermost channel URL",
"nullable": true
},
"confluence_page_id": {
"type": "string",
"description": "Confluence page ID",
"nullable": true
},
"confluence_page_url": {
"type": "string",
"description": "Confluence page URL",
"nullable": true
},
"datadog_notebook_id": {
"type": "string",
"description": "Datadog notebook ID",
"nullable": true
},
"datadog_notebook_url": {
"type": "string",
"description": "Datadog notebook URL",
"nullable": true
},
"shortcut_story_id": {
"type": "string",
"description": "Shortcut story ID",
"nullable": true
},
"shortcut_story_url": {
"type": "string",
"description": "Shortcut story URL",
"nullable": true
},
"shortcut_task_id": {
"type": "string",
"description": "Shortcut task ID",
"nullable": true
},
"shortcut_task_url": {
"type": "string",
"description": "Shortcut task URL",
"nullable": true
},
"motion_task_id": {
"type": "string",
"description": "Motion task ID",
"nullable": true
},
"motion_task_url": {
"type": "string",
"description": "Motion task URL",
"nullable": true
},
"clickup_task_id": {
"type": "string",
"description": "ClickUp task ID",
"nullable": true
},
"clickup_task_url": {
"type": "string",
"description": "ClickUp task URL",
"nullable": true
},
"victor_ops_incident_id": {
"type": "string",
"description": "VictorOps incident ID",
"nullable": true
},
"victor_ops_incident_url": {
"type": "string",
"description": "VictorOps incident URL",
"nullable": true
},
"quip_page_id": {
"type": "string",
"description": "Quip page ID",
"nullable": true
},
"quip_page_url": {
"type": "string",
"description": "Quip page URL",
"nullable": true
},
"sharepoint_page_id": {
"type": "string",
"description": "SharePoint page ID",
"nullable": true
},
"sharepoint_page_url": {
"type": "string",
"description": "SharePoint page URL",
"nullable": true
},
"airtable_base_key": {
"type": "string",
"description": "Airtable base key",
"nullable": true
},
"airtable_table_name": {
"type": "string",
"description": "Airtable table name",
"nullable": true
},
"airtable_record_id": {
"type": "string",
"description": "Airtable record ID",
"nullable": true
},
"airtable_record_url": {
"type": "string",
"description": "Airtable record URL",
"nullable": true
},
"freshservice_ticket_id": {
"type": "string",
"description": "Freshservice ticket ID",
"nullable": true
},
"freshservice_ticket_url": {
"type": "string",
"description": "Freshservice ticket URL",
"nullable": true
},
"freshservice_task_id": {
"type": "string",
"description": "Freshservice task ID",
"nullable": true
},
"freshservice_task_url": {
"type": "string",
"description": "Freshservice task URL",
"nullable": true
},
"mitigation_message": {
"type": "string",
"description": "How was the incident mitigated?",
"nullable": true
},
"resolution_message": {
"type": "string",
"description": "How was the incident resolved?",
"nullable": true
},
"cancellation_message": {
"type": "string",
"description": "Why was the incident cancelled?",
"nullable": true
},
"scheduled_for": {
"type": "string",
"description": "Date of when the maintenance begins",
"nullable": true
},
"scheduled_until": {
"type": "string",
"description": "Date of when the maintenance ends",
"nullable": true
},
"retrospective_progress_status": {
"type": "string",
"description": "The status of the retrospective progress",
"nullable": true,
"enum": [
"not_started",
"active",
"completed",
"skipped"
]
},
"in_triage_by": {
"type": "object",
"description": "The user who triaged the incident",
"nullable": true
},
"started_by": {
"type": "object",
"description": "The user who started the incident",
"nullable": true
},
"mitigated_by": {
"type": "object",
"description": "The user who mitigated the incident",
"nullable": true
},
"resolved_by": {
"type": "object",
"description": "The user who resolved the incident",
"nullable": true
},
"closed_by": {
"type": "object",
"description": "The user who closed the incident",
"nullable": true
},
"cancelled_by": {
"type": "object",
"description": "The user who cancelled the incident",
"nullable": true
},
"in_triage_at": {
"type": "string",
"description": "Date of triage",
"nullable": true
},
"started_at": {
"type": "string",
"description": "Date of start",
"nullable": true
},
"detected_at": {
"type": "string",
"description": "Date of detection",
"nullable": true
},
"acknowledged_at": {
"type": "string",
"description": "Date of acknowledgment",
"nullable": true
},
"mitigated_at": {
"type": "string",
"description": "Date of mitigation",
"nullable": true
},
"resolved_at": {
"type": "string",
"description": "Date of resolution",
"nullable": true
},
"closed_at": {
"type": "string",
"description": "Date of closure",
"nullable": true
},
"cancelled_at": {
"type": "string",
"description": "Date of cancellation",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"title",
"slug",
"created_at",
"updated_at"
]
},
"incident_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident"
},
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident"
},
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"ip_ranges": {
"type": "object",
"properties": {
"integrations_ipv4": {
"type": "array",
"description": "IPv4 addresses associated with Rootly integrations.",
"items": {
"type": "string"
}
},
"integrations_ipv6": {
"type": "array",
"description": "IPv6 addresses associated with Rootly integrations.",
"items": {
"type": "string"
}
},
"webhooks_ipv4": {
"type": "array",
"description": "IPv4 addresses associated with Rootly webhooks.",
"items": {
"type": "string"
}
},
"webhooks_ipv6": {
"type": "array",
"description": "IPv6 addresses associated with Rootly webhooks.",
"items": {
"type": "string"
}
}
},
"required": [
"integrations_ipv4",
"integrations_ipv6",
"webhooks_ipv4",
"webhooks_ipv6"
]
},
"ip_ranges_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the ip_ranges"
},
"type": {
"type": "string",
"enum": [
"ip_ranges"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ip_ranges"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"first": {
"type": "string"
},
"prev": {
"type": "string",
"nullable": true
},
"next": {
"type": "string",
"nullable": true
},
"last": {
"type": "string"
}
},
"required": [
"self",
"first",
"prev",
"next",
"last"
]
},
"new_on_call_shadow": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"on_call_shadows"
]
},
"attributes": {
"type": "object",
"properties": {
"shadowable_type": {
"type": "string",
"enum": [
"User",
"Schedule"
]
},
"shadowable_id": {
"type": "string",
"description": "ID of schedule or user the shadow user is shadowing",
"nullable": false
},
"shadow_user_id": {
"type": "integer",
"description": "Which user the shadow shift belongs to.",
"nullable": false
},
"starts_at": {
"type": "string",
"description": "Start datetime of shadow shift",
"format": "date-time",
"nullable": false
},
"ends_at": {
"type": "string",
"description": "End datetime for shadow shift",
"format": "date-time",
"nullable": false
}
},
"additionalProperties": false,
"required": [
"shadowable_type",
"shadow_user_id",
"shadowable_id",
"starts_at",
"ends_at"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_on_call_shadow": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"on_call_shadows"
]
},
"attributes": {
"type": "object",
"properties": {
"schedule_id": {
"type": "string",
"description": "ID of schedule the shadow shift belongs to",
"nullable": false
},
"shadowable_type": {
"type": "string",
"enum": [
"User",
"Schedule"
]
},
"shadowable_id": {
"type": "string",
"description": "ID of schedule or user the shadow user is shadowing",
"nullable": false
},
"shadow_user_id": {
"type": "integer",
"description": "Which user the shadow shift belongs to.",
"nullable": false
},
"starts_at": {
"type": "string",
"description": "Start datetime of shadow shift",
"format": "date-time",
"nullable": false
},
"ends_at": {
"type": "string",
"description": "End datetime for shadow shift",
"format": "date-time",
"nullable": false
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"on_call_shadow": {
"type": "object",
"properties": {
"schedule_id": {
"type": "string",
"description": "ID of schedule the shadow shift belongs to",
"nullable": false
},
"shadowable_type": {
"type": "string",
"enum": [
"User",
"Schedule"
]
},
"shadowable_id": {
"type": "string",
"description": "ID of schedule or user the shadow user is shadowing",
"nullable": false
},
"shadow_user_id": {
"type": "integer",
"description": "Which user the shadow shift belongs to.",
"nullable": false
},
"starts_at": {
"type": "string",
"description": "Start datetime of shadow shift",
"format": "date-time",
"nullable": false
},
"ends_at": {
"type": "string",
"description": "End datetime for shadow shift",
"format": "date-time",
"nullable": false
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"schedule_id",
"shadowable_type",
"shadow_user_id",
"shadowable_id",
"starts_at",
"ends_at"
]
},
"on_call_shadow_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of shadow shift"
},
"type": {
"type": "string",
"enum": [
"on_call_shadows"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/on_call_shadow"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"on_call_shadows_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique id of the on-call shadow shift"
},
"type": {
"type": "string",
"enum": [
"on_call_shadows"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/on_call_shadow"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_on_call_role": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"on_call_roles"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The role name."
},
"slug": {
"type": "string",
"description": "The role slug."
},
"system_role": {
"type": "string",
"description": "The kind of role (user and custom type roles are only editable)",
"items": {
"type": "string",
"enum": [
"admin",
"user",
"custom",
"no_access"
]
}
},
"alert_sources_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"update",
"delete"
]
}
},
"alert_urgency_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"alerts_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"update",
"read"
]
}
},
"api_keys_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"audits_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"contacts_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"read"
]
}
},
"escalation_policies_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"groups_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"heartbeats_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"integrations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"invitations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"live_call_routing_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"schedule_override_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"update"
]
}
},
"schedules_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"services_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"webhooks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"workflows_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
}
},
"additionalProperties": false,
"required": [
"name",
"system_role"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_on_call_role": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"on_call_roles"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The role name."
},
"slug": {
"type": "string",
"description": "The role slug."
},
"system_role": {
"type": "string",
"description": "The kind of role (user and custom type roles are only editable)",
"items": {
"type": "string",
"enum": [
"admin",
"user",
"custom",
"no_access"
]
}
},
"alert_sources_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"update",
"delete"
]
}
},
"alert_urgency_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"alerts_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"update",
"read"
]
}
},
"api_keys_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"audits_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"contacts_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"read"
]
}
},
"escalation_policies_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"groups_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"heartbeats_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"integrations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"invitations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"live_call_routing_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"schedule_override_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"update"
]
}
},
"schedules_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"services_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"webhooks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"workflows_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"on_call_role": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The role name."
},
"slug": {
"type": "string",
"description": "The role slug."
},
"system_role": {
"type": "string",
"description": "The kind of role",
"items": {
"type": "string",
"enum": [
"admin",
"user",
"custom",
"no_access"
]
}
},
"alert_sources_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"update",
"delete"
]
}
},
"alert_urgency_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"alerts_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"update",
"read"
]
}
},
"api_keys_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"audits_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"contacts_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"read"
]
}
},
"escalation_policies_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"groups_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"heartbeats_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"integrations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"invitations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"live_call_routing_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"schedule_override_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"update"
]
}
},
"schedules_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"services_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"webhooks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"workflows_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"name",
"slug",
"system_role",
"created_at",
"updated_at"
]
},
"on_call_role_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the on_call_role"
},
"type": {
"type": "string",
"enum": [
"on_call_roles"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/on_call_role"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"on_call_role_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the on_call_role"
},
"type": {
"type": "string",
"enum": [
"on_call_roles"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/on_call_role"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_override_shift": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"shifts"
]
},
"attributes": {
"type": "object",
"properties": {
"starts_at": {
"type": "string",
"description": "Start datetime of override shift",
"format": "date-time",
"nullable": false
},
"ends_at": {
"type": "string",
"description": "End datetime of override shift",
"format": "date-time",
"nullable": false
},
"user_id": {
"type": "integer",
"description": "Override shift user",
"nullable": false
}
},
"additionalProperties": false,
"required": [
"starts_at",
"ends_at",
"user_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_override_shift": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"shifts"
]
},
"attributes": {
"type": "object",
"properties": {
"user_id": {
"type": "integer",
"description": "Override shift user",
"nullable": false
}
},
"additionalProperties": false,
"required": [
"user_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"override_shift": {
"type": "object",
"properties": {
"schedule_id": {
"type": "string",
"description": "ID of schedule",
"nullable": false
},
"rotation_id": {
"type": "string",
"description": "ID of rotation",
"nullable": true
},
"starts_at": {
"type": "string",
"description": "Start datetime of shift",
"nullable": false
},
"ends_at": {
"type": "string",
"description": "End datetime of shift",
"nullable": false
},
"is_override": {
"type": "boolean",
"description": "Denotes shift is an override shift"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
},
"shift_override": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/shift_override_response"
}
],
"description": "Override metadata",
"nullable": true
},
"user": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user_response"
}
],
"description": "User metadata",
"nullable": false
}
},
"required": [
"schedule_id",
"rotation_id",
"starts_at",
"ends_at",
"is_override"
]
},
"override_shift_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the shift"
},
"type": {
"type": "string",
"enum": [
"shifts"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/override_shift"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"override_shift_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the shift"
},
"type": {
"type": "string",
"enum": [
"shifts"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/override_shift"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"shift_override": {
"type": "object",
"properties": {
"shift_id": {
"type": "string",
"description": "ID of shift",
"nullable": false
},
"created_by_user_id": {
"type": "integer",
"description": "User who created the override",
"nullable": false
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"shift_id",
"created_by_user_id"
]
},
"shift_override_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the shift override"
},
"type": {
"type": "string",
"enum": [
"shift_override"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/shift_override"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"new_playbook_task": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"playbook_tasks"
]
},
"attributes": {
"type": "object",
"properties": {
"task": {
"type": "string",
"description": "The task of the task"
},
"description": {
"type": "string",
"description": "The description of the task",
"nullable": true
},
"position": {
"type": "integer",
"description": "The position of the task",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"task"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_playbook_task": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"playbook_tasks"
]
},
"attributes": {
"type": "object",
"properties": {
"task": {
"type": "string",
"description": "The task of the task"
},
"description": {
"type": "string",
"description": "The description of the task",
"nullable": true
},
"position": {
"type": "integer",
"description": "The position of the task",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"playbook_task": {
"type": "object",
"properties": {
"playbook_id": {
"type": "string"
},
"task": {
"type": "string",
"description": "The task of the task"
},
"description": {
"type": "string",
"description": "The description of task",
"nullable": true
},
"position": {
"type": "integer",
"description": "The position of the task",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"task",
"created_at",
"updated_at"
]
},
"playbook_task_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the task"
},
"type": {
"type": "string",
"enum": [
"playbook_tasks"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/playbook_task"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"playbook_task_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the task"
},
"type": {
"type": "string",
"enum": [
"playbook_tasks"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/playbook_task"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_playbook": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"playbooks"
]
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the playbook"
},
"summary": {
"type": "string",
"description": "The summary of the playbook",
"nullable": true
},
"external_url": {
"type": "string",
"description": "The external url of the playbook",
"nullable": true
},
"severity_ids": {
"type": "array",
"description": "The Severity ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "The Environment ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"description": "The Service ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"functionality_ids": {
"type": "array",
"description": "The Functionality ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"group_ids": {
"type": "array",
"description": "The Team ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"incident_type_ids": {
"type": "array",
"description": "The Incident Type ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false,
"required": [
"title"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_playbook": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"playbooks"
]
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the playbook"
},
"summary": {
"type": "string",
"description": "The summary of the playbook",
"nullable": true
},
"external_url": {
"type": "string",
"description": "The external url of the playbook",
"nullable": true
},
"severity_ids": {
"type": "array",
"description": "The Severity ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "The Environment ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"description": "The Service ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"functionality_ids": {
"type": "array",
"description": "The Functionality ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"group_ids": {
"type": "array",
"description": "The Team ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"incident_type_ids": {
"type": "array",
"description": "The Incident Type ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"playbook": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the playbook"
},
"summary": {
"type": "string",
"description": "The summary of the playbook",
"nullable": true
},
"external_url": {
"type": "string",
"description": "The external url of the playbook",
"nullable": true
},
"severity_ids": {
"type": "array",
"description": "The Severity ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "The Environment ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"functionality_ids": {
"type": "array",
"description": "The Functionality ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"description": "The Service ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"group_ids": {
"type": "array",
"description": "The Team ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"incident_type_ids": {
"type": "array",
"description": "The Incident Type ID's to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"title",
"created_at",
"updated_at"
]
},
"playbook_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the playbook"
},
"type": {
"type": "string",
"enum": [
"playbooks"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/playbook"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"playbook_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the playbook"
},
"type": {
"type": "string",
"enum": [
"playbooks"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/playbook"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_post_mortem_template": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"post_mortem_templates"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the postmortem template"
},
"default": {
"type": "boolean",
"description": "Default selected template when editing a postmortem",
"nullable": true
},
"content": {
"type": "string",
"description": "The postmortem template. Liquid syntax is supported"
},
"format": {
"type": "string",
"description": "The format of the input",
"enum": [
"html",
"markdown"
],
"default": "html",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name",
"content"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_post_mortem_template": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"post_mortem_templates"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the postmortem template"
},
"default": {
"type": "boolean",
"description": "Default selected template when editing a postmortem",
"nullable": true
},
"content": {
"type": "string",
"description": "The postmortem template. Liquid syntax is supported"
},
"format": {
"type": "string",
"description": "The format of the input",
"enum": [
"html",
"markdown"
],
"default": "html",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"post_mortem_template": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the postmortem template"
},
"slug": {
"type": "string",
"description": "The slugified name of the postmortem template"
},
"default": {
"type": "boolean",
"description": "Default selected template when editing a postmortem",
"nullable": true
},
"content": {
"type": "string",
"description": "The postmortem template. Liquid syntax and markdown are supported"
},
"format": {
"type": "string",
"description": "The format of the input",
"enum": [
"html",
"markdown"
]
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"post_mortem_template_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the post_mortem_template"
},
"type": {
"type": "string",
"enum": [
"post_mortem_templates"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/post_mortem_template"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"post_mortem_template_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the post_mortem_template"
},
"type": {
"type": "string",
"enum": [
"post_mortem_templates"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/post_mortem_template"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_pulse": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"pulses"
]
},
"attributes": {
"type": "object",
"properties": {
"source": {
"type": "string",
"description": "The source of the pulse (eg: k8s)",
"nullable": true
},
"summary": {
"type": "string",
"description": "The summary of the pulse"
},
"service_ids": {
"type": "array",
"description": "The Service ID's to attach to the pulse",
"items": {
"type": "string"
},
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "The Environment ID's to attach to the pulse",
"items": {
"type": "string"
},
"nullable": true
},
"started_at": {
"type": "string",
"description": "Pulse start datetime",
"format": "date-time",
"nullable": true
},
"ended_at": {
"type": "string",
"description": "Pulse end datetime",
"format": "date-time",
"nullable": true
},
"external_url": {
"type": "string",
"description": "The external url of the pulse",
"nullable": true
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Key of the tag"
},
"value": {
"type": "string",
"description": "Value of the tag"
}
},
"required": [
"key",
"value"
],
"nullable": true
}
},
"refs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Key of the ref"
},
"value": {
"type": "string",
"description": "Value of the ref"
}
},
"required": [
"key",
"value"
],
"nullable": true
}
},
"data": {
"type": "object",
"description": "Additional data",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"summary"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_pulse": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"pulses"
]
},
"attributes": {
"type": "object",
"properties": {
"source": {
"type": "string",
"description": "The source of the pulse (eg: k8s)",
"nullable": true
},
"summary": {
"type": "string",
"description": "The summary of the pulse"
},
"service_ids": {
"type": "array",
"description": "The Service ID's to attach to the pulse",
"items": {
"type": "string"
},
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "The Environment ID's to attach to the pulse",
"items": {
"type": "string"
},
"nullable": true
},
"started_at": {
"type": "string",
"description": "Pulse start datetime",
"format": "date-time",
"nullable": true
},
"ended_at": {
"type": "string",
"description": "Pulse end datetime",
"format": "date-time",
"nullable": true
},
"external_url": {
"type": "string",
"description": "The external url of the pulse",
"nullable": true
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Key of the tag"
},
"value": {
"type": "string",
"description": "Value of the tag"
}
},
"required": [
"key",
"value"
],
"nullable": true
}
},
"refs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Key of the ref"
},
"value": {
"type": "string",
"description": "Value of the ref"
}
},
"required": [
"key",
"value"
],
"nullable": true
}
},
"data": {
"type": "object",
"description": "Additional data",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"summary",
"attributes"
]
}
},
"required": [
"data"
]
},
"pulse": {
"type": "object",
"properties": {
"source": {
"type": "string",
"description": "The source of the pulse (eg: k8s)",
"nullable": true
},
"summary": {
"type": "string",
"description": "The summary of the pulse"
},
"services": {
"type": "array",
"description": "Services attached to the pulse",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/service"
}
]
}
},
"environments": {
"type": "array",
"description": "Environments attached to the pulse",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/environment"
}
]
}
},
"external_url": {
"type": "string",
"description": "The external url of the pulse",
"nullable": true
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Key of the tag"
},
"value": {
"type": "string",
"description": "Value of the tag"
}
},
"required": [
"key",
"value"
],
"nullable": true
}
},
"refs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Key of the ref"
},
"value": {
"type": "string",
"description": "Value of the ref"
}
},
"required": [
"key",
"value"
],
"nullable": true
}
},
"data": {
"type": "object",
"description": "Additional data",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"summary",
"created_at",
"updated_at"
]
},
"pulse_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the pulse"
},
"type": {
"type": "string",
"enum": [
"pulses"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/pulse"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"pulse_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the pulse"
},
"type": {
"type": "string",
"enum": [
"pulses"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/pulse"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"update_retrospective_configuration": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"retrospective_configurations"
]
},
"attributes": {
"type": "object",
"properties": {
"severity_ids": {
"type": "array",
"description": "The Severity ID's to attach to the retrospective configuration",
"items": {
"type": "string"
},
"nullable": true
},
"group_ids": {
"type": "array",
"description": "The Team ID's to attach to the retrospective configuration",
"items": {
"type": "string"
},
"nullable": true
},
"incident_type_ids": {
"type": "array",
"description": "The Incident Type ID's to attach to the retrospective configuration",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"retrospective_configuration": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the configuration.",
"enum": [
"skip",
"mandatory"
]
},
"severity_ids": {
"type": "array",
"description": "The Severity ID's to attach to the retrospective configuration",
"items": {
"type": "string"
},
"nullable": true
},
"group_ids": {
"type": "array",
"description": "The Team ID's to attach to the retrospective configuration",
"items": {
"type": "string"
},
"nullable": true
},
"incident_type_ids": {
"type": "array",
"description": "The Incident Type ID's to attach to the retrospective configuration",
"items": {
"type": "string"
},
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
}
},
"retrospective_configuration_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the retrospective configuration"
},
"type": {
"type": "string",
"enum": [
"retrospective_configurations"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/retrospective_configuration"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"retrospective_configuration_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the configuration"
},
"type": {
"type": "string",
"enum": [
"retrospective_configurations"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/retrospective_configuration"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
}
},
"required": [
"data"
]
},
"new_retrospective_process": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"retrospective_processes"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the retrospective process"
},
"copy_from": {
"type": "string",
"description": "Retrospective process ID from which retrospective steps have to be copied. To use starter template for retrospective steps provide value: 'starter_template'"
},
"description": {
"type": "string",
"description": "The description of the retrospective process",
"nullable": true
},
"retrospective_process_matching_criteria": {
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"severity_ids": {
"type": "array",
"description": "Severity ID's for retrospective process matching criteria",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"severity_ids"
]
},
{
"type": "object",
"properties": {
"group_ids": {
"type": "array",
"description": "Team ID's for retrospective process matching criteria",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"group_ids"
]
},
{
"type": "object",
"properties": {
"incident_type_ids": {
"type": "array",
"description": "Incident type ID's for retrospective process matching criteria",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"incident_type_ids"
]
}
]
}
},
"additionalProperties": false,
"required": [
"name",
"copy_from"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_retrospective_process": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"retrospective_processes"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the retrospective process"
},
"description": {
"type": "string",
"description": "The description of the retrospective process",
"nullable": true
},
"retrospective_process_matching_criteria": {
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"severity_ids": {
"type": "array",
"description": "Severity ID's for retrospective process matching criteria",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"severity_ids"
]
},
{
"type": "object",
"properties": {
"group_ids": {
"type": "array",
"description": "Team ID's for retrospective process matching criteria",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"group_ids"
]
},
{
"type": "object",
"properties": {
"incident_type_ids": {
"type": "array",
"description": "Incident type ID's for retrospective process matching criteria",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"incident_type_ids"
]
}
]
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"retrospective_process": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the retrospective process"
},
"description": {
"type": "string",
"description": "The description of the retrospective process",
"nullable": true
},
"is_default": {
"type": "boolean",
"description": "Indicates the default process that Rootly created. This will be used as a fallback if no processes match the incident's conditions. The default process cannot have conditions and cannot be changed.",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
},
"retrospective_process_matching_criteria": {
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"severity_ids": {
"type": "array",
"description": "Severity ID's for retrospective process matching criteria",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"severity_ids"
]
},
{
"type": "object",
"properties": {
"group_ids": {
"type": "array",
"description": "Team ID's for retrospective process matching criteria",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"group_ids"
]
},
{
"type": "object",
"properties": {
"incident_type_ids": {
"type": "array",
"description": "Incident type ID's for retrospective process matching criteria",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"incident_type_ids"
]
}
]
}
}
},
"retrospective_process_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique id of retrospective process"
},
"type": {
"type": "string",
"enum": [
"retrospective_processes"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/retrospective_process"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"retrospective_process_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the retrospective process"
},
"type": {
"type": "string",
"enum": [
"retrospective_processes"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/retrospective_process"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_retrospective_step": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"retrospective_steps"
]
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The name of the step"
},
"description": {
"type": "string",
"description": "The description of the step",
"nullable": true
},
"due_after_days": {
"type": "integer",
"description": "Due date in days",
"nullable": true
},
"incident_role_id": {
"type": "string",
"description": "Users assigned to the selected incident role will be the default owners for this step",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the step",
"nullable": true
},
"skippable": {
"type": "boolean",
"description": "Is the step skippable?",
"nullable": false
}
},
"additionalProperties": false,
"required": [
"title"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_retrospective_step": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"retrospective_steps"
]
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The name of the step"
},
"description": {
"type": "string",
"description": "The description of the step",
"nullable": true
},
"incident_role_id": {
"type": "string",
"description": "Users assigned to the selected incident role will be the default owners for this step",
"nullable": true
},
"due_after_days": {
"type": "integer",
"description": "Due date in days",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the step",
"nullable": true
},
"skippable": {
"type": "boolean",
"description": "Is the step skippable?",
"nullable": false
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"retrospective_step": {
"type": "object",
"properties": {
"retrospective_process_id": {
"type": "string"
},
"title": {
"type": "string",
"description": "The name of the step"
},
"slug": {
"type": "string",
"description": "The slug of the step"
},
"description": {
"type": "string",
"description": "The description of the step",
"nullable": true
},
"incident_role_id": {
"type": "string",
"description": "Users assigned to the selected incident role will be the default owners for this step",
"nullable": true
},
"due_after_days": {
"type": "integer",
"description": "Due date in days",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the step"
},
"skippable": {
"type": "boolean",
"description": "Is the step skippable?"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"retrospective_process_id",
"title",
"created_at",
"updated_at"
]
},
"retrospective_step_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the step"
},
"type": {
"type": "string",
"enum": [
"retrospective_steps"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/retrospective_step"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"retrospective_step_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the step"
},
"type": {
"type": "string",
"enum": [
"retrospective_steps"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/retrospective_step"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_role": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"roles"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The role name."
},
"slug": {
"type": "string",
"description": "The role slug."
},
"incident_permission_set_id": {
"type": "string",
"description": "Associated incident permissions set.",
"nullable": true
},
"alerts_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read"
]
}
},
"api_keys_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"audits_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"billing_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"environments_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"form_fields_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"functionalities_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"groups_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_causes_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_feedbacks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_roles_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_types_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incidents_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"integrations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"invitations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"playbooks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"private_incidents_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"pulses_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"update",
"read"
]
}
},
"retrospective_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"roles_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"secrets_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"services_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"severities_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"status_pages_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"webhooks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"workflows_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_role": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"roles"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The role name."
},
"slug": {
"type": "string",
"description": "The role slug."
},
"incident_permission_set_id": {
"type": "string",
"description": "Associated incident permissions set.",
"nullable": true
},
"api_keys_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"audits_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"billing_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"environments_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"form_fields_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"functionalities_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"groups_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_causes_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_feedbacks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_roles_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_types_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incidents_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"integrations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"invitations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"playbooks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"private_incidents_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"retrospective_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"roles_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"secrets_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"services_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"severities_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"status_pages_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"webhooks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"workflows_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"role": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The role name."
},
"slug": {
"type": "string",
"description": "The role slug."
},
"incident_permission_set_id": {
"type": "string",
"description": "Associated incident permissions set.",
"nullable": true
},
"is_deletable": {
"type": "boolean",
"description": "Whether the role can be deleted."
},
"is_editable": {
"type": "boolean",
"description": "Whether the role can be edited."
},
"alerts_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read"
]
}
},
"api_keys_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"audits_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"billing_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"environments_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"form_fields_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"functionalities_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"groups_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_causes_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_feedbacks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_roles_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_types_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incidents_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"integrations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"invitations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"playbooks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"private_incidents_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"pulses_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"update",
"read"
]
}
},
"retrospective_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"roles_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"secrets_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"services_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"severities_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"status_pages_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"webhooks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"workflows_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"name",
"slug",
"created_at",
"updated_at"
]
},
"role_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the role"
},
"type": {
"type": "string",
"enum": [
"roles"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/role"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"role_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the role"
},
"type": {
"type": "string",
"enum": [
"roles"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/role"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_schedule_rotation_active_day": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"schedule_rotation_active_days"
]
},
"attributes": {
"type": "object",
"properties": {
"day_name": {
"type": "string",
"description": "Schedule rotation day name for which active times to be created",
"enum": [
"S",
"M",
"T",
"W",
"R",
"F",
"U"
]
},
"active_time_attributes": {
"type": "array",
"description": "Schedule rotation active times per day",
"items": {
"type": "object",
"properties": {
"start_time": {
"type": "string",
"description": "Start time for schedule rotation active time",
"format": "time"
},
"end_time": {
"type": "string",
"description": "End time for schedule rotation active time",
"format": "time"
}
}
}
}
},
"additionalProperties": false,
"required": [
"day_name",
"active_time_attributes"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_schedule_rotation_active_day": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"schedule_rotation_active_days"
]
},
"attributes": {
"type": "object",
"properties": {
"day_name": {
"type": "string",
"description": "Schedule rotation day name for which active times to be created",
"enum": [
"S",
"M",
"T",
"W",
"R",
"F",
"U"
]
},
"active_time_attributes": {
"type": "array",
"description": "Schedule rotation active times per day",
"items": {
"type": "object",
"properties": {
"start_time": {
"type": "string",
"description": "Start time for schedule rotation active time",
"format": "time"
},
"end_time": {
"type": "string",
"description": "End time for schedule rotation active time",
"format": "time"
}
}
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"schedule_rotation_active_day": {
"properties": {
"schedule_rotation_id": {
"type": "string"
},
"day_name": {
"type": "string",
"description": "Schedule rotation day name for which active times to be created",
"enum": [
"S",
"M",
"T",
"W",
"R",
"F",
"U"
]
},
"active_time_attributes": {
"type": "array",
"description": "Schedule rotation active times per day",
"items": {
"type": "object",
"properties": {
"start_time": {
"type": "string",
"description": "Start time for schedule rotation active time",
"format": "time"
},
"end_time": {
"type": "string",
"description": "End time for schedule rotation active time",
"format": "time"
}
}
}
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"schedule_rotation_id",
"day_name",
"active_time_attributes",
"created_at",
"updated_at"
]
},
"schedule_rotation_active_day_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the schedule rotation active time"
},
"type": {
"type": "string",
"enum": [
"schedule_rotation_active_days"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/schedule_rotation_active_day"
}
]
}
}
}
}
},
"schedule_rotation_active_day_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the schedule rotation active time"
},
"type": {
"type": "string",
"enum": [
"schedule_rotation_active_days"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/schedule_rotation_active_day"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_schedule_rotation_user": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"schedule_rotation_users"
]
},
"attributes": {
"type": "object",
"properties": {
"user_id": {
"type": "integer",
"description": "Schedule rotation user"
},
"position": {
"type": "integer",
"description": "Position of the user inside rotation"
}
},
"additionalProperties": false,
"required": [
"user_id"
]
}
}
}
}
},
"update_schedule_rotation_user": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"schedule_rotation_users"
]
},
"attributes": {
"type": "object",
"properties": {
"user_id": {
"type": "integer",
"description": "Schedule rotation user"
},
"position": {
"type": "integer",
"description": "Position of the user inside rotation"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"schedule_rotation_user": {
"type": "object",
"properties": {
"schedule_rotation_id": {
"type": "string"
},
"user_id": {
"type": "integer",
"description": "Schedule rotation user"
},
"position": {
"type": "integer",
"description": "Position of the user inside rotation"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"schedule_rotation_id",
"user_id",
"position",
"created_at",
"updated_at"
]
},
"schedule_rotation_user_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the schedule rotation user"
},
"type": {
"type": "string",
"enum": [
"schedule_rotation_users"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/schedule_rotation_user"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"schedule_rotation_user_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the schedule rotation user"
},
"type": {
"type": "string",
"enum": [
"schedule_rotation_users"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/schedule_rotation_user"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"new_schedule_rotation": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"schedule_rotations"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the schedule rotation"
},
"position": {
"type": "integer",
"description": "Position of the schedule rotation"
},
"schedule_rotationable_type": {
"type": "string",
"description": "Schedule rotation type",
"enum": [
"ScheduleDailyRotation",
"ScheduleWeeklyRotation",
"ScheduleBiweeklyRotation",
"ScheduleMonthlyRotation",
"ScheduleCustomRotation"
]
},
"active_all_week": {
"type": "boolean",
"description": "Schedule rotation active all week?",
"default": true
},
"active_days": {
"type": "array",
"items": {
"type": "string",
"description": "Schedule rotation active days",
"enum": [
"S",
"M",
"T",
"W",
"R",
"F",
"U"
]
}
},
"active_time_type": {
"type": "string",
"items": {
"type": "string",
"description": "Schedule rotation active time type",
"enum": [
"all_day",
"same_time",
"custom"
],
"default": "all_day"
}
},
"active_time_attributes": {
"type": "array",
"description": "Schedule rotation's active times",
"items": {
"type": "object",
"properties": {
"start_time": {
"type": "string",
"description": "Start time for schedule rotation active time",
"format": "time"
},
"end_time": {
"type": "string",
"description": "End time for schedule rotation active time",
"format": "time"
}
},
"required": [
"start_time",
"end_time"
]
}
},
"time_zone": {
"type": "string",
"description": "A valid IANA time zone name.",
"default": "Etc/UTC"
},
"schedule_rotationable_attributes": {
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"handoff_time": {
"type": "string",
"description": "Hand off time for daily rotation",
"format": "time"
}
},
"additionalProperties": false,
"required": [
"handoff_time"
]
},
{
"type": "object",
"properties": {
"handoff_time": {
"type": "string",
"description": "Hand off time for weekly/biweekly rotation",
"format": "time"
},
"handoff_day": {
"type": "string",
"description": "Hand off day for weekly/biweekly rotation",
"enum": [
"S",
"M",
"T",
"W",
"R",
"F",
"U"
]
}
},
"additionalProperties": false,
"required": [
"handoff_time",
"handoff_day"
]
},
{
"type": "object",
"properties": {
"handoff_time": {
"type": "string",
"description": "Hand off time for monthly rotation",
"format": "time"
},
"handoff_day": {
"type": "string",
"description": "Hand off day for monthly rotation",
"enum": [
"first_day_of_month",
"last_day_of_month"
]
}
},
"additionalProperties": false,
"required": [
"handoff_time",
"handoff_day"
]
},
{
"type": "object",
"properties": {
"shift_length": {
"type": "integer",
"description": "Shift length for custom rotation"
},
"shift_length_unit": {
"type": "string",
"description": "Shift length unit for custom rotation",
"enum": [
"hours",
"days",
"weeks"
]
},
"handoff_time": {
"type": "string",
"description": "Hand off time for custom rotation. Use minutes for hourly rotation.",
"format": "time"
}
},
"additionalProperties": false,
"required": [
"shift_length_unit",
"shift_length",
"handoff_time"
]
}
]
},
"start_time": {
"type": "string",
"format": "date",
"description": "ISO8601 date and time when rotation starts. Shifts will only be created after this time.",
"nullable": true
},
"end_time": {
"type": "string",
"format": "date",
"description": "ISO8601 date and time when rotation ends. Shifts will only be created before this time.",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name",
"schedule_rotationable_type",
"schedule_rotationable_attributes"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_schedule_rotation": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"schedule_rotations"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the schedule rotation"
},
"position": {
"type": "integer",
"description": "Position of the schedule rotation"
},
"schedule_rotationable_type": {
"type": "string",
"description": "Schedule rotation type",
"enum": [
"ScheduleDailyRotation",
"ScheduleWeeklyRotation",
"ScheduleBiweeklyRotation",
"ScheduleMonthlyRotation",
"ScheduleCustomRotation"
]
},
"active_all_week": {
"type": "boolean",
"description": "Schedule rotation active all week?",
"default": true
},
"active_days": {
"type": "array",
"items": {
"type": "string",
"description": "Schedule rotation active days",
"enum": [
"S",
"M",
"T",
"W",
"R",
"F",
"U"
]
}
},
"active_time_type": {
"type": "string",
"items": {
"type": "string",
"description": "Schedule rotation active time type",
"enum": [
"all_day",
"same_time",
"custom"
],
"default": "all_day"
}
},
"active_time_attributes": {
"type": "array",
"description": "Schedule rotation's active times",
"items": {
"type": "object",
"properties": {
"start_time": {
"type": "string",
"description": "Start time for schedule rotation active time",
"format": "time"
},
"end_time": {
"type": "string",
"description": "End time for schedule rotation active time",
"format": "time"
}
},
"required": [
"start_time",
"end_time"
]
}
},
"time_zone": {
"type": "string",
"description": "A valid IANA time zone name.",
"default": "Etc/UTC"
},
"schedule_rotationable_attributes": {
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"handoff_time": {
"type": "string",
"description": "Hand off time for daily rotation",
"format": "time"
}
},
"additionalProperties": false,
"required": [
"handoff_time"
]
},
{
"type": "object",
"properties": {
"handoff_time": {
"type": "string",
"description": "Hand off time for weekly/biweekly rotation",
"format": "time"
},
"handoff_day": {
"type": "string",
"description": "Hand off day for weekly/biweekly rotation",
"enum": [
"S",
"M",
"T",
"W",
"R",
"F",
"U"
]
}
},
"additionalProperties": false,
"required": [
"handoff_time",
"handoff_day"
]
},
{
"type": "object",
"properties": {
"handoff_time": {
"type": "string",
"description": "Hand off time for monthly rotation",
"format": "time"
},
"handoff_day": {
"type": "string",
"description": "Hand off day for monthly rotation",
"enum": [
"first_day_of_month",
"last_day_of_month"
]
}
},
"additionalProperties": false,
"required": [
"handoff_time",
"handoff_day"
]
},
{
"type": "object",
"properties": {
"shift_length": {
"type": "integer",
"description": "Shift length for custom rotation"
},
"shift_length_unit": {
"type": "string",
"description": "Shift length unit for custom rotation",
"enum": [
"hours",
"days",
"weeks"
]
},
"handoff_time": {
"type": "string",
"description": "Hand off time for custom rotation. Use minutes for hourly rotation.",
"format": "time"
}
},
"additionalProperties": false,
"required": [
"shift_length_unit",
"shift_length",
"handoff_time"
]
}
]
},
"start_time": {
"type": "string",
"format": "time",
"description": "ISO8601 date and time when rotation starts. Shifts will only be created after this time.",
"nullable": true
},
"end_time": {
"type": "string",
"format": "time",
"description": "ISO8601 date and time when rotation ends. Shifts will only be created before this time.",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"schedule_rotationable_type"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"schedule_rotation": {
"type": "object",
"properties": {
"schedule_id": {
"type": "string",
"description": "The ID of parent schedule"
},
"name": {
"type": "string",
"description": "The name of the schedule rotation"
},
"position": {
"type": "integer",
"description": "Position of the schedule rotation"
},
"schedule_rotationable_type": {
"type": "string",
"description": "Schedule rotation type",
"enum": [
"ScheduleDailyRotation",
"ScheduleWeeklyRotation",
"ScheduleBiweeklyRotation",
"ScheduleMonthlyRotation",
"ScheduleCustomRotation"
]
},
"active_all_week": {
"type": "boolean",
"description": "Schedule rotation active all week?",
"default": true
},
"active_days": {
"type": "array",
"items": {
"type": "string",
"description": "Schedule rotation active days",
"enum": [
"S",
"M",
"T",
"W",
"R",
"F",
"U"
]
}
},
"active_time_type": {
"type": "string",
"items": {
"type": "string",
"description": "Schedule rotation active time type",
"enum": [
"all_day",
"same_time",
"custom"
],
"default": "all_day"
}
},
"active_time_attributes": {
"type": "array",
"description": "Schedule rotation's active times",
"items": {
"type": "object",
"properties": {
"start_time": {
"type": "string",
"description": "Start time for schedule rotation active time",
"format": "time"
},
"end_time": {
"type": "string",
"description": "End time for schedule rotation active time",
"format": "time"
}
},
"required": [
"start_time",
"end_time"
]
}
},
"time_zone": {
"type": "string",
"description": "A valid IANA time zone name.",
"default": "Etc/UTC"
},
"schedule_rotationable_attributes": {
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"handoff_time": {
"type": "string",
"description": "Hand off time for daily rotation",
"format": "time"
}
},
"additionalProperties": false,
"required": [
"handoff_time"
]
},
{
"type": "object",
"properties": {
"handoff_time": {
"type": "string",
"description": "Hand off time for weekly/biweekly rotation",
"format": "time"
},
"handoff_day": {
"type": "string",
"description": "Hand off day for weekly/biweekly rotation",
"enum": [
"S",
"M",
"T",
"W",
"R",
"F",
"U"
]
}
},
"additionalProperties": false,
"required": [
"handoff_time",
"handoff_day"
]
},
{
"type": "object",
"properties": {
"handoff_time": {
"type": "string",
"description": "Hand off time for monthly rotation",
"format": "time"
},
"handoff_day": {
"type": "string",
"description": "Hand off day for monthly rotation",
"enum": [
"first_day_of_month",
"last_day_of_month"
]
}
},
"additionalProperties": false,
"required": [
"handoff_time",
"handoff_day"
]
},
{
"type": "object",
"properties": {
"shift_length": {
"type": "integer",
"description": "Shift length for custom rotation"
},
"shift_length_unit": {
"type": "string",
"description": "Shift length unit for custom rotation",
"enum": [
"hours",
"days",
"weeks"
]
},
"handoff_time": {
"type": "string",
"description": "Hand off time for custom rotation. Use minutes for hourly rotation.",
"format": "time"
}
},
"additionalProperties": false,
"required": [
"shift_length_unit",
"shift_length",
"handoff_time"
]
}
]
},
"start_time": {
"type": "string",
"format": "date",
"description": "ISO8601 date and time when rotation starts. Shifts will only be created after this time.",
"nullable": true
},
"end_time": {
"type": "string",
"format": "date",
"description": "ISO8601 date and time when rotation ends. Shifts will only be created before this time.",
"nullable": true
}
},
"required": [
"schedule_id",
"name",
"schedule_rotationable_type",
"schedule_rotationable_attributes"
]
},
"schedule_rotation_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the schedule rotation"
},
"type": {
"type": "string",
"enum": [
"schedule_rotations"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/schedule_rotation"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"schedule_rotation_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the schedule rotation"
},
"type": {
"type": "string",
"enum": [
"schedule_rotations"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/schedule_rotation"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_schedule": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"schedules"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the schedule"
},
"description": {
"type": "string",
"description": "The description of the schedule",
"nullable": true
},
"all_time_coverage": {
"type": "boolean",
"description": "24/7 coverage of the schedule",
"nullable": true
},
"slack_user_group": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
}
},
"owner_group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Owning teams."
},
"owner_user_id": {
"type": "integer",
"description": "ID of the owner of the schedule",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_schedule": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"schedules"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the schedule"
},
"description": {
"type": "string",
"description": "The description of the schedule",
"nullable": true
},
"all_time_coverage": {
"type": "boolean",
"description": "24/7 coverage of the schedule",
"nullable": true
},
"slack_user_group": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
}
},
"owner_group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Owning teams."
},
"owner_user_id": {
"type": "integer",
"description": "ID of the owner of the schedule",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"schedule": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the schedule"
},
"description": {
"type": "string",
"description": "The description of the schedule",
"nullable": true
},
"all_time_coverage": {
"type": "boolean",
"description": "24/7 coverage of the schedule",
"nullable": true
},
"slack_user_group": {
"type": "object",
"description": "Synced slack group of the schedule",
"nullable": true,
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
}
},
"owner_group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Owning teams."
},
"owner_user_id": {
"type": "integer",
"description": "ID of user assigned as owner of the schedule",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"schedule_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique id of schedule"
},
"type": {
"type": "string",
"enum": [
"schedules"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/schedule"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"schedule_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the schedule"
},
"type": {
"type": "string",
"enum": [
"schedules"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/schedule"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_secret": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"secrets"
]
},
"attributes": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the secret",
"enum": [
"built_in",
"hashicorp_vault"
]
},
"name": {
"type": "string",
"description": "The name of the secret"
},
"secret": {
"type": "string",
"description": "The secret"
},
"hashicorp_vault_mount": {
"type": "string",
"description": "The HashiCorp Vault secret mount path",
"nullable": true,
"default": "secret"
},
"hashicorp_vault_path": {
"type": "string",
"description": "The HashiCorp Vault secret path",
"nullable": true
},
"hashicorp_vault_version": {
"type": "string",
"description": "The HashiCorp Vault secret version",
"nullable": true,
"default": 0
}
},
"additionalProperties": false,
"required": [
"name",
"secret"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_secret": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"secrets"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the secret"
},
"secret": {
"type": "string",
"description": "The secret"
},
"hashicorp_vault_mount": {
"type": "string",
"description": "The HashiCorp Vault secret mount path",
"nullable": true,
"default": "secret"
},
"hashicorp_vault_path": {
"type": "string",
"description": "The HashiCorp Vault secret path",
"nullable": true
},
"hashicorp_vault_version": {
"type": "integer",
"description": "The HashiCorp Vault secret version",
"nullable": true,
"default": 0
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"secret": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the secret"
},
"secret": {
"type": "string",
"description": "The redacted secret"
},
"hashicorp_vault_mount": {
"type": "string",
"description": "The HashiCorp Vault secret mount path"
},
"hashicorp_vault_path": {
"type": "string",
"description": "The HashiCorp Vault secret path",
"nullable": true
},
"hashicorp_vault_version": {
"type": "integer",
"description": "The HashiCorp Vault secret version"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"secret_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the secret"
},
"type": {
"type": "string",
"enum": [
"secrets"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/secret"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"secret_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the secret"
},
"type": {
"type": "string",
"enum": [
"secrets"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/secret"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data"
]
},
"new_service": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"services"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the service"
},
"description": {
"type": "string",
"description": "The description of the service",
"nullable": true
},
"public_description": {
"type": "string",
"description": "The public description of the service",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the service",
"items": {
"type": "string"
},
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the service",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the service",
"nullable": true
},
"show_uptime": {
"type": "boolean",
"description": "Show uptime",
"nullable": true
},
"show_uptime_last_days": {
"type": "integer",
"description": "Show uptime over x days",
"enum": [
30,
60,
90
],
"nullable": true,
"default": 60
},
"backstage_id": {
"type": "string",
"description": "The Backstage entity id associated to this service. eg: :namespace/:kind/:entity_name",
"nullable": true
},
"pagerduty_id": {
"type": "string",
"description": "The PagerDuty service id associated to this service",
"nullable": true
},
"external_id": {
"type": "string",
"description": "The external id associated to this service",
"nullable": true
},
"opsgenie_id": {
"type": "string",
"description": "The Opsgenie service id associated to this service",
"nullable": true
},
"opsgenie_team_id": {
"type": "string",
"description": "The Opsgenie team id associated to this service",
"nullable": true
},
"cortex_id": {
"type": "string",
"description": "The Cortex group id associated to this service",
"nullable": true
},
"service_now_ci_sys_id": {
"type": "string",
"description": "The Service Now CI sys id associated to this service",
"nullable": true
},
"github_repository_name": {
"type": "string",
"description": "The GitHub repository name associated to this service. eg: rootlyhq/my-service",
"nullable": true
},
"github_repository_branch": {
"type": "string",
"description": "The GitHub repository branch associated to this service. eg: main",
"nullable": true
},
"gitlab_repository_name": {
"type": "string",
"description": "The GitLab repository name associated to this service. eg: rootlyhq/my-service",
"nullable": true
},
"gitlab_repository_branch": {
"type": "string",
"description": "The GitLab repository branch associated to this service. eg: main",
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "Environments associated with this service",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"description": "Services dependent on this service",
"items": {
"type": "string"
},
"nullable": true
},
"owner_group_ids": {
"type": "array",
"description": "Owner Teams associated with this service",
"items": {
"type": "string"
},
"nullable": true
},
"owner_user_ids": {
"type": "array",
"description": "Owner Users associated with this service",
"items": {
"type": "integer"
},
"nullable": true
},
"alerts_email_enabled": {
"type": "boolean",
"description": "Enable alerts through email",
"nullable": true
},
"alert_urgency_id": {
"type": "string",
"description": "The alert urgency id of the service",
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this service",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this service",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_service": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"services"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the service"
},
"description": {
"type": "string",
"description": "The description of the service",
"nullable": true
},
"public_description": {
"type": "string",
"description": "The public description of the service",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the service",
"items": {
"type": "string"
},
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the service",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the service",
"nullable": true
},
"backstage_id": {
"type": "string",
"description": "The Backstage entity id associated to this service. eg: :namespace/:kind/:entity_name",
"nullable": true
},
"external_id": {
"type": "string",
"description": "The external id associated to this service",
"nullable": true
},
"pagerduty_id": {
"type": "string",
"description": "The PagerDuty service id associated to this service",
"nullable": true
},
"opsgenie_id": {
"type": "string",
"description": "The Opsgenie service id associated to this service",
"nullable": true
},
"cortex_id": {
"type": "string",
"description": "The Cortex group id associated to this service",
"nullable": true
},
"service_now_ci_sys_id": {
"type": "string",
"description": "The Service Now CI sys id associated to this service",
"nullable": true
},
"github_repository_name": {
"type": "string",
"description": "The GitHub repository name associated to this service. eg: rootlyhq/my-service",
"nullable": true
},
"github_repository_branch": {
"type": "string",
"description": "The GitHub repository branch associated to this service. eg: main",
"nullable": true
},
"gitlab_repository_name": {
"type": "string",
"description": "The GitLab repository name associated to this service. eg: rootlyhq/my-service",
"nullable": true
},
"gitlab_repository_branch": {
"type": "string",
"description": "The GitLab repository branch associated to this service. eg: main",
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "Environments associated with this service",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"description": "Services dependent on this service",
"items": {
"type": "string"
},
"nullable": true
},
"owner_group_ids": {
"type": "array",
"description": "Owner Teams associated with this service",
"items": {
"type": "string"
},
"nullable": true
},
"owner_user_ids": {
"type": "array",
"description": "Owner Users associated with this service",
"items": {
"type": "integer"
},
"nullable": true
},
"alerts_email_enabled": {
"type": "boolean",
"description": "Enable alerts through email",
"nullable": true
},
"alert_urgency_id": {
"type": "string",
"description": "The alert urgency id of the service",
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this service",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this service",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"service": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the service"
},
"slug": {
"type": "string",
"description": "The slug of the service"
},
"description": {
"type": "string",
"description": "The description of the service",
"nullable": true
},
"public_description": {
"type": "string",
"description": "The public description of the service",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails attached to the service",
"items": {
"type": "string"
},
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the service",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the service",
"nullable": true
},
"backstage_id": {
"type": "string",
"description": "The Backstage entity id associated to this service. eg: :namespace/:kind/:entity_name",
"nullable": true
},
"external_id": {
"type": "string",
"description": "The external id associated to this service",
"nullable": true
},
"pagerduty_id": {
"type": "string",
"description": "The PagerDuty service id associated to this service",
"nullable": true
},
"opsgenie_id": {
"type": "string",
"description": "The Opsgenie service id associated to this service",
"nullable": true
},
"cortex_id": {
"type": "string",
"description": "The Cortex group id associated to this service",
"nullable": true
},
"service_now_ci_sys_id": {
"type": "string",
"description": "The Service Now CI sys id associated to this service",
"nullable": true
},
"github_repository_name": {
"type": "string",
"description": "The GitHub repository name associated to this service. eg: rootlyhq/my-service",
"nullable": true
},
"github_repository_branch": {
"type": "string",
"description": "The GitHub repository branch associated to this service. eg: main",
"nullable": true
},
"gitlab_repository_name": {
"type": "string",
"description": "The GitLab repository name associated to this service. eg: rootlyhq/my-service",
"nullable": true
},
"gitlab_repository_branch": {
"type": "string",
"description": "The GitLab repository branch associated to this service. eg: main",
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "Environments associated with this service",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"description": "Services dependent on this service",
"items": {
"type": "string"
},
"nullable": true
},
"owner_group_ids": {
"type": "array",
"description": "Owner Teams associated with this service",
"items": {
"type": "string"
},
"nullable": true
},
"owner_user_ids": {
"type": "array",
"description": "Owner Users associated with this service",
"items": {
"type": "integer"
},
"nullable": true
},
"alert_urgency_id": {
"type": "string",
"description": "The alert urgency id of the service",
"nullable": true
},
"alerts_email_enabled": {
"type": "boolean",
"description": "Enable alerts through email",
"nullable": true
},
"alerts_email_address": {
"type": "string",
"description": "Email generated to send alerts to",
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this service",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this service",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"service_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the service"
},
"type": {
"type": "string",
"enum": [
"services"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/service"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"service_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the service"
},
"type": {
"type": "string",
"enum": [
"services"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/service"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_severity": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"severities"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the severity"
},
"description": {
"type": "string",
"description": "The description of the severity",
"nullable": true
},
"severity": {
"type": "string",
"description": "The severity of the severity",
"enum": [
"critical",
"high",
"medium",
"low"
]
},
"color": {
"type": "string",
"description": "The hex color of the severity",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the severity",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the severity",
"items": {
"type": "string"
},
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this severity",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this severity",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_severity": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"severities"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the severity"
},
"description": {
"type": "string",
"description": "The description of the severity",
"nullable": true
},
"severity": {
"type": "string",
"description": "The severity of the severity",
"enum": [
"critical",
"high",
"medium",
"low"
]
},
"color": {
"type": "string",
"description": "The hex color of the severity",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the severity",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the severity",
"items": {
"type": "string"
},
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this severity",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this severity",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"severity": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the severity"
},
"slug": {
"type": "string",
"description": "The slug of the severity"
},
"description": {
"type": "string",
"description": "The description of the severity",
"nullable": true
},
"severity": {
"type": "string",
"description": "The severity of the severity",
"enum": [
"critical",
"high",
"medium",
"low"
]
},
"color": {
"type": "string",
"description": "The hex color of the severity",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the severity",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the severity",
"items": {
"type": "string"
},
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this severity",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this severity",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"severity_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the severity"
},
"type": {
"type": "string",
"enum": [
"severities"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/severity"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"severity_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the severity"
},
"type": {
"type": "string",
"enum": [
"severities"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/severity"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"shift": {
"type": "object",
"properties": {
"schedule_id": {
"type": "string",
"description": "ID of schedule",
"nullable": false
},
"rotation_id": {
"type": "string",
"description": "ID of rotation",
"nullable": true
},
"starts_at": {
"type": "string",
"description": "Start datetime of shift",
"nullable": false
},
"ends_at": {
"type": "string",
"description": "End datetime of shift",
"nullable": false
},
"is_override": {
"type": "boolean",
"description": "Denotes shift is an override shift"
},
"shift_override": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/shift_override_response"
}
],
"description": "Override metadata",
"nullable": true
},
"user": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user_response"
}
],
"description": "User metadata",
"nullable": false
}
},
"required": [
"schedule_id",
"rotation_id",
"starts_at",
"ends_at",
"is_override"
]
},
"shift_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the shift"
},
"type": {
"type": "string",
"enum": [
"shifts"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/shift"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
}
},
"required": [
"data"
]
},
"new_status_page_template": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"status_page_templates"
]
},
"attributes": {
"type": "object",
"properties": {
"status_page_id": {
"type": "string"
},
"title": {
"type": "string",
"description": "Title of the template"
},
"body": {
"type": "string",
"description": "Description of the event the template will populate"
},
"update_status": {
"type": "string",
"description": "Status of the event the template will populate",
"enum": [
"investigating",
"identified",
"monitoring",
"resolved",
"scheduled",
"in_progress",
"verifying",
"completed"
],
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the status page template",
"nullable": false,
"enum": [
"normal",
"scheduled"
]
},
"should_notify_subscribers": {
"type": "boolean",
"description": "Controls if incident subscribers should be notified",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the status page template"
},
"enabled": {
"type": "boolean",
"description": "Enable / Disable the status page template",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"title",
"body"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_status_page_template": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"status_page_templates"
]
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the template"
},
"body": {
"type": "string",
"description": "Description of the event the template will populate"
},
"update_status": {
"type": "string",
"description": "Status of the event the template will populate",
"enum": [
"investigating",
"identified",
"monitoring",
"resolved",
"scheduled",
"in_progress",
"verifying",
"completed"
],
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the status page template",
"nullable": false,
"enum": [
"normal",
"scheduled"
]
},
"should_notify_subscribers": {
"type": "boolean",
"description": "Controls if incident subscribers should be notified",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the workflow task"
},
"enabled": {
"type": "boolean",
"description": "Enable / Disable the status page template",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"title",
"body"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"status_page_template": {
"type": "object",
"properties": {
"status_page_id": {
"type": "string"
},
"title": {
"type": "string",
"description": "Title of the template"
},
"body": {
"type": "string",
"description": "Description of the event the template will populate"
},
"update_status": {
"type": "string",
"description": "Status of the event the template will populate",
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the status page template",
"nullable": false,
"enum": [
"normal",
"scheduled"
]
},
"should_notify_subscribers": {
"type": "boolean",
"description": "Controls if incident subscribers should be notified",
"nullable": true
},
"enabled": {
"type": "boolean",
"description": "Enable / Disable the status page template",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the workflow task"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"status_page_id",
"title",
"body",
"created_at",
"updated_at"
]
},
"status_page_template_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the status page template"
},
"type": {
"type": "string",
"enum": [
"status_page_templates"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/status_page_template"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"status_page_template_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the template"
},
"type": {
"type": "string",
"enum": [
"status_page_templates"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/status_page_template"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_status_page": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"status_pages"
]
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the status page"
},
"public_title": {
"type": "string",
"description": "The public title of the status page",
"nullable": true
},
"description": {
"type": "string",
"description": "The description of the status page",
"nullable": true
},
"public_description": {
"type": "string",
"description": "The public description of the status page",
"nullable": true
},
"header_color": {
"type": "string",
"description": "The color of the header. Eg. \"#0061F2\"",
"nullable": true
},
"footer_color": {
"type": "string",
"description": "The color of the footer. Eg. \"#1F2F41\"",
"nullable": true
},
"allow_search_engine_index": {
"type": "boolean",
"description": "Allow search engines to include your public status page in search results",
"nullable": true
},
"show_uptime": {
"type": "boolean",
"description": "Show uptime",
"nullable": true
},
"show_uptime_last_days": {
"type": "integer",
"description": "Show uptime over x days",
"enum": [
30,
60,
90
],
"nullable": true
},
"success_message": {
"type": "string",
"description": "Message showing when all components are operational",
"nullable": true
},
"failure_message": {
"type": "string",
"description": "Message showing when at least one component is not operational",
"nullable": true
},
"authentication_enabled": {
"type": "boolean",
"description": "Enable authentication",
"nullable": true,
"default": false
},
"authentication_password": {
"type": "string",
"description": "Authentication password",
"nullable": true
},
"website_url": {
"type": "string",
"description": "Website URL",
"nullable": true
},
"website_privacy_url": {
"type": "string",
"description": "Website Privacy URL",
"nullable": true
},
"website_support_url": {
"type": "string",
"description": "Website Support URL",
"nullable": true
},
"ga_tracking_id": {
"type": "string",
"description": "Google Analytics tracking ID",
"nullable": true
},
"time_zone": {
"type": "string",
"description": "A valid IANA time zone name.",
"default": "Etc/UTC",
"nullable": true
},
"public": {
"type": "boolean",
"description": "Make the status page accessible to the public",
"nullable": true
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Services attached to the status page"
},
"functionality_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Functionalities attached to the status page"
},
"enabled": {
"type": "boolean",
"description": "Enabled / Disable the status page",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"title"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_status_page": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"status_pages"
]
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the status page"
},
"public_title": {
"type": "string",
"description": "The public title of the status page",
"nullable": true
},
"description": {
"type": "string",
"description": "The description of the status page",
"nullable": true
},
"public_description": {
"type": "string",
"description": "The public description of the status page",
"nullable": true
},
"header_color": {
"type": "string",
"description": "The color of the header. Eg. \"#0061F2\"",
"nullable": true
},
"footer_color": {
"type": "string",
"description": "The color of the footer. Eg. \"#1F2F41\"",
"nullable": true
},
"allow_search_engine_index": {
"type": "boolean",
"description": "Allow search engines to include your public status page in search results",
"nullable": true
},
"show_uptime": {
"type": "boolean",
"description": "Show uptime",
"nullable": true
},
"show_uptime_last_days": {
"type": "integer",
"description": "Show uptime over x days",
"enum": [
30,
60,
90
],
"nullable": true
},
"success_message": {
"type": "string",
"description": "Message showing when all components are operational",
"nullable": true
},
"failure_message": {
"type": "string",
"description": "Message showing when at least one component is not operational",
"nullable": true
},
"authentication_enabled": {
"type": "boolean",
"description": "Enable authentication",
"nullable": true,
"default": false
},
"authentication_password": {
"type": "string",
"description": "Authentication password",
"nullable": true
},
"website_url": {
"type": "string",
"description": "Website URL",
"nullable": true
},
"website_privacy_url": {
"type": "string",
"description": "Website Privacy URL",
"nullable": true
},
"website_support_url": {
"type": "string",
"description": "Website Support URL",
"nullable": true
},
"ga_tracking_id": {
"type": "string",
"description": "Google Analytics tracking ID",
"nullable": true
},
"time_zone": {
"type": "string",
"description": "A valid IANA time zone name.",
"default": "Etc/UTC",
"nullable": true
},
"public": {
"type": "boolean",
"description": "Make the status page accessible to the public",
"nullable": true
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Services attached to the status page"
},
"functionality_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Functionalities attached to the status page"
},
"enabled": {
"type": "boolean",
"description": "Enabled / Disable the status page",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"status_page": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the status page"
},
"slug": {
"type": "string",
"description": "The slug of the status page"
},
"public_title": {
"type": "string",
"description": "The public title of the status page",
"nullable": true
},
"description": {
"type": "string",
"description": "The description of the status page",
"nullable": true
},
"public_description": {
"type": "string",
"description": "The public description of the status page",
"nullable": true
},
"header_color": {
"type": "string",
"description": "The color of the header. Eg. \"#0061F2\"",
"nullable": true
},
"footer_color": {
"type": "string",
"description": "The color of the footer. Eg. \"#1F2F41\"",
"nullable": true
},
"allow_search_engine_index": {
"type": "boolean",
"description": "Allow search engines to include your public status page in search results",
"nullable": true
},
"show_uptime": {
"type": "boolean",
"description": "Show uptime",
"nullable": true
},
"show_uptime_last_days": {
"type": "integer",
"description": "Show uptime over x days",
"enum": [
30,
60,
90
],
"nullable": true
},
"success_message": {
"type": "string",
"description": "Message showing when all components are operational",
"nullable": true
},
"failure_message": {
"type": "string",
"description": "Message showing when at least one component is not operational",
"nullable": true
},
"authentication_enabled": {
"type": "boolean",
"description": "Enable authentication",
"nullable": true,
"default": false
},
"authentication_password": {
"type": "string",
"description": "Authentication password",
"nullable": true
},
"website_url": {
"type": "string",
"description": "Website URL",
"nullable": true
},
"website_privacy_url": {
"type": "string",
"description": "Website Privacy URL",
"nullable": true
},
"website_support_url": {
"type": "string",
"description": "Website Support URL",
"nullable": true
},
"ga_tracking_id": {
"type": "string",
"description": "Google Analytics tracking ID",
"nullable": true
},
"time_zone": {
"type": "string",
"description": "A valid IANA time zone name.",
"default": "Etc/UTC",
"nullable": true
},
"public": {
"type": "boolean",
"description": "Make the status page accessible to the public",
"nullable": true
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Services attached to the status page"
},
"functionality_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Functionalities attached to the status page"
},
"external_domain_names": {
"type": "array",
"items": {
"type": "string"
},
"description": "External domain names attached to the status page"
},
"enabled": {
"type": "boolean",
"description": "Enabled / Disable the status page",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"title",
"created_at",
"updated_at"
]
},
"status_page_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the status page"
},
"type": {
"type": "string",
"enum": [
"status_pages"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/status_page"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"status_page_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the status page"
},
"type": {
"type": "string",
"enum": [
"status_pages"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/status_page"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_team": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"groups"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the team"
},
"description": {
"type": "string",
"description": "The description of the team",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the team",
"items": {
"type": "string"
},
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the team",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the team",
"nullable": true
},
"backstage_id": {
"type": "string",
"description": "The Backstage entity id associated to this team. eg: :namespace/:kind/:entity_name",
"nullable": true
},
"external_id": {
"type": "string",
"description": "The external id associated to this team",
"nullable": true
},
"pagerduty_id": {
"type": "string",
"description": "The PagerDuty group id associated to this team",
"nullable": true
},
"pagerduty_service_id": {
"type": "string",
"description": "The PagerDuty service id associated to this team",
"nullable": true
},
"opsgenie_id": {
"type": "string",
"description": "The Opsgenie group id associated to this team",
"nullable": true
},
"opsgenie_team_id": {
"type": "string",
"description": "The Opsgenie team id associated to this team",
"nullable": true
},
"victor_ops_id": {
"type": "string",
"description": "The VictorOps group id associated to this team",
"nullable": true
},
"pagertree_id": {
"type": "string",
"description": "The PagerTree group id associated to this team",
"nullable": true
},
"cortex_id": {
"type": "string",
"description": "The Cortex group id associated to this team",
"nullable": true
},
"service_now_ci_sys_id": {
"type": "string",
"description": "The Service Now CI sys id associated to this team",
"nullable": true
},
"user_ids": {
"type": "array",
"description": "The user ids of the members of this team.",
"items": {
"type": "integer"
},
"nullable": true
},
"admin_ids": {
"type": "array",
"description": "The user ids of the admins of this team. These users must also be present in user_ids attribute.",
"items": {
"type": "integer"
},
"nullable": true
},
"alerts_email_enabled": {
"type": "boolean",
"description": "Enable alerts through email",
"nullable": true
},
"alert_urgency_id": {
"type": "string",
"description": "The alert urgency id of the team",
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this team",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this team",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_team": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"groups"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the team"
},
"description": {
"type": "string",
"description": "The description of the team",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the team",
"items": {
"type": "string"
},
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the team",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the team",
"nullable": true
},
"backstage_id": {
"type": "string",
"description": "The Backstage entity id associated to this team. eg: :namespace/:kind/:entity_name",
"nullable": true
},
"external_id": {
"type": "string",
"description": "The external id associated to this team",
"nullable": true
},
"pagerduty_id": {
"type": "string",
"description": "The PagerDuty group id associated to this team",
"nullable": true
},
"pagerduty_service_id": {
"type": "string",
"description": "The PagerDuty service id associated to this team",
"nullable": true
},
"opsgenie_id": {
"type": "string",
"description": "The Opsgenie group id associated to this team",
"nullable": true
},
"victor_ops_id": {
"type": "string",
"description": "The VictorOps group id associated to this team",
"nullable": true
},
"pagertree_id": {
"type": "string",
"description": "The PagerTree group id associated to this team",
"nullable": true
},
"cortex_id": {
"type": "string",
"description": "The Cortex group id associated to this team",
"nullable": true
},
"service_now_ci_sys_id": {
"type": "string",
"description": "The Service Now CI sys id associated to this team",
"nullable": true
},
"user_ids": {
"type": "array",
"description": "The user ids of the members of this team.",
"items": {
"type": "integer"
},
"nullable": true
},
"admin_ids": {
"type": "array",
"description": "The user ids of the admins of this team. These users must also be present in user_ids attribute.",
"items": {
"type": "integer"
},
"nullable": true
},
"alerts_email_enabled": {
"type": "boolean",
"description": "Enable alerts through email",
"nullable": true
},
"alert_urgency_id": {
"type": "string",
"description": "The alert urgency id of the team",
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this team",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this team",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"team": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the team"
},
"slug": {
"type": "string"
},
"description": {
"type": "string",
"description": "The description of the team",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the team",
"items": {
"type": "string"
},
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the team",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the team",
"nullable": true
},
"backstage_id": {
"type": "string",
"description": "The Backstage entity id associated to this team. eg: :namespace/:kind/:entity_name",
"nullable": true
},
"external_id": {
"type": "string",
"description": "The external id associated to this team",
"nullable": true
},
"pagerduty_id": {
"type": "string",
"description": "The PagerDuty group id associated to this team",
"nullable": true
},
"pagerduty_service_id": {
"type": "string",
"description": "The PagerDuty service id associated to this team",
"nullable": true
},
"opsgenie_id": {
"type": "string",
"description": "The Opsgenie group id associated to this team",
"nullable": true
},
"victor_ops_id": {
"type": "string",
"description": "The VictorOps group id associated to this team",
"nullable": true
},
"pagertree_id": {
"type": "string",
"description": "The PagerTree group id associated to this team",
"nullable": true
},
"cortex_id": {
"type": "string",
"description": "The Cortex group id associated to this team",
"nullable": true
},
"service_now_ci_sys_id": {
"type": "string",
"description": "The Service Now CI sys id associated to this team",
"nullable": true
},
"user_ids": {
"type": "array",
"description": "The user ids of the members of this team.",
"items": {
"type": "integer"
},
"nullable": true
},
"admin_ids": {
"type": "array",
"description": "The user ids of the admins of this team. These users must also be present in user_ids attribute.",
"items": {
"type": "integer"
},
"nullable": true
},
"alerts_email_enabled": {
"type": "boolean",
"description": "Enable alerts through email",
"nullable": true
},
"alerts_email_address": {
"type": "string",
"description": "Email generated to send alerts to",
"nullable": true
},
"alert_urgency_id": {
"type": "string",
"description": "The alert urgency id of the team",
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this team",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this team",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"team_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the team"
},
"type": {
"type": "string",
"enum": [
"groups"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/team"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"team_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the team"
},
"type": {
"type": "string",
"enum": [
"groups"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/team"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_user_notification_rule": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"user_notification_rules"
]
},
"attributes": {
"type": "object",
"properties": {
"delay": {
"type": "integer",
"description": "Delay after which rule gets triggered",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the rule",
"nullable": true
},
"user_email_address_id": {
"type": "string",
"description": "User email address to which notification to be sent",
"nullable": true
},
"user_call_number_id": {
"type": "string",
"description": "User phone number to which notification to be sent",
"nullable": true
},
"user_sms_number_id": {
"type": "string",
"description": "User sms number to which notification to be sent",
"nullable": true
},
"user_device_id": {
"type": "string",
"description": "User device to which notification to be sent",
"nullable": true
},
"enabled_contact_types": {
"type": "array",
"description": "Contact types for which notification needs to be enabled",
"items": {
"type": "string",
"enum": [
"email",
"sms",
"call",
"device",
"non_critical_device"
]
},
"nullable": false
}
},
"additionalProperties": false,
"required": [
"enabled_contact_types"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_user_notification_rule": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"user_notification_rules"
]
},
"attributes": {
"type": "object",
"properties": {
"delay": {
"type": "integer",
"description": "Delay after which rule gets triggered",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the rule",
"nullable": true
},
"user_email_address_id": {
"type": "string",
"description": "User email address to which notification to be sent",
"nullable": true
},
"user_call_number_id": {
"type": "string",
"description": "User phone number to which notification to be sent",
"nullable": true
},
"user_sms_number_id": {
"type": "string",
"description": "User sms number to which notification to be sent",
"nullable": true
},
"user_device_id": {
"type": "string",
"description": "User device to which notification to be sent",
"nullable": true
},
"enabled_contact_types": {
"type": "array",
"description": "Contact types for which notification needs to be enabled",
"items": {
"type": "string",
"enum": [
"email",
"sms",
"call",
"device",
"non_critical_device"
]
},
"nullable": false
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"user_notification_rule": {
"type": "object",
"properties": {
"user_id": {
"type": "integer"
},
"delay": {
"type": "integer",
"description": "Delay after which rule gets triggered",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the rule",
"nullable": true
},
"user_email_address_id": {
"type": "string",
"description": "User email address to which notification to be sent",
"nullable": true
},
"user_call_number_id": {
"type": "string",
"description": "User phone number to which notification to be sent",
"nullable": true
},
"user_sms_number_id": {
"type": "string",
"description": "User sms number to which notification to be sent",
"nullable": true
},
"user_device_id": {
"type": "string",
"description": "User device to which notification to be sent",
"nullable": true
},
"enabled_contact_types": {
"type": "array",
"description": "Contact types for which notification needs to be enabled",
"items": {
"type": "string",
"enum": [
"email",
"sms",
"call",
"device",
"non_critical_device"
]
},
"nullable": false
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
}
},
"user_notification_rule_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the rule"
},
"type": {
"type": "string",
"enum": [
"user_notification_rules"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user_notification_rule"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"user_notification_rule_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the rule"
},
"type": {
"type": "string",
"enum": [
"user_notification_rules"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user_notification_rule"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_user_phone_number": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"user_phone_numbers"
]
},
"attributes": {
"type": "object",
"properties": {
"phone": {
"type": "string",
"description": "Phone number in international format"
}
},
"additionalProperties": false,
"required": [
"phone"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_user_phone_number": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"user_phone_numbers"
]
},
"attributes": {
"type": "object",
"properties": {
"phone": {
"type": "string",
"description": "Phone number in international format"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"user_phone_number": {
"type": "object",
"properties": {
"user_id": {
"type": "integer"
},
"phone": {
"type": "string",
"description": "Phone number in international format"
},
"primary": {
"type": "boolean",
"description": "Whether this is the primary phone number"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
}
},
"user_phone_number_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the phone number"
},
"type": {
"type": "string",
"enum": [
"user_phone_numbers"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user_phone_number"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"user_phone_number_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the phone number"
},
"type": {
"type": "string",
"enum": [
"user_phone_numbers"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user_phone_number"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_user_email_address": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"user_email_addresses"
]
},
"attributes": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email address"
}
},
"additionalProperties": false,
"required": [
"email"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_user_email_address": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"user_email_addresses"
]
},
"attributes": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email address"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"user_email_address": {
"type": "object",
"properties": {
"user_id": {
"type": "integer"
},
"email": {
"type": "string",
"description": "Email address"
},
"primary": {
"type": "boolean",
"description": "Whether this is the primary email address"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
}
},
"user_email_address_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the email address"
},
"type": {
"type": "string",
"enum": [
"user_email_addresses"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user_email_address"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"user_email_address_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the email address"
},
"type": {
"type": "string",
"enum": [
"user_email_addresses"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user_email_address"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"user": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The email of the user"
},
"first_name": {
"type": "string",
"description": "First name of the user",
"nullable": true
},
"last_name": {
"type": "string",
"description": "Last name of the user",
"nullable": true
},
"full_name": {
"type": "string",
"description": "The full name of the user",
"nullable": true
},
"full_name_with_team": {
"type": "string",
"description": "The full name with team of the user",
"nullable": true
},
"time_zone": {
"type": "string",
"description": "Configured time zone",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"email",
"created_at",
"updated_at"
]
},
"user_flat_response": {
"type": "object",
"description": "Flat user object as returned by serializer",
"properties": {
"id": {
"type": "integer",
"description": "User ID"
},
"email": {
"type": "string",
"description": "User email"
},
"first_name": {
"type": "string",
"description": "User first name",
"nullable": true
},
"last_name": {
"type": "string",
"description": "User last name",
"nullable": true
},
"full_name": {
"type": "string",
"description": "User full name",
"nullable": true
},
"full_name_with_team": {
"type": "string",
"description": "User full name with team",
"nullable": true
},
"time_zone": {
"type": "string",
"description": "User time zone",
"nullable": true
},
"created_at": {
"type": "string",
"description": "User creation timestamp"
},
"updated_at": {
"type": "string",
"description": "User last update timestamp"
}
},
"required": [
"id",
"email",
"created_at",
"updated_at"
]
},
"role_relationship": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"roles"
]
}
},
"nullable": true
}
}
},
"on_call_role_relationship": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"on_call_roles"
]
}
},
"nullable": true
}
}
},
"user_relationships": {
"type": "object",
"properties": {
"role": {
"$ref": "#/components/schemas/role_relationship"
},
"on_call_role": {
"$ref": "#/components/schemas/on_call_role_relationship"
}
}
},
"update_user": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"users"
]
},
"attributes": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"description": "First name of the user",
"nullable": true
},
"last_name": {
"type": "string",
"description": "Last name of the user",
"nullable": true
},
"role_id": {
"type": "string",
"description": "ID of the role to assign",
"nullable": true
},
"on_call_role_id": {
"type": "string",
"description": "ID of the on-call role to assign",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"user_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the user"
},
"type": {
"type": "string",
"enum": [
"users"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user"
}
]
},
"relationships": {
"$ref": "#/components/schemas/user_relationships"
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"user_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the user"
},
"type": {
"type": "string",
"enum": [
"users"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user"
}
]
},
"relationships": {
"$ref": "#/components/schemas/user_relationships"
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"webhooks_delivery": {
"type": "object",
"properties": {
"endpoint_id": {
"type": "string"
},
"payload": {
"type": "string"
},
"delivered_at": {
"type": "string",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"endpoint_id",
"payload",
"delivered_at",
"created_at",
"updated_at"
]
},
"webhooks_delivery_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the webhooks_delivery"
},
"type": {
"type": "string",
"enum": [
"webhooks_deliveries"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/webhooks_delivery"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"webhooks_delivery_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the webhooks_delivery"
},
"type": {
"type": "string",
"enum": [
"webhooks_deliveries"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/webhooks_delivery"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data"
]
},
"new_webhooks_endpoint": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"webhooks_endpoints"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the endpoint"
},
"url": {
"type": "string",
"description": "The URL of the endpoint."
},
"secret": {
"type": "string",
"description": "The webhook signing secret used to verify webhook requests."
},
"event_types": {
"type": "array",
"items": {
"type": "string",
"enum": [
"incident.created",
"incident.updated",
"incident.in_triage",
"incident.mitigated",
"incident.resolved",
"incident.cancelled",
"incident.deleted",
"incident.scheduled.created",
"incident.scheduled.updated",
"incident.scheduled.in_progress",
"incident.scheduled.completed",
"incident.scheduled.deleted",
"incident_post_mortem.created",
"incident_post_mortem.updated",
"incident_post_mortem.published",
"incident_post_mortem.deleted",
"incident_status_page_event.created",
"incident_status_page_event.updated",
"incident_status_page_event.deleted",
"incident_event.created",
"incident_event.updated",
"incident_event.deleted",
"alert.created",
"pulse.created",
"genius_workflow_run.queued",
"genius_workflow_run.started",
"genius_workflow_run.completed",
"genius_workflow_run.failed",
"genius_workflow_run.canceled"
]
}
},
"enabled": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"name",
"url"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_webhooks_endpoint": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"webhooks_endpoints"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the endpoint"
},
"event_types": {
"type": "array",
"items": {
"type": "string",
"enum": [
"incident.created",
"incident.updated",
"incident.in_triage",
"incident.mitigated",
"incident.resolved",
"incident.cancelled",
"incident.deleted",
"incident.scheduled.created",
"incident.scheduled.updated",
"incident.scheduled.in_progress",
"incident.scheduled.completed",
"incident.scheduled.deleted",
"incident_post_mortem.created",
"incident_post_mortem.updated",
"incident_post_mortem.published",
"incident_post_mortem.deleted",
"incident_status_page_event.created",
"incident_status_page_event.updated",
"incident_status_page_event.deleted",
"incident_event.created",
"incident_event.updated",
"incident_event.deleted",
"alert.created",
"pulse.created",
"genius_workflow_run.queued",
"genius_workflow_run.started",
"genius_workflow_run.completed",
"genius_workflow_run.failed",
"genius_workflow_run.canceled"
]
}
},
"enabled": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"webhooks_endpoint": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the endpoint"
},
"slug": {
"type": "string",
"description": "The slug of the endpoint"
},
"url": {
"type": "string",
"description": "The URL of the endpoint."
},
"event_types": {
"type": "array",
"items": {
"type": "string",
"enum": [
"incident.created",
"incident.updated",
"incident.in_triage",
"incident.mitigated",
"incident.resolved",
"incident.cancelled",
"incident.deleted",
"incident.scheduled.created",
"incident.scheduled.updated",
"incident.scheduled.in_progress",
"incident.scheduled.completed",
"incident.scheduled.deleted",
"incident_post_mortem.created",
"incident_post_mortem.updated",
"incident_post_mortem.published",
"incident_post_mortem.deleted",
"incident_status_page_event.created",
"incident_status_page_event.updated",
"incident_status_page_event.deleted",
"incident_event.created",
"incident_event.updated",
"incident_event.deleted",
"alert.created",
"pulse.created",
"genius_workflow_run.queued",
"genius_workflow_run.started",
"genius_workflow_run.completed",
"genius_workflow_run.failed",
"genius_workflow_run.canceled"
]
}
},
"secret": {
"type": "string",
"description": "The webhook signing secret used to verify webhook requests."
},
"enabled": {
"type": "boolean"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"slug",
"url",
"event_types",
"secret",
"enabled",
"created_at",
"updated_at"
]
},
"webhooks_endpoint_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the webhooks_endpoint"
},
"type": {
"type": "string",
"enum": [
"webhooks_endpoints"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/webhooks_endpoint"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"webhooks_endpoint_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the webhooks_endpoint"
},
"type": {
"type": "string",
"enum": [
"webhooks_endpoints"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/webhooks_endpoint"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data"
]
},
"new_sub_status": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"sub_statuses"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"parent_status": {
"type": "string",
"enum": [
"started",
"retrospective"
]
},
"position": {
"type": "integer",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name",
"parent_status"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_sub_status": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"sub_statuses"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"position": {
"type": "integer",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"sub_status": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"parent_status": {
"type": "string",
"enum": [
"in_triage",
"started",
"resolved",
"closed",
"cancelled",
"scheduled",
"in_progress",
"completed"
]
},
"position": {
"type": "integer",
"nullable": true
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"name",
"parent_status",
"created_at",
"updated_at"
]
},
"sub_status_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the sub_status"
},
"type": {
"type": "string",
"enum": [
"sub_statuses"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/sub_status"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"sub_status_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the sub_status"
},
"type": {
"type": "string",
"enum": [
"sub_statuses"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/sub_status"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_incident_sub_status": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_sub_statuses"
]
},
"attributes": {
"type": "object",
"properties": {
"sub_status_id": {
"type": "string",
"description": "Note: To change an incident's sub-status, use the PATCH /incidents/:id endpoint and set the sub_status_id attribute. This endpoint is for modifying the timestamp of when an incident's sub-status was assigned."
},
"assigned_at": {
"type": "string"
},
"assigned_by_user_id": {
"type": "integer",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"sub_status_id",
"assigned_at"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_sub_status": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_sub_statuses"
]
},
"attributes": {
"type": "object",
"properties": {
"sub_status_id": {
"type": "string",
"description": "Note: To change an incident's sub-status, use the PATCH /incidents/:id endpoint and set the sub_status_id attribute. This endpoint is for modifying the timestamp of when an incident's sub-status was assigned."
},
"assigned_at": {
"type": "string"
},
"assigned_by_user_id": {
"type": "integer",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_sub_status": {
"type": "object",
"properties": {
"incident_id": {
"type": "string"
},
"sub_status_id": {
"type": "string",
"description": "Note: To change an incident's sub-status, use the PATCH /incidents/:id endpoint and set the sub_status_id attribute. This endpoint is for modifying the timestamp of when an incident's sub-status was assigned."
},
"assigned_at": {
"type": "string"
},
"assigned_by_user_id": {
"type": "integer",
"nullable": true
}
},
"required": [
"incident_id",
"sub_status_id",
"assigned_at"
]
},
"incident_sub_status_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident_sub_status"
},
"type": {
"type": "string",
"enum": [
"incident_sub_statuses"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_sub_status"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_sub_status_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident_sub_status"
},
"type": {
"type": "string",
"enum": [
"incident_sub_statuses"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_sub_status"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_retrospective_process_group": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"retrospective_process_groups"
]
},
"attributes": {
"type": "object",
"properties": {
"sub_status_id": {
"type": "string"
},
"position": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"sub_status_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_retrospective_process_group": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"retrospective_process_groups"
]
},
"attributes": {
"type": "object",
"properties": {
"sub_status_id": {
"type": "string"
},
"position": {
"type": "integer"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"retrospective_process_group": {
"type": "object",
"properties": {
"retrospective_process_id": {
"type": "string"
},
"sub_status_id": {
"type": "string"
},
"position": {
"type": "integer"
}
},
"required": [
"retrospective_process_id",
"sub_status_id",
"position"
]
},
"retrospective_process_group_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the retrospective_process_group"
},
"type": {
"type": "string",
"enum": [
"retrospective_process_groups"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/retrospective_process_group"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"retrospective_process_group_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the retrospective_process_group"
},
"type": {
"type": "string",
"enum": [
"retrospective_process_groups"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/retrospective_process_group"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
},
"new_retrospective_process_group_step": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"retrospective_process_group_steps"
]
},
"attributes": {
"type": "object",
"properties": {
"retrospective_step_id": {
"type": "string"
},
"position": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"retrospective_step_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_retrospective_process_group_step": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"retrospective_process_group_steps"
]
},
"attributes": {
"type": "object",
"properties": {
"position": {
"type": "integer"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"retrospective_process_group_step": {
"type": "object",
"properties": {
"retrospective_process_group_id": {
"type": "string"
},
"retrospective_step_id": {
"type": "string"
},
"position": {
"type": "integer"
}
},
"required": [
"retrospective_process_group_id",
"retrospective_step_id",
"position"
]
},
"retrospective_process_group_step_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the retrospective_process_group_step"
},
"type": {
"type": "string",
"enum": [
"retrospective_process_group_steps"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/retrospective_process_group_step"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"retrospective_process_group_step_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the retrospective_process_group_step"
},
"type": {
"type": "string",
"enum": [
"retrospective_process_group_steps"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/retrospective_process_group_step"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
}
},
"required": [
"data",
"links"
]
}
}
}
}
