{ "components": { "schemas": { "APIKeyActorV1": { "example": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "properties": { "id": { "description": "Unique identifier for this API key", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "The name of the API key, for the user's reference", "example": "My test API key", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "APIKeyActorV2": { "example": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "properties": { "id": { "description": "Unique identifier for this API key", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "The name of the API key, for the user's reference", "example": "My test API key", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "APIKeyRoleV1": { "example": { "description": "can view data, like public incidents and organization settings", "name": "viewer" }, "properties": { "description": { "description": "Human readable description of the role", "example": "can view data, like public incidents and organization settings", "type": "string" }, "name": { "description": "API key role name", "enum": [ "viewer", "incident_creator", "incident_editor", "manage_settings", "global_access", "catalog_viewer", "catalog_editor", "incident_memberships_editor", "schedules_editor", "schedules_reader", "schedule_overrides_editor", "workflows_editor", "private_workflows_editor", "on_call_editor", "escalation_creator", "post_incident_flow_opt_out", "security_settings_editor", "investigation_download", "team_memberships_manage", "status_page_publisher", "postmortems_manage", "api_keys_manage", "notification_methods_manage" ], "example": "viewer", "type": "string", "x-public-api-version": "v1" } }, "required": [ "name", "description" ], "type": "object" }, "APIKeyTeamRoleV1": { "example": { "description": "can view data, like public incidents and organization settings", "name": "schedules_editor" }, "properties": { "description": { "description": "Human readable description of the role", "example": "can view data, like public incidents and organization settings", "type": "string" }, "name": { "description": "API key role name that may be granted for team-scoped access", "enum": [ "schedules_editor", "schedules_reader", "schedule_overrides_editor", "on_call_editor", "escalation_creator", "api_keys_manage" ], "example": "schedules_editor", "type": "string", "x-public-api-version": "v1" } }, "required": [ "name", "description" ], "type": "object" }, "APIKeyV1": { "example": { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_used_at": "2021-08-17T13:28:57.801578Z", "name": "My test API key", "roles": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "team_ids": [ "abc123" ], "team_roles": [ { "description": "can view data, like public incidents and organization settings", "name": "schedules_editor" } ], "token_last_issued_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "created_at": { "description": "When the API key was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "creator": { "$ref": "#/components/schemas/ActorV1" }, "id": { "description": "Unique identifier for this API key", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "last_used_at": { "description": "When the key was last used to authenticate a request", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "name": { "description": "The name of the API key, for the user's reference", "example": "My test API key", "type": "string" }, "roles": { "description": "The account-level roles assigned to this API key", "example": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "items": { "$ref": "#/components/schemas/APIKeyRoleV1" }, "type": "array" }, "team_ids": { "description": "IDs of teams that this API key is scoped to", "example": [ "abc123" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "team_roles": { "description": "The team-level roles assigned to this API key", "example": [ { "description": "can view data, like public incidents and organization settings", "name": "schedules_editor" } ], "items": { "$ref": "#/components/schemas/APIKeyTeamRoleV1" }, "type": "array" }, "token_last_issued_at": { "description": "When the current token for this API was last issued. This is the last time the token was rotated, or when it was initially created. Older tokens may remain valid for up to an hour after they have been rotated, configured when you call the rotate endpoint.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "roles", "team_ids", "team_roles", "creator", "created_at", "token_last_issued_at" ], "type": "object" }, "APIKeysCreatePayloadV1": { "example": { "name": "My test API key", "role_names": [ "viewer", "incident_creator" ], "team_ids": [ "01FCNDV6P870EA6S7TK1DSYDG0" ], "team_role_names": [ "schedules_editor" ] }, "properties": { "name": { "description": "Human-readable name for the new API key", "example": "My test API key", "maxLength": 200, "minLength": 1, "type": "string" }, "role_names": { "description": "Account-level roles to assign to the API key. These roles apply across the entire account, not scoped to specific teams. Pass an empty array if no account-level roles are needed.", "example": [ "viewer", "incident_creator" ], "items": { "enum": [ "viewer", "incident_creator", "incident_editor", "manage_settings", "global_access", "catalog_viewer", "catalog_editor", "incident_memberships_editor", "schedules_editor", "schedules_reader", "schedule_overrides_editor", "workflows_editor", "private_workflows_editor", "on_call_editor", "escalation_creator", "post_incident_flow_opt_out", "security_settings_editor", "investigation_download", "team_memberships_manage", "status_page_publisher", "postmortems_manage", "api_keys_manage", "notification_methods_manage" ], "example": "viewer", "type": "string" }, "type": "array" }, "team_ids": { "description": "IDs of teams to scope the `team_role_names` to. If provided, `team_role_names` must also be a non-empty array, and vice versa. Pass an empty array if the key should not be scoped to any teams.", "example": [ "01FCNDV6P870EA6S7TK1DSYDG0" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "team_role_names": { "description": "Roles to grant for the teams specified in `team_ids`. If provided, `team_ids` must also be a non-empty array, and vice versa. Pass an empty array if no team-level roles are needed.", "example": [ "schedules_editor" ], "items": { "enum": [ "schedules_editor", "schedules_reader", "schedule_overrides_editor", "on_call_editor", "escalation_creator", "api_keys_manage" ], "example": "schedules_editor", "type": "string" }, "type": "array" } }, "required": [ "name", "role_names", "team_ids", "team_role_names" ], "type": "object" }, "APIKeysCreateResultV1": { "example": { "api_key": { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_used_at": "2021-08-17T13:28:57.801578Z", "name": "My test API key", "roles": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "team_ids": [ "abc123" ], "team_roles": [ { "description": "can view data, like public incidents and organization settings", "name": "schedules_editor" } ], "token_last_issued_at": "2021-08-17T13:28:57.801578Z" }, "token": "inc_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef" }, "properties": { "api_key": { "$ref": "#/components/schemas/APIKeyV1" }, "token": { "description": "The bearer token to use in API requests. This is the only time the token is returned — store it securely.", "example": "inc_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef", "type": "string" } }, "required": [ "api_key", "token" ], "type": "object" }, "APIKeysListResultV1": { "example": { "api_keys": [ { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_used_at": "2021-08-17T13:28:57.801578Z", "name": "My test API key", "roles": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "team_ids": [ "abc123" ], "team_roles": [ { "description": "can view data, like public incidents and organization settings", "name": "schedules_editor" } ], "token_last_issued_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "api_keys": { "example": [ { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_used_at": "2021-08-17T13:28:57.801578Z", "name": "My test API key", "roles": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "team_ids": [ "abc123" ], "team_roles": [ { "description": "can view data, like public incidents and organization settings", "name": "schedules_editor" } ], "token_last_issued_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/APIKeyV1" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV1" } }, "required": [ "api_keys", "pagination_meta" ], "type": "object" }, "APIKeysRotatePayloadV1": { "example": { "grace_period_minutes": 30 }, "properties": { "grace_period_minutes": { "default": 30, "description": "How many minutes to keep the old access token alive.", "example": 30, "format": "int64", "maximum": 60, "minimum": 0, "type": "integer" } }, "required": [ "grace_period_minutes" ], "type": "object" }, "APIKeysRotateResultV1": { "example": { "api_key": { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_used_at": "2021-08-17T13:28:57.801578Z", "name": "My test API key", "roles": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "team_ids": [ "abc123" ], "team_roles": [ { "description": "can view data, like public incidents and organization settings", "name": "schedules_editor" } ], "token_last_issued_at": "2021-08-17T13:28:57.801578Z" }, "token": "inc_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef" }, "properties": { "api_key": { "$ref": "#/components/schemas/APIKeyV1" }, "token": { "description": "The new bearer token to use in API requests. This is the only time the token is returned — store it securely.", "example": "inc_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef", "type": "string" } }, "required": [ "api_key", "token" ], "type": "object" }, "APIKeysShowResultV1": { "example": { "api_key": { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_used_at": "2021-08-17T13:28:57.801578Z", "name": "My test API key", "roles": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "team_ids": [ "abc123" ], "team_roles": [ { "description": "can view data, like public incidents and organization settings", "name": "schedules_editor" } ], "token_last_issued_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "api_key": { "$ref": "#/components/schemas/APIKeyV1" } }, "required": [ "api_key" ], "type": "object" }, "APIKeysUpdatePayloadV1": { "example": { "name": "My test API key", "role_names": [ "viewer", "incident_creator" ], "team_ids": [ "01FCNDV6P870EA6S7TK1DSYDG0" ], "team_role_names": [ "schedules_editor" ] }, "properties": { "name": { "description": "Human-readable name for the API key", "example": "My test API key", "maxLength": 200, "minLength": 1, "type": "string" }, "role_names": { "description": "Account-level roles for the API key. These roles apply across the entire account, not scoped to specific teams. Pass an empty array if no account-level roles are needed.", "example": [ "viewer", "incident_creator" ], "items": { "enum": [ "viewer", "incident_creator", "incident_editor", "manage_settings", "global_access", "catalog_viewer", "catalog_editor", "incident_memberships_editor", "schedules_editor", "schedules_reader", "schedule_overrides_editor", "workflows_editor", "private_workflows_editor", "on_call_editor", "escalation_creator", "post_incident_flow_opt_out", "security_settings_editor", "investigation_download", "team_memberships_manage", "status_page_publisher", "postmortems_manage", "api_keys_manage", "notification_methods_manage" ], "example": "viewer", "type": "string" }, "type": "array" }, "team_ids": { "description": "IDs of teams to scope the `team_role_names` to. If provided, `team_role_names` must also be a non-empty array, and vice versa. Pass an empty array if the key should not be scoped to any teams.", "example": [ "01FCNDV6P870EA6S7TK1DSYDG0" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "team_role_names": { "description": "Roles to grant for the teams specified in `team_ids`. If provided, `team_ids` must also be a non-empty array, and vice versa. Pass an empty array if no team-level roles are needed.", "example": [ "schedules_editor" ], "items": { "enum": [ "schedules_editor", "schedules_reader", "schedule_overrides_editor", "on_call_editor", "escalation_creator", "api_keys_manage" ], "example": "schedules_editor", "type": "string" }, "type": "array" } }, "required": [ "name", "role_names", "team_ids", "team_role_names" ], "type": "object" }, "APIKeysUpdateResultV1": { "example": { "api_key": { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_used_at": "2021-08-17T13:28:57.801578Z", "name": "My test API key", "roles": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "team_ids": [ "abc123" ], "team_roles": [ { "description": "can view data, like public incidents and organization settings", "name": "schedules_editor" } ], "token_last_issued_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "api_key": { "$ref": "#/components/schemas/APIKeyV1" } }, "required": [ "api_key" ], "type": "object" }, "ActionV1": { "example": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "follow_up": true, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "assignee": { "$ref": "#/components/schemas/UserV1" }, "completed_at": { "description": "When the action was completed", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "created_at": { "description": "When the action was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "Description of the action", "example": "Call the fire brigade", "type": "string" }, "external_issue_reference": { "$ref": "#/components/schemas/ExternalIssueReferenceV1" }, "follow_up": { "description": "Whether an action is marked as follow-up", "example": true, "type": "boolean" }, "id": { "description": "Unique identifier for the action", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_id": { "description": "Unique identifier of the incident the action belongs to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "status": { "description": "Status of the action", "enum": [ "outstanding", "completed", "deleted", "not_doing" ], "example": "outstanding", "type": "string" }, "updated_at": { "description": "When the action was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "incident_id", "status", "follow_up", "created_at", "updated_at" ], "type": "object" }, "ActionV2": { "example": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "assignee": { "$ref": "#/components/schemas/UserV2" }, "completed_at": { "description": "When the action was completed", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "created_at": { "description": "When the action was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "creator": { "$ref": "#/components/schemas/ActorV2" }, "description": { "description": "Description of the action", "example": "Call the fire brigade", "type": "string" }, "id": { "description": "Unique identifier for the action", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_id": { "description": "Unique identifier of the incident the action belongs to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "status": { "description": "Status of the action", "enum": [ "outstanding", "completed", "deleted", "not_doing" ], "example": "outstanding", "type": "string" }, "updated_at": { "description": "When the action was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "incident_id", "creator", "description", "status", "created_at", "updated_at" ], "type": "object" }, "ActionsListResultV1": { "example": { "actions": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "follow_up": true, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "actions": { "example": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "follow_up": true, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/ActionV1" }, "type": "array" } }, "required": [ "actions" ], "type": "object" }, "ActionsListResultV2": { "example": { "actions": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "actions": { "example": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/ActionV2" }, "type": "array" } }, "required": [ "actions" ], "type": "object" }, "ActionsShowResultV1": { "example": { "action": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "follow_up": true, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "action": { "$ref": "#/components/schemas/ActionV1" } }, "required": [ "action" ], "type": "object" }, "ActionsShowResultV2": { "example": { "action": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "action": { "$ref": "#/components/schemas/ActionV2" } }, "required": [ "action" ], "type": "object" }, "ActorV1": { "example": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "properties": { "api_key": { "$ref": "#/components/schemas/APIKeyActorV1" }, "user": { "$ref": "#/components/schemas/UserV1" } }, "type": "object" }, "ActorV2": { "example": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "properties": { "alert": { "$ref": "#/components/schemas/AlertActorV2" }, "api_key": { "$ref": "#/components/schemas/APIKeyActorV2" }, "user": { "$ref": "#/components/schemas/UserV2" }, "workflow": { "$ref": "#/components/schemas/WorkflowActorV2" } }, "type": "object" }, "AfterPaginationMetaResultV2": { "example": { "after": "abc123", "after_url": "abc123" }, "properties": { "after": { "description": "The time, if it exists, of the last entry's end time", "example": "abc123", "type": "string" }, "after_url": { "description": "The URL to fetch the next page of entries", "example": "abc123", "type": "string" } }, "required": [ "after", "after_url" ], "type": "object" }, "AlertActorV2": { "example": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "properties": { "id": { "description": "The ID of this alert", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "title": { "description": "The title of the alert, parsed from the alert payload according to the alert source configuration", "example": "*errors.withMessage: PG::Error failed to connect", "type": "string" } }, "required": [ "id", "title" ], "type": "object" }, "AlertAttributeCatalogEntryV2": { "example": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "properties": { "catalog_type_id": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "id": { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Name is the human readable name of this entry", "example": "Primary On-call", "type": "string" } }, "required": [ "id", "catalog_type_id", "name" ], "type": "object" }, "AlertAttributeEntryV2": { "example": { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } }, "properties": { "array_value": { "description": "The value of the attribute if it is an array", "example": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "items": { "$ref": "#/components/schemas/AlertAttributeValueV2" }, "type": "array" }, "attribute": { "$ref": "#/components/schemas/AlertAttributeV2" }, "value": { "$ref": "#/components/schemas/AlertAttributeValueV2" } }, "required": [ "attribute" ], "type": "object" }, "AlertAttributeV2": { "example": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "properties": { "array": { "description": "Whether this attribute is an array", "example": false, "type": "boolean" }, "emoji": { "description": "The emoji to display alongside this attribute in chat messages, stored without colons", "example": "fire", "type": "string" }, "id": { "description": "The ID of this attribute", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "name": { "description": "Unique name of this attribute", "example": "service", "type": "string" }, "required": { "description": "Whether this attribute is required. If this field is not set, the existing setting will be preserved.", "example": false, "type": "boolean" }, "type": { "description": "Engine resource name for this attribute", "example": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]", "type": "string" } }, "required": [ "id", "name", "type", "array", "required" ], "type": "object" }, "AlertAttributeValueV2": { "example": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" }, "properties": { "catalog_entry": { "$ref": "#/components/schemas/AlertAttributeCatalogEntryV2" }, "label": { "description": "The human readable label of this value for convenience. Will match the literal if this is a primitive type, or be the name of the catalog entry if this is a catalog entry", "example": "Payments Team", "type": "string" }, "literal": { "description": "If set, this is the literal value of the step parameter", "example": "SEV123", "type": "string" } }, "type": "object" }, "AlertAttributesCreatePayloadV2": { "example": { "array": false, "emoji": "fire", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "properties": { "array": { "description": "Whether this attribute is an array", "example": false, "type": "boolean" }, "emoji": { "description": "The emoji to display alongside this attribute in chat messages, stored without colons", "example": "fire", "type": "string" }, "name": { "description": "Unique name of this attribute", "example": "service", "type": "string" }, "required": { "description": "Whether this attribute is required. If this field is not set, the existing setting will be preserved.", "example": false, "type": "boolean" }, "type": { "description": "Engine resource name for this attribute", "example": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]", "type": "string" } }, "required": [ "name", "type", "array" ], "type": "object" }, "AlertAttributesCreateResultV2": { "example": { "alert_attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" } }, "properties": { "alert_attribute": { "$ref": "#/components/schemas/AlertAttributeV2" } }, "required": [ "alert_attribute" ], "type": "object" }, "AlertAttributesListResultV2": { "example": { "alert_attributes": [ { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" } ] }, "properties": { "alert_attributes": { "example": [ { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" } ], "items": { "$ref": "#/components/schemas/AlertAttributeV2" }, "type": "array" } }, "required": [ "alert_attributes" ], "type": "object" }, "AlertAttributesShowResultV2": { "example": { "alert_attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" } }, "properties": { "alert_attribute": { "$ref": "#/components/schemas/AlertAttributeV2" } }, "required": [ "alert_attribute" ], "type": "object" }, "AlertAttributesUpdatePayloadV2": { "example": { "array": false, "emoji": "fire", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "properties": { "array": { "description": "Whether this attribute is an array", "example": false, "type": "boolean" }, "emoji": { "description": "The emoji to display alongside this attribute in chat messages, stored without colons", "example": "fire", "type": "string" }, "name": { "description": "Unique name of this attribute", "example": "service", "type": "string" }, "required": { "description": "Whether this attribute is required. If this field is not set, the existing setting will be preserved.", "example": false, "type": "boolean" }, "type": { "description": "Engine resource name for this attribute", "example": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]", "type": "string" } }, "required": [ "name", "type", "array" ], "type": "object" }, "AlertAttributesUpdateResultV2": { "example": { "alert_attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" } }, "properties": { "alert_attribute": { "$ref": "#/components/schemas/AlertAttributeV2" } }, "required": [ "alert_attribute" ], "type": "object" }, "AlertEventsCreateHTTPPayloadV2": { "example": { "deduplication_key": "4293868629", "description": "We've detected a number of timeouts on hello.world.com, the service may be down. To fix...", "metadata": { "service": "hello.world.com", "team": [ "my-team" ] }, "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect" }, "properties": { "deduplication_key": { "description": "A deduplication key which uniquely references this alert from your alert source. For newly created HTTP sources, this field is required.\nIf you send an event with the same deduplication_key multiple times, only one alert will be created in incident.io for this alert source config.\nYou can filter on this field to find the alert created by an event you've sent us.", "example": "4293868629", "type": "string" }, "description": { "description": "Description that optionally adds more detail to title. Supports markdown.", "example": "We've detected a number of timeouts on hello.world.com, the service may be down. To fix...", "type": "string" }, "metadata": { "additionalProperties": true, "description": "Any additional metadata that you've configured your alert source to parse", "example": { "service": "hello.world.com", "team": [ "my-team" ] }, "type": "object" }, "source_url": { "description": "If applicable, a link to the alert in the upstream system", "example": "https://www.my-alerting-platform.com/alerts/my-alert-123", "type": "string" }, "status": { "description": "Current status of this alert", "enum": [ "firing", "resolved" ], "example": "firing", "type": "string" }, "title": { "description": "The title of the alert, parsed from the alert payload according to the alert source configuration", "example": "*errors.withMessage: PG::Error failed to connect", "type": "string" } }, "required": [ "title", "status" ], "type": "object" }, "AlertEventsCreateHTTPResultV2": { "example": { "deduplication_key": "unique-key", "message": "Event accepted for processing", "status": "success" }, "properties": { "deduplication_key": { "description": "The deduplication key that the event has been processed with", "example": "unique-key", "type": "string" }, "message": { "description": "Human readable message giving detail about the event", "example": "Event accepted for processing", "type": "string" }, "status": { "description": "Status of the event", "example": "success", "type": "string" } }, "required": [ "status", "message", "deduplication_key" ], "type": "object" }, "AlertRouteAlertSourcePayloadV2": { "example": { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "properties": { "alert_source_id": { "description": "The alert source ID that will match for the route", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "condition_groups": { "description": "What conditions should alerts from this source meet to be included in this alert route?", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" } }, "required": [ "alert_source_id", "condition_groups" ], "type": "object" }, "AlertRouteAlertSourceV2": { "example": { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "properties": { "alert_source_id": { "description": "The alert source ID that will match for the route", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "condition_groups": { "description": "What conditions should alerts from this source meet to be included in this alert route?", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV2" }, "type": "array" } }, "required": [ "alert_source_id", "condition_groups" ], "type": "object" }, "AlertRouteAutoGeneratedTemplateBindingPayloadV2": { "example": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "autogenerated": { "description": "Whether this attribute is autogenerated using AI or not", "example": false, "type": "boolean" }, "binding": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" } }, "type": "object" }, "AlertRouteAutoGeneratedTemplateBindingV2": { "example": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "autogenerated": { "description": "Whether this attribute is autogenerated using AI or not", "example": false, "type": "boolean" }, "binding": { "$ref": "#/components/schemas/EngineParamBindingV2" } }, "required": [ "autogenerated" ], "type": "object" }, "AlertRouteChannelConfigPayloadV2": { "example": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } }, "properties": { "condition_groups": { "description": "The conditions that must be met for this channel config to be used", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" }, "ms_teams_targets": { "$ref": "#/components/schemas/AlertRouteChannelTargetPayloadV2" }, "slack_targets": { "$ref": "#/components/schemas/AlertRouteChannelTargetPayloadV2" } }, "required": [ "condition_groups" ], "type": "object" }, "AlertRouteChannelConfigV2": { "example": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } }, "properties": { "condition_groups": { "description": "The conditions that must be met for this channel config to be used", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV2" }, "type": "array" }, "ms_teams_targets": { "$ref": "#/components/schemas/AlertRouteChannelTargetV2" }, "slack_targets": { "$ref": "#/components/schemas/AlertRouteChannelTargetV2" } }, "required": [ "condition_groups" ], "type": "object" }, "AlertRouteChannelTargetPayloadV2": { "example": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "channel_visibility": { "description": "The visibility of the channel", "example": "abc123", "type": "string" } }, "required": [ "binding", "channel_visibility" ], "type": "object" }, "AlertRouteChannelTargetV2": { "example": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingV2" }, "channel_visibility": { "description": "The visibility of the channel", "example": "abc123", "type": "string" } }, "required": [ "binding", "channel_visibility" ], "type": "object" }, "AlertRouteCustomFieldBindingPayloadV2": { "example": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "custom_field_id": { "description": "ID of the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "merge_strategy": { "description": "The strategy to use when multiple alerts match this route", "enum": [ "first-wins", "last-wins", "append" ], "example": "first-wins", "type": "string" } }, "required": [ "custom_field_id", "binding", "merge_strategy" ], "type": "object" }, "AlertRouteCustomFieldBindingV2": { "example": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingV2" }, "custom_field_id": { "description": "ID of the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "merge_strategy": { "description": "The strategy to use when multiple alerts match this route", "enum": [ "first-wins", "last-wins", "append" ], "example": "first-wins", "type": "string" } }, "required": [ "custom_field_id", "binding", "merge_strategy" ], "type": "object" }, "AlertRouteEscalationConfigPayloadV2": { "example": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ] }, "properties": { "auto_cancel_escalations": { "description": "Should we auto cancel escalations when all alerts are resolved?", "example": false, "type": "boolean" }, "escalation_targets": { "description": "Targets for escalation", "example": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/AlertRouteEscalationTargetPayloadV2" }, "type": "array" } }, "required": [ "auto_cancel_escalations", "escalation_targets" ], "type": "object" }, "AlertRouteEscalationConfigV2": { "example": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ] }, "properties": { "auto_cancel_escalations": { "description": "Should we auto cancel escalations when all alerts are resolved?", "example": false, "type": "boolean" }, "escalation_targets": { "description": "Targets for escalation", "example": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/AlertRouteEscalationTargetV2" }, "type": "array" } }, "required": [ "auto_cancel_escalations", "escalation_targets" ], "type": "object" }, "AlertRouteEscalationTargetPayloadV2": { "example": { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "escalation_paths": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "users": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" } }, "type": "object" }, "AlertRouteEscalationTargetV2": { "example": { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "escalation_paths": { "$ref": "#/components/schemas/EngineParamBindingV2" }, "users": { "$ref": "#/components/schemas/EngineParamBindingV2" } }, "type": "object" }, "AlertRouteIncidentConfigPayloadV2": { "example": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "properties": { "auto_decline_enabled": { "description": "Should triage incidents be declined when alerts are resolved?", "example": false, "type": "boolean" }, "auto_relate_grouped_alerts": { "description": "Should grouped alerts automatically be related to active incidents without confirmation?", "example": false, "type": "boolean" }, "condition_groups": { "description": "What condition groups must be true for this alert route to create an incident?", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" }, "defer_time_seconds": { "description": "How long should the escalation defer time be?", "example": 1, "format": "int32", "type": "integer" }, "enabled": { "description": "Whether incident creation is enabled for this alert route", "example": false, "type": "boolean" }, "grouping_keys": { "description": "Which attributes should this alert route use to group alerts?", "example": [ { "reference": "alert.title" } ], "items": { "$ref": "#/components/schemas/GroupingKeyV2" }, "type": "array" }, "grouping_window_seconds": { "description": "How large should the grouping window be?", "example": 1, "format": "int32", "type": "integer" } }, "required": [ "auto_decline_enabled", "enabled", "condition_groups", "grouping_keys", "grouping_window_seconds", "defer_time_seconds" ], "type": "object" }, "AlertRouteIncidentConfigV2": { "example": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "properties": { "auto_decline_enabled": { "description": "Should triage incidents be declined when alerts are resolved?", "example": false, "type": "boolean" }, "auto_relate_grouped_alerts": { "description": "Should grouped alerts automatically be related to active incidents without confirmation?", "example": false, "type": "boolean" }, "condition_groups": { "description": "What condition groups must be true for this alert route to create an incident?", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV2" }, "type": "array" }, "defer_time_seconds": { "description": "How long should the escalation defer time be?", "example": 1, "format": "int32", "type": "integer" }, "enabled": { "description": "Whether incident creation is enabled for this alert route", "example": false, "type": "boolean" }, "grouping_keys": { "description": "Which attributes should this alert route use to group alerts?", "example": [ { "reference": "alert.title" } ], "items": { "$ref": "#/components/schemas/GroupingKeyV2" }, "type": "array" }, "grouping_window_seconds": { "description": "How large should the grouping window be?", "example": 1, "format": "int32", "type": "integer" } }, "required": [ "auto_decline_enabled", "enabled", "condition_groups", "grouping_keys", "grouping_window_seconds", "defer_time_seconds", "auto_relate_grouped_alerts" ], "type": "object" }, "AlertRouteIncidentTemplatePayloadV2": { "example": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "properties": { "custom_fields": { "description": "Custom fields configuration", "example": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "items": { "$ref": "#/components/schemas/AlertRouteCustomFieldBindingPayloadV2" }, "type": "array" }, "incident_mode": { "$ref": "#/components/schemas/AlertRouteTemplateBindingPayloadV2" }, "incident_type": { "$ref": "#/components/schemas/AlertRouteTemplateBindingPayloadV2" }, "name": { "$ref": "#/components/schemas/AlertRouteAutoGeneratedTemplateBindingPayloadV2" }, "severity": { "$ref": "#/components/schemas/AlertRouteSeverityBindingPayloadV2" }, "start_in_triage": { "$ref": "#/components/schemas/AlertRouteTemplateBindingPayloadV2" }, "summary": { "$ref": "#/components/schemas/AlertRouteAutoGeneratedTemplateBindingPayloadV2" }, "workspace": { "$ref": "#/components/schemas/AlertRouteTemplateBindingPayloadV2" } }, "required": [ "name" ], "type": "object" }, "AlertRouteIncidentTemplateV2": { "example": { "custom_fields": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } }, "properties": { "custom_fields": { "description": "Custom fields configuration", "example": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "items": { "$ref": "#/components/schemas/AlertRouteCustomFieldBindingV2" }, "type": "array" }, "incident_mode": { "$ref": "#/components/schemas/AlertRouteTemplateBindingV2" }, "incident_type": { "$ref": "#/components/schemas/AlertRouteTemplateBindingV2" }, "name": { "$ref": "#/components/schemas/AlertRouteAutoGeneratedTemplateBindingV2" }, "severity": { "$ref": "#/components/schemas/AlertRouteSeverityBindingV2" }, "start_in_triage": { "$ref": "#/components/schemas/AlertRouteTemplateBindingV2" }, "summary": { "$ref": "#/components/schemas/AlertRouteAutoGeneratedTemplateBindingV2" }, "workspace": { "$ref": "#/components/schemas/AlertRouteTemplateBindingV2" } }, "required": [ "name" ], "type": "object" }, "AlertRouteSeverityBindingPayloadV2": { "example": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "merge_strategy": { "description": "Strategy for merging severity when multiple alerts create/update the same incident", "enum": [ "first-wins", "max" ], "example": "first-wins", "type": "string" } }, "required": [ "merge_strategy" ], "type": "object" }, "AlertRouteSeverityBindingV2": { "example": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingV2" }, "merge_strategy": { "description": "Strategy for merging severity when multiple alerts create/update the same incident", "enum": [ "first-wins", "max" ], "example": "first-wins", "type": "string" } }, "required": [ "merge_strategy" ], "type": "object" }, "AlertRouteSlimV2": { "example": { "enabled": false, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Production incidents" }, "properties": { "enabled": { "description": "Whether this alert route is enabled or not", "example": false, "type": "boolean" }, "id": { "description": "Unique identifier for this alert route config", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "The name of this alert route config, for the user's reference", "example": "Production incidents", "type": "string" } }, "required": [ "id", "name", "enabled" ], "type": "object" }, "AlertRouteTemplateBindingPayloadV2": { "example": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" } }, "type": "object" }, "AlertRouteTemplateBindingV2": { "example": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingV2" } }, "type": "object" }, "AlertRouteV2": { "example": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] } ], "channel_config": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ] }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_config": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "incident_template": { "custom_fields": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } }, "is_private": false, "message_template": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 }, "properties": { "alert_sources": { "description": "Which alert sources should this alert route match?", "example": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] } ], "items": { "$ref": "#/components/schemas/AlertRouteAlertSourceV2" }, "type": "array" }, "channel_config": { "description": "The channel configuration for this alert route", "example": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "items": { "$ref": "#/components/schemas/AlertRouteChannelConfigV2" }, "type": "array" }, "condition_groups": { "description": "What condition groups must be true for this alert route to fire?", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV2" }, "type": "array" }, "created_at": { "description": "The time of creation of this alert route", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "enabled": { "description": "Whether this alert route is enabled or not", "example": false, "type": "boolean" }, "escalation_config": { "$ref": "#/components/schemas/AlertRouteEscalationConfigV2" }, "expressions": { "description": "The expressions used in this template", "example": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionV2" }, "type": "array" }, "id": { "description": "Unique identifier for this alert route config", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_config": { "$ref": "#/components/schemas/AlertRouteIncidentConfigV2" }, "incident_template": { "$ref": "#/components/schemas/AlertRouteIncidentTemplateV2" }, "is_private": { "description": "Whether this alert route is private. Private alert routes will only create private incidents from alerts.", "example": false, "type": "boolean" }, "message_template": { "$ref": "#/components/schemas/EngineParamBindingV2" }, "name": { "description": "The name of this alert route config, for the user's reference", "example": "Production incidents", "type": "string" }, "owning_team_ids": { "description": "IDs of teams that own this alert route", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "updated_at": { "description": "The time of last update of this alert route", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "version": { "description": "The version of this alert route config", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "id", "name", "condition_groups", "expressions", "is_private", "enabled", "escalation_config", "incident_config", "incident_template", "alert_sources", "channel_config", "version" ], "type": "object" }, "AlertRoutesCreatePayloadV2": { "example": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] } ], "channel_config": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ] }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "incident_config": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "incident_template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "is_private": false, "message_template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 }, "properties": { "alert_sources": { "description": "Which alert sources should this alert route match?", "example": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] } ], "items": { "$ref": "#/components/schemas/AlertRouteAlertSourcePayloadV2" }, "type": "array" }, "channel_config": { "description": "The channel configuration for this alert route", "example": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "items": { "$ref": "#/components/schemas/AlertRouteChannelConfigPayloadV2" }, "type": "array" }, "condition_groups": { "description": "What condition groups must be true for this alert route to fire?", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" }, "created_at": { "description": "The time of creation of this alert route", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "enabled": { "description": "Whether this alert route is enabled or not", "example": false, "type": "boolean" }, "escalation_config": { "$ref": "#/components/schemas/AlertRouteEscalationConfigPayloadV2" }, "expressions": { "description": "The expressions used in this template", "example": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionPayloadV2" }, "type": "array" }, "incident_config": { "$ref": "#/components/schemas/AlertRouteIncidentConfigPayloadV2" }, "incident_template": { "$ref": "#/components/schemas/AlertRouteIncidentTemplatePayloadV2" }, "is_private": { "description": "Whether this alert route is private. Private alert routes will only create private incidents from alerts.", "example": false, "type": "boolean" }, "message_template": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "name": { "description": "The name of this alert route config, for the user's reference", "example": "Production incidents", "type": "string" }, "owning_team_ids": { "description": "IDs of teams that own this alert route", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "updated_at": { "description": "The time of last update of this alert route", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "version": { "description": "The version of this alert route config", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "name", "condition_groups", "expressions", "is_private", "enabled", "escalation_config", "incident_config", "incident_template", "alert_sources", "channel_config", "version" ], "type": "object" }, "AlertRoutesCreateResultV2": { "example": { "alert_route": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] } ], "channel_config": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ] }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_config": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "incident_template": { "custom_fields": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } }, "is_private": false, "message_template": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "properties": { "alert_route": { "$ref": "#/components/schemas/AlertRouteV2" } }, "required": [ "alert_route" ], "type": "object" }, "AlertRoutesListResultV2": { "example": { "alert_routes": [ { "enabled": false, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Production incidents" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "alert_routes": { "example": [ { "enabled": false, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Production incidents" } ], "items": { "$ref": "#/components/schemas/AlertRouteSlimV2" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" } }, "required": [ "alert_routes", "pagination_meta" ], "type": "object" }, "AlertRoutesShowResultV2": { "example": { "alert_route": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] } ], "channel_config": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ] }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_config": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "incident_template": { "custom_fields": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } }, "is_private": false, "message_template": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "properties": { "alert_route": { "$ref": "#/components/schemas/AlertRouteV2" } }, "required": [ "alert_route" ], "type": "object" }, "AlertRoutesUpdatePayloadV2": { "example": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] } ], "channel_config": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ] }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "incident_config": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "incident_template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "is_private": false, "message_template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 }, "properties": { "alert_sources": { "description": "Which alert sources should this alert route match?", "example": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] } ], "items": { "$ref": "#/components/schemas/AlertRouteAlertSourcePayloadV2" }, "type": "array" }, "channel_config": { "description": "The channel configuration for this alert route", "example": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "items": { "$ref": "#/components/schemas/AlertRouteChannelConfigPayloadV2" }, "type": "array" }, "condition_groups": { "description": "What condition groups must be true for this alert route to fire?", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" }, "created_at": { "description": "The time of creation of this alert route", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "enabled": { "description": "Whether this alert route is enabled or not", "example": false, "type": "boolean" }, "escalation_config": { "$ref": "#/components/schemas/AlertRouteEscalationConfigPayloadV2" }, "expressions": { "description": "The expressions used in this template", "example": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionPayloadV2" }, "type": "array" }, "incident_config": { "$ref": "#/components/schemas/AlertRouteIncidentConfigPayloadV2" }, "incident_template": { "$ref": "#/components/schemas/AlertRouteIncidentTemplatePayloadV2" }, "is_private": { "description": "Whether this alert route is private. Private alert routes will only create private incidents from alerts.", "example": false, "type": "boolean" }, "message_template": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "name": { "description": "The name of this alert route config, for the user's reference", "example": "Production incidents", "type": "string" }, "owning_team_ids": { "description": "IDs of teams that own this alert route", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "updated_at": { "description": "The time of last update of this alert route", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "version": { "description": "The version of this alert route config", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "name", "condition_groups", "expressions", "is_private", "enabled", "escalation_config", "incident_config", "incident_template", "alert_sources", "channel_config", "version" ], "type": "object" }, "AlertRoutesUpdateResultV2": { "example": { "alert_route": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] } ], "channel_config": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ] }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_config": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "incident_template": { "custom_fields": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } }, "is_private": false, "message_template": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "properties": { "alert_route": { "$ref": "#/components/schemas/AlertRouteV2" } }, "required": [ "alert_route" ], "type": "object" }, "AlertSlimV2": { "example": { "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "alert_source_id": { "description": "The ID of the alert source this alert fired on", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "created_at": { "description": "When this entry was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "deduplication_key": { "description": "A deduplication key which uniquely references this alert from your alert source. For newly created HTTP sources, this field is required.\nIf you send an event with the same deduplication_key multiple times, only one alert will be created in incident.io for this alert source config.\nYou can filter on this field to find the alert created by an event you've sent us.", "example": "4293868629", "type": "string" }, "description": { "description": "The description of the alert", "example": "CPU on the payments service has exceeded 75 percent for 5 minutes", "type": "string" }, "id": { "description": "The ID of this alert", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "resolved_at": { "description": "When this alert was resolved", "example": "2021-08-17T14:28:57.801578Z", "format": "date-time", "type": "string" }, "source_url": { "description": "If applicable, a link to the alert in the upstream system", "example": "https://www.my-alerting-platform.com/alerts/my-alert-123", "type": "string" }, "status": { "description": "Statuses of an alert", "enum": [ "firing", "resolved" ], "example": "firing", "type": "string", "x-public-api-version": "v2" }, "title": { "description": "The title of the alert, parsed from the alert payload according to the alert source configuration", "example": "*errors.withMessage: PG::Error failed to connect", "type": "string" }, "updated_at": { "description": "When this alert was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "title", "deduplication_key", "alert_source_id", "status", "created_at", "updated_at" ], "type": "object" }, "AlertSourceEmailOptionsPayloadV2": { "example": { "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "properties": { "redactions": { "description": "Which PII types to automatically redact from incoming email content before storage", "example": [ "credit_card_numbers" ], "items": { "description": "Which PII type to automatically redact from incoming email content before storage", "enum": [ "credit_card_numbers", "us_social_security_numbers", "phone_numbers" ], "example": "credit_card_numbers", "type": "string", "x-public-api-version": "v2" }, "type": "array" }, "transform_expression": { "description": "JavaScript expression to transform email fields into structured alert fields", "example": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}", "type": "string" } }, "required": [ "redactions" ], "type": "object" }, "AlertSourceEmailOptionsV2": { "example": { "email_address": "lawrence@example.com", "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "properties": { "email_address": { "description": "Email address this alert source receives alerts to", "example": "lawrence@example.com", "type": "string" }, "redactions": { "description": "Which PII types to automatically redact from incoming email content before storage", "example": [ "credit_card_numbers" ], "items": { "description": "Which PII type to automatically redact from incoming email content before storage", "enum": [ "credit_card_numbers", "us_social_security_numbers", "phone_numbers" ], "example": "credit_card_numbers", "type": "string", "x-public-api-version": "v2" }, "type": "array" }, "transform_expression": { "description": "JavaScript expression to transform email fields into structured alert fields", "example": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}", "type": "string" } }, "required": [ "email_address", "redactions" ], "type": "object" }, "AlertSourceHTTPCustomOptionsV2": { "example": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "properties": { "deduplication_key_path": { "description": "JSON path to extract the deduplication key from the payload", "example": "$.alert_id", "type": "string" }, "transform_expression": { "description": "JavaScript expression that returns an object with all alert fields", "example": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}", "type": "string" } }, "required": [ "transform_expression", "deduplication_key_path" ], "type": "object" }, "AlertSourceHeartbeatOptionsPayloadV2": { "example": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60 }, "properties": { "failure_threshold": { "default": 1, "description": "Number of consecutive missed pings before an alert fires.", "example": 1, "format": "int64", "type": "integer" }, "grace_period_seconds": { "default": 0, "description": "How long after a missed ping before the heartbeat is considered late, in seconds. If zero, it transitions directly to failing.", "example": 0, "format": "int64", "type": "integer" }, "interval_seconds": { "description": "How often a ping is expected, in seconds.", "example": 60, "format": "int64", "type": "integer" } }, "required": [ "interval_seconds" ], "type": "object" }, "AlertSourceHeartbeatOptionsV2": { "example": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60, "ping_url": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping" }, "properties": { "failure_threshold": { "description": "Number of consecutive missed pings before an alert fires.", "example": 1, "format": "int64", "type": "integer" }, "grace_period_seconds": { "description": "How long after a missed ping before the heartbeat is considered late, in seconds. If zero, it transitions directly to failing.", "example": 0, "format": "int64", "type": "integer" }, "interval_seconds": { "description": "How often a ping is expected, in seconds.", "example": 60, "format": "int64", "type": "integer" }, "ping_url": { "description": "The URL to POST to in order to send a heartbeat ping.", "example": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping", "type": "string" } }, "required": [ "interval_seconds", "grace_period_seconds", "failure_threshold", "ping_url" ], "type": "object" }, "AlertSourceJiraOptionsV2": { "example": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "properties": { "project_ids": { "description": "Which projects in Jira should this alert source watch for new issues? IDs can either be IDs of the projects in Jira, or ID of catalog entries in the 'Jira Project' catalog type.", "example": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ], "items": { "example": "abc123", "type": "string" }, "type": "array" } }, "required": [ "project_ids" ], "type": "object" }, "AlertSourceV2": { "example": { "alert_events_url": "https://api.incident.io/v2/alert_events/http/01GW2G3V0S59R238FAHPDS1R66", "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "email_options": { "email_address": "lawrence@example.com", "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60, "ping_url": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping" }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "id": "01GW2G3V0S59R238FAHPDS1R66", "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "secret_token": "some-secret-token", "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "is_private": false, "title": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } }, "properties": { "alert_events_url": { "description": "URL that can be used to send alert events to this source. This is only set for sources that accept webhook/HTTP events; email sources use the email_address field, and integration-based sources (like Jira) receive events through their native integrations.", "example": "https://api.incident.io/v2/alert_events/http/01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "auto_resolve_incident_alerts": { "description": "Whether to auto-resolve incident alerts when the alert auto-resolves. Defaults to true. Only use in conjunction with auto_resolve_timeout_minutes.", "example": false, "type": "boolean" }, "auto_resolve_timeout_minutes": { "description": "When set, alerts from this source will automatically resolve after this many minutes.", "example": 1, "format": "int64", "type": "integer" }, "email_options": { "$ref": "#/components/schemas/AlertSourceEmailOptionsV2" }, "heartbeat_options": { "$ref": "#/components/schemas/AlertSourceHeartbeatOptionsV2" }, "http_custom_options": { "$ref": "#/components/schemas/AlertSourceHTTPCustomOptionsV2" }, "id": { "description": "The ID of this alert source", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "jira_options": { "$ref": "#/components/schemas/AlertSourceJiraOptionsV2" }, "name": { "description": "Unique name of the alert source", "example": "Production Web Dashboard Alerts", "type": "string" }, "owning_team_ids": { "description": "IDs of teams that own this alert source", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "secret_token": { "description": "Secret token used to authenticate this source, if applicable. If applicable, this is the token that must be included in either the query string or the 'Authorization' header when sending events to this alert source.", "example": "some-secret-token", "type": "string" }, "source_type": { "description": "Type of alert source", "enum": [ "alertmanager", "app_optics", "azure_monitor", "bugsnag", "checkly", "chronosphere", "cloudwatch", "cloudflare", "coralogix", "cronitor", "crowdstrike_falcon", "datadog", "dynatrace", "elasticsearch", "email", "expel", "github_issue", "google_cloud", "grafana", "heartbeat", "http", "http_custom", "honeycomb", "incoming_calls", "jira", "jsm", "monte_carlo", "nagios", "new_relic", "opsgenie", "prtg", "pager_duty", "panther", "pingdom", "runscope", "sns", "sentry", "sentry_metric", "splunk", "status_cake", "status_page_views", "sumo_logic", "uptime", "vercel", "zendesk" ], "example": "alertmanager", "type": "string", "x-public-api-version": "v2" }, "template": { "$ref": "#/components/schemas/AlertTemplateV2" } }, "required": [ "id", "name", "source_type", "template" ], "type": "object" }, "AlertSourcesCreatePayloadV2": { "example": { "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "email_options": { "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60 }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "is_private": false, "title": { "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "properties": { "auto_resolve_incident_alerts": { "description": "Whether to auto-resolve incident alerts when the alert auto-resolves. Defaults to true. Only use in conjunction with auto_resolve_timeout_minutes.", "example": false, "type": "boolean" }, "auto_resolve_timeout_minutes": { "description": "When set, alerts from this source will automatically resolve after this many minutes.", "example": 1, "format": "int64", "type": "integer" }, "email_options": { "$ref": "#/components/schemas/AlertSourceEmailOptionsPayloadV2" }, "heartbeat_options": { "$ref": "#/components/schemas/AlertSourceHeartbeatOptionsPayloadV2" }, "http_custom_options": { "$ref": "#/components/schemas/AlertSourceHTTPCustomOptionsV2" }, "jira_options": { "$ref": "#/components/schemas/AlertSourceJiraOptionsV2" }, "name": { "description": "Unique name of the alert source", "example": "Production Web Dashboard Alerts", "type": "string" }, "owning_team_ids": { "description": "IDs of teams that own this alert source", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "source_type": { "description": "Type of alert source", "enum": [ "alertmanager", "app_optics", "azure_monitor", "bugsnag", "checkly", "chronosphere", "cloudwatch", "cloudflare", "coralogix", "cronitor", "crowdstrike_falcon", "datadog", "dynatrace", "elasticsearch", "email", "expel", "github_issue", "google_cloud", "grafana", "heartbeat", "http", "http_custom", "honeycomb", "incoming_calls", "jira", "jsm", "monte_carlo", "nagios", "new_relic", "opsgenie", "prtg", "pager_duty", "panther", "pingdom", "runscope", "sns", "sentry", "sentry_metric", "splunk", "status_cake", "status_page_views", "sumo_logic", "uptime", "vercel", "zendesk" ], "example": "alertmanager", "type": "string" }, "template": { "$ref": "#/components/schemas/AlertTemplatePayloadV2" } }, "required": [ "name", "source_type", "template" ], "type": "object" }, "AlertSourcesCreateResultV2": { "example": { "alert_source": { "alert_events_url": "https://api.incident.io/v2/alert_events/http/01GW2G3V0S59R238FAHPDS1R66", "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "email_options": { "email_address": "lawrence@example.com", "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60, "ping_url": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping" }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "id": "01GW2G3V0S59R238FAHPDS1R66", "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "secret_token": "some-secret-token", "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "is_private": false, "title": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } } }, "properties": { "alert_source": { "$ref": "#/components/schemas/AlertSourceV2" } }, "required": [ "alert_source" ], "type": "object" }, "AlertSourcesListResultV2": { "example": { "alert_sources": [ { "alert_events_url": "https://api.incident.io/v2/alert_events/http/01GW2G3V0S59R238FAHPDS1R66", "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "email_options": { "email_address": "lawrence@example.com", "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60, "ping_url": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping" }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "id": "01GW2G3V0S59R238FAHPDS1R66", "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "secret_token": "some-secret-token", "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "is_private": false, "title": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } } ] }, "properties": { "alert_sources": { "example": [ { "alert_events_url": "https://api.incident.io/v2/alert_events/http/01GW2G3V0S59R238FAHPDS1R66", "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "email_options": { "email_address": "lawrence@example.com", "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60, "ping_url": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping" }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "id": "01GW2G3V0S59R238FAHPDS1R66", "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "secret_token": "some-secret-token", "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "is_private": false, "title": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } } ], "items": { "$ref": "#/components/schemas/AlertSourceV2" }, "type": "array" } }, "required": [ "alert_sources" ], "type": "object" }, "AlertSourcesShowResultV2": { "example": { "alert_source": { "alert_events_url": "https://api.incident.io/v2/alert_events/http/01GW2G3V0S59R238FAHPDS1R66", "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "email_options": { "email_address": "lawrence@example.com", "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60, "ping_url": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping" }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "id": "01GW2G3V0S59R238FAHPDS1R66", "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "secret_token": "some-secret-token", "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "is_private": false, "title": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } } }, "properties": { "alert_source": { "$ref": "#/components/schemas/AlertSourceV2" } }, "required": [ "alert_source" ], "type": "object" }, "AlertSourcesUpdatePayloadV2": { "example": { "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "disabled": false, "email_options": { "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60 }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "is_private": false, "title": { "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "properties": { "auto_resolve_incident_alerts": { "description": "Whether to auto-resolve incident alerts when the alert auto-resolves. Defaults to true. Only use in conjunction with auto_resolve_timeout_minutes.", "example": false, "type": "boolean" }, "auto_resolve_timeout_minutes": { "description": "When set, alerts from this source will automatically resolve after this many minutes.", "example": 1, "format": "int64", "type": "integer" }, "disabled": { "description": "For heartbeat sources, set to true to disable monitoring", "example": false, "type": "boolean" }, "email_options": { "$ref": "#/components/schemas/AlertSourceEmailOptionsPayloadV2" }, "heartbeat_options": { "$ref": "#/components/schemas/AlertSourceHeartbeatOptionsPayloadV2" }, "http_custom_options": { "$ref": "#/components/schemas/AlertSourceHTTPCustomOptionsV2" }, "jira_options": { "$ref": "#/components/schemas/AlertSourceJiraOptionsV2" }, "name": { "description": "Unique name of the alert source", "example": "Production Web Dashboard Alerts", "type": "string" }, "owning_team_ids": { "description": "IDs of teams that own this alert source", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "template": { "$ref": "#/components/schemas/AlertTemplatePayloadV2" } }, "required": [ "name", "template" ], "type": "object" }, "AlertSourcesUpdateResultV2": { "example": { "alert_source": { "alert_events_url": "https://api.incident.io/v2/alert_events/http/01GW2G3V0S59R238FAHPDS1R66", "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "email_options": { "email_address": "lawrence@example.com", "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60, "ping_url": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping" }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "id": "01GW2G3V0S59R238FAHPDS1R66", "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "secret_token": "some-secret-token", "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "is_private": false, "title": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } } }, "properties": { "alert_source": { "$ref": "#/components/schemas/AlertSourceV2" } }, "required": [ "alert_source" ], "type": "object" }, "AlertTemplateAttributeBindingPayloadV2": { "example": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "literal": "SEV123", "reference": "incident.severity" } }, "properties": { "array_value": { "description": "If set, this is the array value of the step parameter", "example": [ { "literal": "SEV123", "reference": "incident.severity" } ], "items": { "$ref": "#/components/schemas/EngineParamBindingValuePayloadV2" }, "type": "array" }, "merge_strategy": { "description": "Merge strategy for this attribute when alert updates", "enum": [ "first_wins", "last_wins", "append", "max", "min" ], "example": "first_wins", "type": "string" }, "value": { "$ref": "#/components/schemas/EngineParamBindingValuePayloadV2" } }, "type": "object" }, "AlertTemplateAttributeBindingV2": { "example": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "properties": { "array_value": { "description": "If array_value is set, this helps render the values", "example": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "items": { "$ref": "#/components/schemas/EngineParamBindingValueV2" }, "type": "array" }, "merge_strategy": { "description": "Merge strategy for this attribute when alert updates", "enum": [ "first_wins", "last_wins", "append", "max", "min" ], "example": "first_wins", "type": "string" }, "value": { "$ref": "#/components/schemas/EngineParamBindingValueV2" } }, "type": "object" }, "AlertTemplateAttributePayloadV2": { "example": { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "alert_attribute_id": { "description": "ID of the alert attribute to set with this binding", "example": "abc123", "type": "string" }, "binding": { "$ref": "#/components/schemas/AlertTemplateAttributeBindingPayloadV2" } }, "required": [ "alert_attribute_id", "binding" ], "type": "object" }, "AlertTemplateAttributeV2": { "example": { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "alert_attribute_id": { "description": "ID of the alert attribute to set with this binding", "example": "abc123", "type": "string" }, "binding": { "$ref": "#/components/schemas/AlertTemplateAttributeBindingV2" } }, "required": [ "alert_attribute_id", "binding" ], "type": "object" }, "AlertTemplatePayloadV2": { "example": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "is_private": false, "title": { "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "attributes": { "description": "Attributes to set on alerts coming from this source, with a binding describing how to set them.", "example": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/AlertTemplateAttributePayloadV2" }, "type": "array" }, "description": { "$ref": "#/components/schemas/EngineParamBindingValuePayloadV2" }, "expressions": { "description": "Expressions available for use in bindings within this template", "example": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionPayloadV2" }, "type": "array" }, "is_private": { "description": "Whether or not alerts produced by this source should be private", "example": false, "type": "boolean" }, "title": { "$ref": "#/components/schemas/EngineParamBindingValuePayloadV2" }, "visible_to_teams": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" } }, "required": [ "expressions", "title", "description", "attributes" ], "type": "object" }, "AlertTemplateV2": { "example": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "is_private": false, "title": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "attributes": { "description": "Attributes to set on alerts coming from this source, with a binding describing how to set them.", "example": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/AlertTemplateAttributeV2" }, "type": "array" }, "description": { "$ref": "#/components/schemas/EngineParamBindingValueV2" }, "expressions": { "description": "Expressions available for use in bindings within this template", "example": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionV2" }, "type": "array" }, "is_private": { "description": "Whether or not alerts produced by this source should be private", "example": false, "type": "boolean" }, "title": { "$ref": "#/components/schemas/EngineParamBindingValueV2" }, "visible_to_teams": { "$ref": "#/components/schemas/EngineParamBindingV2" } }, "required": [ "expressions", "title", "description", "attributes", "is_private" ], "type": "object" }, "AlertV2": { "example": { "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "attributes": [ { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } } ], "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "alert_source_id": { "description": "The ID of the alert source this alert fired on", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "attributes": { "description": "Attribute values parsed from the alerts payload", "example": [ { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } } ], "items": { "$ref": "#/components/schemas/AlertAttributeEntryV2" }, "type": "array" }, "created_at": { "description": "When this entry was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "deduplication_key": { "description": "A deduplication key which uniquely references this alert from your alert source. For newly created HTTP sources, this field is required.\nIf you send an event with the same deduplication_key multiple times, only one alert will be created in incident.io for this alert source config.\nYou can filter on this field to find the alert created by an event you've sent us.", "example": "4293868629", "type": "string" }, "description": { "description": "The description of the alert", "example": "CPU on the payments service has exceeded 75 percent for 5 minutes", "type": "string" }, "id": { "description": "The ID of this alert", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "resolved_at": { "description": "When this alert was resolved", "example": "2021-08-17T14:28:57.801578Z", "format": "date-time", "type": "string" }, "source_url": { "description": "If applicable, a link to the alert in the upstream system", "example": "https://www.my-alerting-platform.com/alerts/my-alert-123", "type": "string" }, "status": { "description": "Statuses of an alert", "enum": [ "firing", "resolved" ], "example": "firing", "type": "string", "x-public-api-version": "v2" }, "title": { "description": "The title of the alert, parsed from the alert payload according to the alert source configuration", "example": "*errors.withMessage: PG::Error failed to connect", "type": "string" }, "updated_at": { "description": "When this alert was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "alert_source_id", "deduplication_key", "status", "title", "attributes", "created_at", "updated_at" ], "type": "object" }, "AlertsListIncidentAlertsResultV2": { "example": { "incident_alerts": [ { "alert": { "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" }, "alert_route_id": "01GW2G3V0S59R238FAHPDS1R67", "id": "01GW2G3V0S59R238FAHPDS1R66", "incident": { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "incident_alerts": { "example": [ { "alert": { "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" }, "alert_route_id": "01GW2G3V0S59R238FAHPDS1R67", "id": "01GW2G3V0S59R238FAHPDS1R66", "incident": { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } } ], "items": { "$ref": "#/components/schemas/IncidentAlertV2" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" } }, "required": [ "incident_alerts", "pagination_meta" ], "type": "object" }, "AlertsListResultV2": { "example": { "alerts": [ { "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "attributes": [ { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } } ], "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "alerts": { "example": [ { "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "attributes": [ { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } } ], "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/AlertV2" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" } }, "required": [ "alerts", "pagination_meta" ], "type": "object" }, "AlertsShowResultV2": { "example": { "alert": { "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "attributes": [ { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } } ], "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "alert": { "$ref": "#/components/schemas/AlertV2" } }, "required": [ "alert" ], "type": "object" }, "AuditLogActorMetadataV2": { "example": { "api_key_roles": "abc123", "external_resource_external_id": "q1234", "external_resource_type": "pager_duty_incident", "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "properties": { "api_key_roles": { "description": "The roles that the API key has, separated by commas (if it's an API key actor)", "example": "abc123", "type": "string" }, "external_resource_external_id": { "description": "The ID of the external resource in the 3rd party system (if it's an external resource actor)", "example": "q1234", "type": "string" }, "external_resource_type": { "description": "The type of the external resource (if it's an external resource actor)", "example": "pager_duty_incident", "type": "string" }, "user_base_role_slug": { "description": "The base role slug of the user (if it's a user actor)", "example": "admin", "type": "string" }, "user_custom_role_slugs": { "description": "The custom role slugs of the user, separated by commas (if it's a user actor)", "example": "engineering,security", "type": "string" } }, "type": "object" }, "AuditLogActorV2": { "example": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "properties": { "id": { "description": "The ID of the actor", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "metadata": { "$ref": "#/components/schemas/AuditLogActorMetadataV2" }, "name": { "description": "The name of the actor", "example": "John Doe", "type": "string" }, "type": { "description": "The type of actor", "enum": [ "user", "system", "api_key", "workflow", "external_resource" ], "example": "user", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "AuditLogCatalogAttributeUpdatedMetadataV2": { "example": { "after_values": [ "01FCNDV6P870EA6S7TK1DSYDG0", "01FCNDV6P870EA6S7TK1DSYDG2" ], "before_values": [ "01FCNDV6P870EA6S7TK1DSYDG0", "01FCNDV6P870EA6S7TK1DSYDG1" ] }, "properties": { "after_values": { "description": "The user IDs that are in the attribute after the change", "example": [ "01FCNDV6P870EA6S7TK1DSYDG0", "01FCNDV6P870EA6S7TK1DSYDG2" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "before_values": { "description": "The user IDs that were in the attribute before the change", "example": [ "01FCNDV6P870EA6S7TK1DSYDG0", "01FCNDV6P870EA6S7TK1DSYDG1" ], "items": { "example": "abc123", "type": "string" }, "type": "array" } }, "required": [ "before_values", "after_values" ], "type": "object" }, "AuditLogCatalogAttributeUpdatedMetadataV2V2": { "example": { "after_values": "01FCNDV6P870EA6S7TK1DSYDG0,01FCNDV6P870EA6S7TK1DSYDG2", "before_values": "01FCNDV6P870EA6S7TK1DSYDG0,01FCNDV6P870EA6S7TK1DSYDG1" }, "properties": { "after_values": { "description": "The user IDs that were in the attribute before the change, comma separated", "example": "01FCNDV6P870EA6S7TK1DSYDG0,01FCNDV6P870EA6S7TK1DSYDG2", "type": "string" }, "before_values": { "description": "The user IDs that were in the attribute before the change, comma separated", "example": "01FCNDV6P870EA6S7TK1DSYDG0,01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } }, "required": [ "before_values", "after_values" ], "type": "object" }, "AuditLogEmailOtpLoginSettingUpdatedMetadataV2": { "example": { "enabled": "true" }, "properties": { "enabled": { "description": "Whether email OTP login is enabled after the update", "example": "true", "type": "string" } }, "type": "object" }, "AuditLogEntryContextV2": { "example": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "properties": { "location": { "description": "The location of the actor that performed this action", "example": "1.2.3.4", "type": "string" }, "user_agent": { "description": "The user agent of the actor that performed this action", "example": "Chrome/91.0.4472.114", "type": "string" } }, "required": [ "location" ], "type": "object" }, "AuditLogIPAllowlistUpdatedMetadataV2": { "example": { "additions": "[\"192.0.2.0\",\"192.0.2.0/24\"]", "additions_count": "2", "enabled": "true", "removals": "[\"192.0.2.1\"]", "removals_count": "1", "version": "2" }, "properties": { "additions": { "description": "A comma-separated array of newly added IPs/CIDRs. Max 500 characters", "example": "[\"192.0.2.0\",\"192.0.2.0/24\"]", "type": "string" }, "additions_count": { "description": "The number of IPs/CIDRs added to the allowlist", "example": "2", "type": "string" }, "enabled": { "description": "Whether or not the IP allowlist is enabled after the update", "example": "true", "type": "string" }, "removals": { "description": "A comma-separated array of newly removed IPs/CIDRs. Max 500 characters", "example": "[\"192.0.2.1\"]", "type": "string" }, "removals_count": { "description": "The number of IPs/CIDRs removed from the allowlist", "example": "1", "type": "string" }, "version": { "description": "The version of the IP allowlist after the update", "example": "2", "type": "string" } }, "type": "object" }, "AuditLogOnCallNotificationMethodMetadataV2": { "example": { "target_user": "01JV9EMFCFRGCFVNDWTBKT2EBR" }, "properties": { "target_user": { "description": "The user whose notification method was created or destroyed", "example": "01JV9EMFCFRGCFVNDWTBKT2EBR", "type": "string" } }, "type": "object" }, "AuditLogOrganisationSettingsUpdatedMetadataV2": { "example": { "default_timezone": "Europe/London" }, "properties": { "default_timezone": { "description": "The default timezone that was set", "example": "Europe/London", "type": "string" } }, "type": "object" }, "AuditLogPrivateAlertAccessAttemptedMetadataV2": { "example": { "outcome": "granted" }, "properties": { "outcome": { "description": "Whether or not the user was able to access the private alert", "enum": [ "granted", "denied" ], "example": "granted", "type": "string" } }, "type": "object" }, "AuditLogPrivateEscalationAccessAttemptedMetadataV2": { "example": { "outcome": "granted" }, "properties": { "outcome": { "description": "Whether or not the user was able to access the private escalation", "enum": [ "granted", "denied" ], "example": "granted", "type": "string" } }, "type": "object" }, "AuditLogPrivateIncidentAccessAttemptedMetadataV2": { "example": { "outcome": "granted" }, "properties": { "outcome": { "description": "Whether or not the user was able to access the private incident", "enum": [ "granted", "denied" ], "example": "granted", "type": "string" } }, "type": "object" }, "AuditLogQrCodeMobileLoginSettingUpdatedMetadataV2": { "example": { "enabled": "true" }, "properties": { "enabled": { "description": "Whether QR code mobile login is enabled after the update", "example": "true", "type": "string" } }, "type": "object" }, "AuditLogSCIMGroupSeatMappingChangedMetadataV2": { "example": { "after_seat_types": "[full_access, responder_access]", "before_seat_types": "[full_access]" }, "properties": { "after_seat_types": { "description": "The seat types assigned to this SCIM group after the mapping was changed", "example": "[full_access, responder_access]", "type": "string" }, "before_seat_types": { "description": "The seat types assigned to this SCIM group before the mapping was changed", "example": "[full_access]", "type": "string" } }, "required": [ "before_seat_types", "after_seat_types" ], "type": "object" }, "AuditLogScheduleOverrideMetadataV2": { "example": { "after_user_ids": "01FCNDV6P870EA6S7TK1DSYDG2", "after_user_names": "Nicole C", "before_user_ids": "01FCNDV6P870EA6S7TK1DSYDG0,01FCNDV6P870EA6S7TK1DSYDG1", "before_user_names": "Nicole A,Nicole B", "end_at": "2026-03-02T08:00:00Z", "start_at": "2026-03-01T18:00:00Z" }, "properties": { "after_user_ids": { "description": "User IDs of users on-call after the override change, comma separated", "example": "01FCNDV6P870EA6S7TK1DSYDG2", "type": "string" }, "after_user_names": { "description": "Names of users on-call after the override change, comma separated", "example": "Nicole C", "type": "string" }, "before_user_ids": { "description": "User IDs of users on-call before the override change, comma separated", "example": "01FCNDV6P870EA6S7TK1DSYDG0,01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" }, "before_user_names": { "description": "Names of users on-call before the override change, comma separated", "example": "Nicole A,Nicole B", "type": "string" }, "end_at": { "description": "Override end time in the schedule's local timezone", "example": "2026-03-02T08:00:00Z", "type": "string" }, "start_at": { "description": "Override start time in the schedule's local timezone", "example": "2026-03-01T18:00:00Z", "type": "string" } }, "required": [ "before_user_ids", "before_user_names", "after_user_ids", "after_user_names", "start_at", "end_at" ], "type": "object" }, "AuditLogTargetV2": { "example": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "John Doe", "type": "user" }, "properties": { "id": { "description": "The ID of the target", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "The name of the target", "example": "John Doe", "type": "string" }, "type": { "description": "The type of target", "enum": [ "api_key", "alert", "alert_chat_message_template", "alert_route", "alert_schema", "alert_source", "alert_priority", "announcement_rule", "catalog_type", "catalog_entry", "catalog_attribute", "connector_config", "custom_field", "debrief_invite_rule", "escalation", "escalation_path", "follow_up_category", "follow_up_priority", "holiday_user_feed", "incident", "incident_call_transcription_session", "incident_call_setting", "incident_duration_metric", "maintenance_window", "incident_role", "incident_status", "incident_timestamp", "incident_timestamp_set_by_rule", "incident_type", "integration", "internal_status_page", "ip_allowlist", "nudge", "on_call_notification_method", "organisation_settings", "schedule_override", "policy", "post_incident_task", "postmortem_template", "postmortem_template_section", "private_incident_membership", "rbac_role", "scim_group", "schedule", "team_role", "severity", "status_page", "status_page_sub_page", "status_page_template", "team_settings", "telemetry_data_source", "user", "workflow", "activity_log", "timeline_item" ], "example": "user", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "AuditLogUserRoleMembershipChangedMetadataV2": { "example": { "after_base_role_slug": "owner", "after_custom_role_slugs": "engineering,data", "before_base_role_slug": "admin", "before_custom_role_slugs": "engineering,security" }, "properties": { "after_base_role_slug": { "description": "The base role slug of the user after their role memberships changed", "example": "owner", "type": "string" }, "after_custom_role_slugs": { "description": "The custom role slugs of the user after their role memberships changed, separated by commas", "example": "engineering,data", "type": "string" }, "before_base_role_slug": { "description": "The base role slug of the user before their role memberships changed", "example": "admin", "type": "string" }, "before_custom_role_slugs": { "description": "The custom role slugs of the user before their role memberships changed, separated by commas", "example": "engineering,security", "type": "string" } }, "required": [ "before_base_role_slug", "before_custom_role_slugs", "after_base_role_slug", "after_custom_role_slugs" ], "type": "object" }, "AuditLogUserSCIMGroupMappingChangedMetadataV2": { "example": { "after_base_role_slug": "owner", "after_custom_role_slugs": "engineering,data", "before_base_role_slug": "admin", "before_custom_role_slugs": "engineering,security" }, "properties": { "after_base_role_slug": { "description": "The base role slug of this SCIM group after the mapping was changed (if any)", "example": "owner", "type": "string" }, "after_custom_role_slugs": { "description": "The custom role slugs of this SCIM group after the mapping was changed (if any), separated by commas", "example": "engineering,data", "type": "string" }, "before_base_role_slug": { "description": "The base role slug assigned to this SCIM group before the mapping was changed (if any)", "example": "admin", "type": "string" }, "before_custom_role_slugs": { "description": "The custom role slugs of this SCIM group before the mapping was changed (if any), separated by commas", "example": "engineering,security", "type": "string" } }, "type": "object" }, "AuditLogsAPIKeyCreatedV1": { "example": { "action": "api_key.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Development API Key", "type": "api_key" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "api_key.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Development API Key", "type": "api_key" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsAPIKeyDeletedV1": { "example": { "action": "api_key.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Development API Key", "type": "api_key" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "api_key.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Development API Key", "type": "api_key" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsAPIKeyRotatedV1": { "example": { "action": "api_key.rotated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Development API Key", "type": "api_key" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "api_key.rotated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Development API Key", "type": "api_key" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsAPIKeyUpdatedV1": { "example": { "action": "api_key.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Development API Key", "type": "api_key" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "api_key.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Development API Key", "type": "api_key" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsActivityLogScrubbedV1": { "example": { "action": "activity_log.scrubbed", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Activity log entry (01FCNDV6P870EA6S7TK1DSYDG0)", "type": "activity_log" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "activity_log.scrubbed", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Activity log entry (01FCNDV6P870EA6S7TK1DSYDG0)", "type": "activity_log" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsAlertChatMessageTemplateCreatedV1": { "example": { "action": "alert_chat_message_template.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Standard", "type": "alert_chat_message_template" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "alert_chat_message_template.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Standard", "type": "alert_chat_message_template" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsAlertChatMessageTemplateDeletedV1": { "example": { "action": "alert_chat_message_template.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Standard", "type": "alert_chat_message_template" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "alert_chat_message_template.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Standard", "type": "alert_chat_message_template" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsAlertChatMessageTemplateUpdatedV1": { "example": { "action": "alert_chat_message_template.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Standard", "type": "alert_chat_message_template" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "alert_chat_message_template.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Standard", "type": "alert_chat_message_template" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsAlertPriorityCreatedV1": { "example": { "action": "alert_priority.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Urgent", "type": "alert_priority" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "alert_priority.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Urgent", "type": "alert_priority" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsAlertPriorityDeletedV1": { "example": { "action": "alert_priority.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Urgent", "type": "alert_priority" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "alert_priority.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Urgent", "type": "alert_priority" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsAlertPrioritySetAsDefaultV1": { "example": { "action": "alert_priority.set_as_default", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Urgent", "type": "alert_priority" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "alert_priority.set_as_default", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Urgent", "type": "alert_priority" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsAlertPriorityUpdatedV1": { "example": { "action": "alert_priority.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Urgent", "type": "alert_priority" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "alert_priority.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Urgent", "type": "alert_priority" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsAlertRouteCreatedV1": { "example": { "action": "alert_route.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Production incidents", "type": "alert_route" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "alert_route.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Production incidents", "type": "alert_route" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsAlertRouteDeletedV1": { "example": { "action": "alert_route.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Production incidents", "type": "alert_route" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "alert_route.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Production incidents", "type": "alert_route" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsAlertRouteUpdatedV1": { "example": { "action": "alert_route.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Production incidents", "type": "alert_route" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "alert_route.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Production incidents", "type": "alert_route" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsAlertSchemaUpdatedV1": { "example": { "action": "alert_schema.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Alert schema", "type": "alert_schema" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "alert_schema.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Alert schema", "type": "alert_schema" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsAlertScrubbedV1": { "example": { "action": "alert.scrubbed", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Alert (01KB0083ASNF7EPT8NHQNRDXFC)", "type": "alert" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "alert.scrubbed", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Alert (01KB0083ASNF7EPT8NHQNRDXFC)", "type": "alert" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsAlertSourceConfigCreatedV1": { "example": { "action": "alert_source_config.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Datadog alerts", "type": "alert_source" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "alert_source_config.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Datadog alerts", "type": "alert_source" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsAlertSourceConfigDeletedV1": { "example": { "action": "alert_source_config.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Datadog alerts", "type": "alert_source" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "alert_source_config.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Datadog alerts", "type": "alert_source" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsAlertSourceConfigUpdatedV1": { "example": { "action": "alert_source_config.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Datadog alerts", "type": "alert_source" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "alert_source_config.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Datadog alerts", "type": "alert_source" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsAnnouncementRuleCreatedV1": { "example": { "action": "announcement_rule.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#engineering", "type": "announcement_rule" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "announcement_rule.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#engineering", "type": "announcement_rule" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsAnnouncementRuleDeletedV1": { "example": { "action": "announcement_rule.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#engineering", "type": "announcement_rule" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "announcement_rule.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#engineering", "type": "announcement_rule" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsAnnouncementRuleUpdatedV1": { "example": { "action": "announcement_rule.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#engineering", "type": "announcement_rule" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "announcement_rule.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#engineering", "type": "announcement_rule" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsCatalogEntryAttributeUpdatedV1": { "example": { "action": "catalog_entry_attribute.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "after_values": [ "01FCNDV6P870EA6S7TK1DSYDG0", "01FCNDV6P870EA6S7TK1DSYDG2" ], "before_values": [ "01FCNDV6P870EA6S7TK1DSYDG0", "01FCNDV6P870EA6S7TK1DSYDG1" ] }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Service", "type": "catalog_type" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Engineering Team", "type": "catalog_entry" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Members", "type": "catalog_attribute" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "catalog_entry_attribute.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "metadata": { "$ref": "#/components/schemas/AuditLogCatalogAttributeUpdatedMetadataV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Service", "type": "catalog_type" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Engineering Team", "type": "catalog_entry" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Members", "type": "catalog_attribute" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context", "metadata" ], "type": "object" }, "AuditLogsCatalogEntryAttributeUpdatedV2": { "example": { "action": "catalog_entry_attribute.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "after_values": "01FCNDV6P870EA6S7TK1DSYDG0,01FCNDV6P870EA6S7TK1DSYDG2", "before_values": "01FCNDV6P870EA6S7TK1DSYDG0,01FCNDV6P870EA6S7TK1DSYDG1" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Service", "type": "catalog_type" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Engineering Team", "type": "catalog_entry" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Members", "type": "catalog_attribute" } ], "version": 2 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "catalog_entry_attribute.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "metadata": { "$ref": "#/components/schemas/AuditLogCatalogAttributeUpdatedMetadataV2V2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Service", "type": "catalog_type" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Engineering Team", "type": "catalog_entry" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Members", "type": "catalog_attribute" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 2, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context", "metadata" ], "type": "object" }, "AuditLogsCatalogTypeCreatedV1": { "example": { "action": "catalog_type.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Service", "type": "catalog_type" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "catalog_type.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Service", "type": "catalog_type" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsCatalogTypeDeletedV1": { "example": { "action": "catalog_type.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Service", "type": "catalog_type" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "catalog_type.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Service", "type": "catalog_type" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsCatalogTypeUpdatedV1": { "example": { "action": "catalog_type.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Service", "type": "catalog_type" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "catalog_type.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Service", "type": "catalog_type" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsConnectorConfigCreatedV1": { "example": { "action": "connector_config.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My Connector", "type": "connector_config" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "connector_config.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My Connector", "type": "connector_config" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsConnectorConfigTokenGeneratedV1": { "example": { "action": "connector_config.token_generated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My Connector", "type": "connector_config" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "connector_config.token_generated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My Connector", "type": "connector_config" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsConnectorConfigUpdatedV1": { "example": { "action": "connector_config.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My Connector", "type": "connector_config" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "connector_config.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My Connector", "type": "connector_config" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsCustomFieldCreatedV1": { "example": { "action": "custom_field.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected teams", "type": "custom_field" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "custom_field.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected teams", "type": "custom_field" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsCustomFieldDeletedV1": { "example": { "action": "custom_field.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected teams", "type": "custom_field" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "custom_field.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected teams", "type": "custom_field" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsCustomFieldUpdatedV1": { "example": { "action": "custom_field.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected teams", "type": "custom_field" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "custom_field.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected teams", "type": "custom_field" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsDebriefInviteRuleCreatedV1": { "example": { "action": "debrief_invite_rule.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Invite founders for critical incidents", "type": "debrief_invite_rule" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "debrief_invite_rule.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Invite founders for critical incidents", "type": "debrief_invite_rule" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsDebriefInviteRuleDeletedV1": { "example": { "action": "debrief_invite_rule.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Invite founders for critical incidents", "type": "debrief_invite_rule" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "debrief_invite_rule.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Invite founders for critical incidents", "type": "debrief_invite_rule" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsDebriefInviteRuleUpdatedV1": { "example": { "action": "debrief_invite_rule.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Invite founders for critical incidents", "type": "debrief_invite_rule" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "debrief_invite_rule.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Invite founders for critical incidents", "type": "debrief_invite_rule" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsEmailOtpLoginSettingUpdatedV1": { "example": { "action": "email_otp_login_setting.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "enabled": "true" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Organisation Settings", "type": "organisation_settings" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "email_otp_login_setting.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "metadata": { "$ref": "#/components/schemas/AuditLogEmailOtpLoginSettingUpdatedMetadataV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Organisation Settings", "type": "organisation_settings" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context", "metadata" ], "type": "object" }, "AuditLogsEscalationPathCreatedV1": { "example": { "action": "escalation_path.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Critical incidents", "type": "escalation_path" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "escalation_path.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Critical incidents", "type": "escalation_path" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsEscalationPathDeletedV1": { "example": { "action": "escalation_path.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Critical incidents", "type": "escalation_path" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "escalation_path.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Critical incidents", "type": "escalation_path" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsEscalationPathUpdatedV1": { "example": { "action": "escalation_path.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Critical incidents", "type": "escalation_path" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "escalation_path.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Critical incidents", "type": "escalation_path" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsEscalationScrubbedV1": { "example": { "action": "escalation.scrubbed", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Escalation (01KB0083ASNF7EPT8NHQNRDXFC)", "type": "escalation" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "escalation.scrubbed", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Escalation (01KB0083ASNF7EPT8NHQNRDXFC)", "type": "escalation" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsFollowUpCategoryCreatedV1": { "example": { "action": "follow_up_category.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Category Name", "type": "follow_up_category" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "follow_up_category.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Category Name", "type": "follow_up_category" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsFollowUpCategoryDeletedV1": { "example": { "action": "follow_up_category.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Category Name", "type": "follow_up_category" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "follow_up_category.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Category Name", "type": "follow_up_category" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsFollowUpCategoryUpdatedV1": { "example": { "action": "follow_up_category.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Category Name", "type": "follow_up_category" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "follow_up_category.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Category Name", "type": "follow_up_category" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsFollowUpPriorityCreatedV1": { "example": { "action": "follow_up_priority.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Low", "type": "follow_up_priority" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "follow_up_priority.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Low", "type": "follow_up_priority" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsFollowUpPriorityDeletedV1": { "example": { "action": "follow_up_priority.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Low", "type": "follow_up_priority" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "follow_up_priority.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Low", "type": "follow_up_priority" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsFollowUpPriorityUpdatedV1": { "example": { "action": "follow_up_priority.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Low", "type": "follow_up_priority" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "follow_up_priority.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Low", "type": "follow_up_priority" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsHolidayUserFeedCreatedV1": { "example": { "action": "holiday_user_feed.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "US Team holidays", "type": "holiday_user_feed" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "holiday_user_feed.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "US Team holidays", "type": "holiday_user_feed" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsHolidayUserFeedDeletedV1": { "example": { "action": "holiday_user_feed.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "US Team holidays", "type": "holiday_user_feed" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "holiday_user_feed.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "US Team holidays", "type": "holiday_user_feed" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsHolidayUserFeedUpdatedV1": { "example": { "action": "holiday_user_feed.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "US Team holidays", "type": "holiday_user_feed" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "holiday_user_feed.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "US Team holidays", "type": "holiday_user_feed" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsIPAllowlistUpdatedV1": { "example": { "action": "ip_allowlist.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "additions": "[\"192.0.2.0\",\"192.0.2.0/24\"]", "additions_count": "2", "enabled": "true", "removals": "[\"192.0.2.1\"]", "removals_count": "1", "version": "2" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "IP allowlist", "type": "ip_allowlist" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "ip_allowlist.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "metadata": { "$ref": "#/components/schemas/AuditLogIPAllowlistUpdatedMetadataV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "IP allowlist", "type": "ip_allowlist" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context", "metadata" ], "type": "object" }, "AuditLogsIncidentCallSettingUpdatedV1": { "example": { "action": "incident_call_setting.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Incident call settings", "type": "incident_call_setting" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "incident_call_setting.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Incident call settings", "type": "incident_call_setting" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsIncidentCallTranscriptionSessionDeletedV1": { "example": { "action": "incident_call_transcription_session.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Call transcription session", "type": "incident_call_transcription_session" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "incident_call_transcription_session.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Call transcription session", "type": "incident_call_transcription_session" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsIncidentDurationMetricCreatedV1": { "example": { "action": "incident_duration_metric.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Time to resolve", "type": "incident_duration_metric" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "incident_duration_metric.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Time to resolve", "type": "incident_duration_metric" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsIncidentDurationMetricDeletedV1": { "example": { "action": "incident_duration_metric.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Time to resolve", "type": "incident_duration_metric" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "incident_duration_metric.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Time to resolve", "type": "incident_duration_metric" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsIncidentDurationMetricUpdatedV1": { "example": { "action": "incident_duration_metric.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Time to resolve", "type": "incident_duration_metric" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "incident_duration_metric.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Time to resolve", "type": "incident_duration_metric" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsIncidentRoleCreatedV1": { "example": { "action": "incident_role.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Communications Lead", "type": "incident_role" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "incident_role.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Communications Lead", "type": "incident_role" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsIncidentRoleDeletedV1": { "example": { "action": "incident_role.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Communications Lead", "type": "incident_role" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "incident_role.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Communications Lead", "type": "incident_role" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsIncidentRoleUpdatedV1": { "example": { "action": "incident_role.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Communications Lead", "type": "incident_role" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "incident_role.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Communications Lead", "type": "incident_role" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsIncidentStatusCreatedV1": { "example": { "action": "incident_status.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Investigating", "type": "incident_status" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "incident_status.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Investigating", "type": "incident_status" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsIncidentStatusDeletedV1": { "example": { "action": "incident_status.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Investigating", "type": "incident_status" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "incident_status.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Investigating", "type": "incident_status" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsIncidentStatusUpdatedV1": { "example": { "action": "incident_status.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Investigating", "type": "incident_status" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "incident_status.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Investigating", "type": "incident_status" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsIncidentTimestampCreatedV1": { "example": { "action": "incident_timestamp.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Fixed at", "type": "incident_timestamp" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "incident_timestamp.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Fixed at", "type": "incident_timestamp" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsIncidentTimestampDeletedV1": { "example": { "action": "incident_timestamp.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Fixed at", "type": "incident_timestamp" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "incident_timestamp.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Fixed at", "type": "incident_timestamp" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsIncidentTimestampSetByRuleCreatedV1": { "example": { "action": "incident_timestamp_set_by_rule.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Fixed at", "type": "incident_timestamp" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Resolved at ('set by' rule)", "type": "incident_timestamp_set_by_rule" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "incident_timestamp_set_by_rule.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Fixed at", "type": "incident_timestamp" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Resolved at ('set by' rule)", "type": "incident_timestamp_set_by_rule" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsIncidentTimestampSetByRuleDeletedV1": { "example": { "action": "incident_timestamp_set_by_rule.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Fixed at", "type": "incident_timestamp" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Resolved at ('set by' rule)", "type": "incident_timestamp_set_by_rule" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "incident_timestamp_set_by_rule.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Fixed at", "type": "incident_timestamp" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Resolved at ('set by' rule)", "type": "incident_timestamp_set_by_rule" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsIncidentTimestampSetByRuleUpdatedV1": { "example": { "action": "incident_timestamp_set_by_rule.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Fixed at", "type": "incident_timestamp" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Resolved at ('set by' rule)", "type": "incident_timestamp_set_by_rule" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "incident_timestamp_set_by_rule.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Fixed at", "type": "incident_timestamp" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Resolved at ('set by' rule)", "type": "incident_timestamp_set_by_rule" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsIncidentTimestampUpdatedV1": { "example": { "action": "incident_timestamp.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Fixed at", "type": "incident_timestamp" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "incident_timestamp.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Fixed at", "type": "incident_timestamp" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsIncidentTypeCreatedV1": { "example": { "action": "incident_type.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Security", "type": "incident_type" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "incident_type.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Security", "type": "incident_type" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsIncidentTypeDeletedV1": { "example": { "action": "incident_type.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Security", "type": "incident_type" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "incident_type.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Security", "type": "incident_type" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsIncidentTypeUpdatedV1": { "example": { "action": "incident_type.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Security", "type": "incident_type" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "incident_type.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Security", "type": "incident_type" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsIntegrationInstalledV1": { "example": { "action": "integration.installed", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "github", "name": "Github", "type": "integration" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "integration.installed", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "github", "name": "Github", "type": "integration" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsIntegrationUninstalledV1": { "example": { "action": "integration.uninstalled", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "github", "name": "Github", "type": "integration" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "integration.uninstalled", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "github", "name": "Github", "type": "integration" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsInternalStatusPageCreatedV1": { "example": { "action": "internal_status_page.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Public Page", "type": "internal_status_page" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "internal_status_page.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Public Page", "type": "internal_status_page" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsInternalStatusPageDeletedV1": { "example": { "action": "internal_status_page.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Public Page", "type": "internal_status_page" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "internal_status_page.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Public Page", "type": "internal_status_page" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsInternalStatusPageUpdatedV1": { "example": { "action": "internal_status_page.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Public Page", "type": "internal_status_page" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "internal_status_page.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Public Page", "type": "internal_status_page" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsMaintenanceWindowCreatedV1": { "example": { "action": "maintenance_window.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Planned DB migration", "type": "maintenance_window" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "maintenance_window.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Planned DB migration", "type": "maintenance_window" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsMaintenanceWindowDeletedV1": { "example": { "action": "maintenance_window.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Planned DB migration", "type": "maintenance_window" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "maintenance_window.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Planned DB migration", "type": "maintenance_window" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsMaintenanceWindowUpdatedV1": { "example": { "action": "maintenance_window.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Planned DB migration", "type": "maintenance_window" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "maintenance_window.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Planned DB migration", "type": "maintenance_window" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsNudgeCreatedV1": { "example": { "action": "nudge.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Reminder to take a break", "type": "nudge" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "nudge.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Reminder to take a break", "type": "nudge" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsNudgeDeletedV1": { "example": { "action": "nudge.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Reminder to take a break", "type": "nudge" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "nudge.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Reminder to take a break", "type": "nudge" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsNudgeUpdatedV1": { "example": { "action": "nudge.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Reminder to take a break", "type": "nudge" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "nudge.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Reminder to take a break", "type": "nudge" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsOnCallNotificationMethodCreatedV1": { "example": { "action": "on_call_notification_method.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Phone notification method", "type": "on_call_notification_method" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "on_call_notification_method.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Phone notification method", "type": "on_call_notification_method" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsOnCallNotificationMethodCreatedV2": { "example": { "action": "on_call_notification_method.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "target_user": "01JV9EMFCFRGCFVNDWTBKT2EBR" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Phone notification method", "type": "on_call_notification_method" } ], "version": 2 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "on_call_notification_method.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "metadata": { "$ref": "#/components/schemas/AuditLogOnCallNotificationMethodMetadataV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Phone notification method", "type": "on_call_notification_method" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 2, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context", "metadata" ], "type": "object" }, "AuditLogsOnCallNotificationMethodDestroyedV1": { "example": { "action": "on_call_notification_method.destroyed", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Phone notification method", "type": "on_call_notification_method" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "on_call_notification_method.destroyed", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Phone notification method", "type": "on_call_notification_method" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsOnCallNotificationMethodDestroyedV2": { "example": { "action": "on_call_notification_method.destroyed", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "target_user": "01JV9EMFCFRGCFVNDWTBKT2EBR" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Phone notification method", "type": "on_call_notification_method" } ], "version": 2 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "on_call_notification_method.destroyed", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "metadata": { "$ref": "#/components/schemas/AuditLogOnCallNotificationMethodMetadataV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Phone notification method", "type": "on_call_notification_method" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 2, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context", "metadata" ], "type": "object" }, "AuditLogsOrganisationSettingsUpdatedV1": { "example": { "action": "organisation_settings.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "default_timezone": "Europe/London" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Organisation Settings", "type": "organisation_settings" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "organisation_settings.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "metadata": { "$ref": "#/components/schemas/AuditLogOrganisationSettingsUpdatedMetadataV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Organisation Settings", "type": "organisation_settings" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context", "metadata" ], "type": "object" }, "AuditLogsPolicyCreatedV1": { "example": { "action": "policy.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Follow-ups must be closed within 3 weeks", "type": "policy" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "policy.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Follow-ups must be closed within 3 weeks", "type": "policy" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsPolicyDeletedV1": { "example": { "action": "policy.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Follow-ups must be closed within 3 weeks", "type": "policy" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "policy.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Follow-ups must be closed within 3 weeks", "type": "policy" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsPolicyUpdatedV1": { "example": { "action": "policy.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Follow-ups must be closed within 3 weeks", "type": "policy" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "policy.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Follow-ups must be closed within 3 weeks", "type": "policy" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsPostIncidentTaskCreatedV1": { "example": { "action": "post_incident_task.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "post_incident_task.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsPostIncidentTaskDeletedV1": { "example": { "action": "post_incident_task.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "post_incident_task.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsPostIncidentTaskUpdatedV1": { "example": { "action": "post_incident_task.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "post_incident_task.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsPostmortemSectionCreatedV1": { "example": { "action": "postmortem_section.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "postmortem_section.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsPostmortemSectionCreatedV2": { "example": { "action": "postmortem_section.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "follow_ups", "type": "postmortem_template_section" } ], "version": 2 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "postmortem_section.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "follow_ups", "type": "postmortem_template_section" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 2, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsPostmortemSectionDeletedV1": { "example": { "action": "postmortem_section.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "postmortem_section.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsPostmortemSectionDeletedV2": { "example": { "action": "postmortem_section.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "follow_ups", "type": "postmortem_template_section" } ], "version": 2 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "postmortem_section.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "follow_ups", "type": "postmortem_template_section" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 2, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsPostmortemSectionUpdatedV1": { "example": { "action": "postmortem_section.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "postmortem_section.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsPostmortemSectionUpdatedV2": { "example": { "action": "postmortem_section.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "follow_ups", "type": "postmortem_template_section" } ], "version": 2 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "postmortem_section.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "follow_ups", "type": "postmortem_template_section" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 2, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsPostmortemTemplateCreatedV1": { "example": { "action": "postmortem_template.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "postmortem_template.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsPostmortemTemplateCreatedV2": { "example": { "action": "postmortem_template.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Root cause analysis (RCA)", "type": "postmortem_template" } ], "version": 2 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "postmortem_template.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Root cause analysis (RCA)", "type": "postmortem_template" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 2, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsPostmortemTemplateDeletedV1": { "example": { "action": "postmortem_template.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "postmortem_template.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsPostmortemTemplateDeletedV2": { "example": { "action": "postmortem_template.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Root cause analysis (RCA)", "type": "postmortem_template" } ], "version": 2 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "postmortem_template.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Root cause analysis (RCA)", "type": "postmortem_template" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 2, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsPostmortemTemplateUpdatedV1": { "example": { "action": "postmortem_template.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "postmortem_template.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsPostmortemTemplateUpdatedV2": { "example": { "action": "postmortem_template.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Root cause analysis (RCA)", "type": "postmortem_template" } ], "version": 2 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "postmortem_template.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Root cause analysis (RCA)", "type": "postmortem_template" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 2, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsPrivateAlertAccessAttemptedV1": { "example": { "action": "private_alert.access_attempted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "outcome": "granted" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Alert (01KB0083ASNF7EPT8NHQNRDXFC)", "type": "alert" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "private_alert.access_attempted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "metadata": { "$ref": "#/components/schemas/AuditLogPrivateAlertAccessAttemptedMetadataV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Alert (01KB0083ASNF7EPT8NHQNRDXFC)", "type": "alert" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context", "metadata" ], "type": "object" }, "AuditLogsPrivateEscalationAccessAttemptedV1": { "example": { "action": "private_escalation.access_attempted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "outcome": "granted" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Escalation (01KB0083ASNF7EPT8NHQNRDXFC)", "type": "escalation" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "private_escalation.access_attempted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "metadata": { "$ref": "#/components/schemas/AuditLogPrivateEscalationAccessAttemptedMetadataV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Escalation (01KB0083ASNF7EPT8NHQNRDXFC)", "type": "escalation" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context", "metadata" ], "type": "object" }, "AuditLogsPrivateIncidentAccessAttemptedV1": { "example": { "action": "private_incident.access_attempted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "outcome": "granted" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#INC-123 The website is slow", "type": "incident" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "private_incident.access_attempted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "metadata": { "$ref": "#/components/schemas/AuditLogPrivateIncidentAccessAttemptedMetadataV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#INC-123 The website is slow", "type": "incident" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context", "metadata" ], "type": "object" }, "AuditLogsPrivateIncidentAccessRequestedV1": { "example": { "action": "private_incident.access_requested", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#INC-123 The website is slow", "type": "incident" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "private_incident.access_requested", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#INC-123 The website is slow", "type": "incident" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsPrivateIncidentAccessedViaBotV1": { "example": { "action": "private_incident.accessed_via_bot", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#INC-123 The website is slow", "type": "incident" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "private_incident.accessed_via_bot", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#INC-123 The website is slow", "type": "incident" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsPrivateIncidentMembershipGrantedV1": { "example": { "action": "private_incident_membership.granted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#INC-123 The website is slow", "type": "incident" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "private_incident_membership.granted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#INC-123 The website is slow", "type": "incident" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsPrivateIncidentMembershipRevokedV1": { "example": { "action": "private_incident_membership.revoked", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#INC-123 The website is slow", "type": "incident" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "private_incident_membership.revoked", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#INC-123 The website is slow", "type": "incident" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsQrCodeMobileLoginSettingUpdatedV1": { "example": { "action": "qr_code_mobile_login_setting.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "enabled": "true" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Organisation Settings", "type": "organisation_settings" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "qr_code_mobile_login_setting.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "metadata": { "$ref": "#/components/schemas/AuditLogQrCodeMobileLoginSettingUpdatedMetadataV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Organisation Settings", "type": "organisation_settings" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context", "metadata" ], "type": "object" }, "AuditLogsRbacRoleCreatedV1": { "example": { "action": "rbac_role.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Engineering", "type": "rbac_role" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "rbac_role.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Engineering", "type": "rbac_role" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsRbacRoleDeletedV1": { "example": { "action": "rbac_role.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Engineering", "type": "rbac_role" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "rbac_role.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Engineering", "type": "rbac_role" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsRbacRoleUpdatedV1": { "example": { "action": "rbac_role.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Engineering", "type": "rbac_role" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "rbac_role.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Engineering", "type": "rbac_role" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsScheduleCreatedV1": { "example": { "action": "schedule.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "On-call", "type": "schedule" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "schedule.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "On-call", "type": "schedule" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsScheduleDeletedV1": { "example": { "action": "schedule.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "On-call", "type": "schedule" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "schedule.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "On-call", "type": "schedule" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsScheduleOverrideCreatedV1": { "example": { "action": "schedule_override.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Override for Urgent Support", "type": "schedule_override" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "schedule_override.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Override for Urgent Support", "type": "schedule_override" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsScheduleOverrideCreatedV2": { "example": { "action": "schedule_override.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "after_user_ids": "01FCNDV6P870EA6S7TK1DSYDG2", "after_user_names": "Nicole C", "before_user_ids": "01FCNDV6P870EA6S7TK1DSYDG0,01FCNDV6P870EA6S7TK1DSYDG1", "before_user_names": "Nicole A,Nicole B", "end_at": "2026-03-02T08:00:00Z", "start_at": "2026-03-01T18:00:00Z" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Override for Urgent Support", "type": "schedule_override" } ], "version": 2 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "schedule_override.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "metadata": { "$ref": "#/components/schemas/AuditLogScheduleOverrideMetadataV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Override for Urgent Support", "type": "schedule_override" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 2, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context", "metadata" ], "type": "object" }, "AuditLogsScheduleOverrideDeletedV1": { "example": { "action": "schedule_override.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Override for Urgent Support", "type": "schedule_override" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "schedule_override.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Override for Urgent Support", "type": "schedule_override" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsScheduleOverrideDeletedV2": { "example": { "action": "schedule_override.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "after_user_ids": "01FCNDV6P870EA6S7TK1DSYDG2", "after_user_names": "Nicole C", "before_user_ids": "01FCNDV6P870EA6S7TK1DSYDG0,01FCNDV6P870EA6S7TK1DSYDG1", "before_user_names": "Nicole A,Nicole B", "end_at": "2026-03-02T08:00:00Z", "start_at": "2026-03-01T18:00:00Z" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Override for Urgent Support", "type": "schedule_override" } ], "version": 2 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "schedule_override.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "metadata": { "$ref": "#/components/schemas/AuditLogScheduleOverrideMetadataV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Override for Urgent Support", "type": "schedule_override" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 2, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context", "metadata" ], "type": "object" }, "AuditLogsScheduleOverrideUpdatedV1": { "example": { "action": "schedule_override.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Override for Urgent Support", "type": "schedule_override" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "schedule_override.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Override for Urgent Support", "type": "schedule_override" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsScheduleOverrideUpdatedV2": { "example": { "action": "schedule_override.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "after_user_ids": "01FCNDV6P870EA6S7TK1DSYDG2", "after_user_names": "Nicole C", "before_user_ids": "01FCNDV6P870EA6S7TK1DSYDG0,01FCNDV6P870EA6S7TK1DSYDG1", "before_user_names": "Nicole A,Nicole B", "end_at": "2026-03-02T08:00:00Z", "start_at": "2026-03-01T18:00:00Z" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Override for Urgent Support", "type": "schedule_override" } ], "version": 2 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "schedule_override.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "metadata": { "$ref": "#/components/schemas/AuditLogScheduleOverrideMetadataV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Override for Urgent Support", "type": "schedule_override" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 2, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context", "metadata" ], "type": "object" }, "AuditLogsScheduleUpdatedV1": { "example": { "action": "schedule.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "On-call", "type": "schedule" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "schedule.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "On-call", "type": "schedule" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsScimGroupRoleMappingsUpdatedV1": { "example": { "action": "scim_group.role_mappings_updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "after_base_role_slug": "owner", "after_custom_role_slugs": "engineering,data", "before_base_role_slug": "admin", "before_custom_role_slugs": "engineering,security" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Security", "type": "scim_group" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "scim_group.role_mappings_updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "metadata": { "$ref": "#/components/schemas/AuditLogUserSCIMGroupMappingChangedMetadataV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Security", "type": "scim_group" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context", "metadata" ], "type": "object" }, "AuditLogsScimGroupSeatMappingsUpdatedV1": { "example": { "action": "scim_group.seat_mappings_updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "after_seat_types": "[full_access, responder_access]", "before_seat_types": "[full_access]" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Security", "type": "scim_group" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "scim_group.seat_mappings_updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "metadata": { "$ref": "#/components/schemas/AuditLogSCIMGroupSeatMappingChangedMetadataV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Security", "type": "scim_group" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context", "metadata" ], "type": "object" }, "AuditLogsSeverityCreatedV1": { "example": { "action": "severity.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "type": "severity" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "severity.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "type": "severity" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsSeverityDeletedV1": { "example": { "action": "severity.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "type": "severity" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "severity.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "type": "severity" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsSeverityUpdatedV1": { "example": { "action": "severity.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "type": "severity" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "severity.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "type": "severity" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsStatusPageCreatedV1": { "example": { "action": "status_page.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Public Page", "type": "status_page" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "status_page.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Public Page", "type": "status_page" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsStatusPageDeletedV1": { "example": { "action": "status_page.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Public Page", "type": "status_page" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "status_page.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Public Page", "type": "status_page" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsStatusPageSubPageCreatedV1": { "example": { "action": "status_page_sub_page.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Superpayments France", "type": "status_page_sub_page" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "status_page_sub_page.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Superpayments France", "type": "status_page_sub_page" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsStatusPageSubPageDeletedV1": { "example": { "action": "status_page_sub_page.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Superpayments France", "type": "status_page_sub_page" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "status_page_sub_page.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Superpayments France", "type": "status_page_sub_page" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsStatusPageSubPageUpdatedV1": { "example": { "action": "status_page_sub_page.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Superpayments France", "type": "status_page_sub_page" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "status_page_sub_page.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Superpayments France", "type": "status_page_sub_page" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsStatusPageTemplateCreatedV1": { "example": { "action": "status_page_template.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Investigating", "type": "status_page_template" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "status_page_template.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Investigating", "type": "status_page_template" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsStatusPageTemplateDeletedV1": { "example": { "action": "status_page_template.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Investigating", "type": "status_page_template" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "status_page_template.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Investigating", "type": "status_page_template" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsStatusPageTemplateUpdatedV1": { "example": { "action": "status_page_template.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Investigating", "type": "status_page_template" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "status_page_template.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Investigating", "type": "status_page_template" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsStatusPageUpdatedV1": { "example": { "action": "status_page.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Public Page", "type": "status_page" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "status_page.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Public Page", "type": "status_page" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsTeamRoleCreatedV1": { "example": { "action": "team_role.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Tech lead", "type": "team_role" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "team_role.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Tech lead", "type": "team_role" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsTeamRoleDeletedV1": { "example": { "action": "team_role.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Tech lead", "type": "team_role" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "team_role.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Tech lead", "type": "team_role" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsTeamRoleUpdatedV1": { "example": { "action": "team_role.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Tech lead", "type": "team_role" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "team_role.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Tech lead", "type": "team_role" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsTeamSettingsUpdatedV1": { "example": { "action": "team_settings.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Team Settings", "type": "team_settings" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "team_settings.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Team Settings", "type": "team_settings" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsTelemetryDataSourceInstalledV1": { "example": { "action": "telemetry_data_source.installed", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Grafana Cloud", "type": "telemetry_data_source" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "telemetry_data_source.installed", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Grafana Cloud", "type": "telemetry_data_source" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsTelemetryDataSourceUninstalledV1": { "example": { "action": "telemetry_data_source.uninstalled", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Grafana Cloud", "type": "telemetry_data_source" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "telemetry_data_source.uninstalled", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Grafana Cloud", "type": "telemetry_data_source" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsTimelineItemDeletedV1": { "example": { "action": "timeline_item.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Timeline item (01FCNDV6P870EA6S7TK1DSYDG0)", "type": "timeline_item" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "timeline_item.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Timeline item (01FCNDV6P870EA6S7TK1DSYDG0)", "type": "timeline_item" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsUserCreatedV1": { "example": { "action": "user.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "user.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsUserDeactivatedV1": { "example": { "action": "user.deactivated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "user.deactivated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsUserReinstatedV1": { "example": { "action": "user.reinstated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "user.reinstated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsUserRoleMembershipsUpdatedV1": { "example": { "action": "user.role_memberships_updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "after_base_role_slug": "owner", "after_custom_role_slugs": "engineering,data", "before_base_role_slug": "admin", "before_custom_role_slugs": "engineering,security" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "user.role_memberships_updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "metadata": { "$ref": "#/components/schemas/AuditLogUserRoleMembershipChangedMetadataV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context", "metadata" ], "type": "object" }, "AuditLogsUserUpdatedV1": { "example": { "action": "user.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "user.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsWorkflowCreatedV1": { "example": { "action": "workflow.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Nudge to write a postmortem", "type": "workflow" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "workflow.created", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Nudge to write a postmortem", "type": "workflow" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsWorkflowDeletedV1": { "example": { "action": "workflow.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Nudge to write a postmortem", "type": "workflow" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "workflow.deleted", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Nudge to write a postmortem", "type": "workflow" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "AuditLogsWorkflowUpdatedV1": { "example": { "action": "workflow.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Nudge to write a postmortem", "type": "workflow" } ], "version": 1 }, "properties": { "action": { "description": "The type of log entry that this is", "example": "workflow.updated", "type": "string" }, "actor": { "$ref": "#/components/schemas/AuditLogActorV2" }, "context": { "$ref": "#/components/schemas/AuditLogEntryContextV2" }, "occurred_at": { "description": "When the entry occurred", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "targets": { "description": "The custom field that was created", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Nudge to write a postmortem", "type": "workflow" } ], "items": { "$ref": "#/components/schemas/AuditLogTargetV2" }, "type": "array" }, "version": { "description": "Which version the event is", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "action", "occurred_at", "version", "actor", "targets", "context" ], "type": "object" }, "CatalogBulkUpdateEntriesPayloadV3": { "example": { "catalog_type_id": "01GW2G3V0S59R238FAHPDS1R66", "entries": [ { "aliases": [ "abc123" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "entry_id": "abc123", "external_id": "abc123", "name": "abc123", "rank": 1 }, { "aliases": [ "abc123" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "entry_id": "abc123", "external_id": "abc123", "name": "abc123", "rank": 1 } ], "update_attributes": [ "01GW2G3V0S59R238FAHPDS1R66", "01GW2G3V0S59R238FAHPDS1R67" ] }, "properties": { "catalog_type_id": { "description": "The unique identifier of the catalog type containing the entries", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "entries": { "description": "A list of entries to update with their new values. Maximum 250 entries per request.", "example": [ { "aliases": [ "abc123" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "entry_id": "abc123", "external_id": "abc123", "name": "abc123", "rank": 1 }, { "aliases": [ "abc123" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "entry_id": "abc123", "external_id": "abc123", "name": "abc123", "rank": 1 } ], "items": { "$ref": "#/components/schemas/PartialEntryPayloadV3" }, "maxItems": 250, "minItems": 1, "type": "array" }, "update_attributes": { "description": "Optional list of specific attribute IDs to update across all entries. When provided, only these attributes in attribute_values will be updated and all other attributes will be preserved. This parameter only affects attribute_values - it does not affect core entry fields like name, rank, aliases, or external_id, which follow their individual omission rules.", "example": [ "01GW2G3V0S59R238FAHPDS1R66", "01GW2G3V0S59R238FAHPDS1R67" ], "items": { "example": "abc123", "type": "string" }, "type": "array" } }, "required": [ "catalog_type_id", "entries" ], "type": "object" }, "CatalogCreateEntryPayloadV2": { "example": { "aliases": [ "lawrence@incident.io", "lawrence" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "name": "Primary On-call", "rank": 3 }, "properties": { "aliases": { "description": "Optional aliases that can be used to reference this entry", "example": [ "lawrence@incident.io", "lawrence" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "attribute_values": { "additionalProperties": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "description": "Values of this entry", "example": { "abc123": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "type": "object" }, "catalog_type_id": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "external_id": { "description": "An optional alternative ID for this entry, which is ensured to be unique for the type", "example": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "type": "string" }, "name": { "description": "Name is the human readable name of this entry", "example": "Primary On-call", "type": "string" }, "rank": { "description": "When catalog type is ranked, this is used to help order things", "example": 3, "format": "int32", "type": "integer" } }, "required": [ "catalog_type_id", "name", "attribute_values" ], "type": "object" }, "CatalogCreateEntryPayloadV3": { "example": { "aliases": [ "lawrence@incident.io", "lawrence" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "name": "Primary On-call", "rank": 3 }, "properties": { "aliases": { "description": "Optional aliases that can be used to reference this entry", "example": [ "lawrence@incident.io", "lawrence" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "attribute_values": { "additionalProperties": { "$ref": "#/components/schemas/CatalogEngineParamBindingPayloadV3" }, "description": "Values of this entry", "example": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "type": "object" }, "catalog_type_id": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "external_id": { "description": "An optional alternative ID for this entry, which is ensured to be unique for the type", "example": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "type": "string" }, "name": { "description": "Name is the human readable name of this entry", "example": "Primary On-call", "type": "string" }, "rank": { "description": "When catalog type is ranked, this is used to help order things", "example": 3, "format": "int32", "type": "integer" } }, "required": [ "catalog_type_id", "name", "attribute_values" ], "type": "object" }, "CatalogCreateEntryResultV2": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "catalog_entry": { "$ref": "#/components/schemas/CatalogEntryV2" } }, "required": [ "catalog_entry" ], "type": "object" }, "CatalogCreateEntryResultV3": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "catalog_entry": { "$ref": "#/components/schemas/CatalogEntryV3" } }, "required": [ "catalog_entry" ], "type": "object" }, "CatalogCreateTypePayloadV2": { "example": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "description": "Represents Kubernetes clusters that we run inside of GKE.", "icon": "alert", "name": "Kubernetes Cluster", "ranked": true, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]" }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that can track metadata about this type", "example": { "incident.io/catalog-importer/id": "id-of-config" }, "type": "object" }, "categories": { "description": "What categories is this type considered part of", "example": [ "customer" ], "items": { "enum": [ "customer", "issue-tracker", "product-feature", "service", "on-call", "team", "user" ], "example": "customer", "type": "string" }, "type": "array" }, "color": { "description": "Sets the display color of this type in the dashboard", "enum": [ "yellow", "green", "blue", "violet", "pink", "cyan", "orange" ], "example": "yellow", "type": "string" }, "description": { "description": "Human readble description of this type", "example": "Represents Kubernetes clusters that we run inside of GKE.", "type": "string" }, "icon": { "description": "Sets the display icon of this type in the dashboard", "enum": [ "alert", "bolt", "box", "briefcase", "browser", "bulb", "calendar", "clock", "cog", "components", "database", "doc", "email", "escalation-path", "files", "flag", "folder", "globe", "money", "server", "severity", "status-page", "store", "star", "tag", "user", "users" ], "example": "alert", "type": "string" }, "name": { "description": "Name is the human readable name of this type", "example": "Kubernetes Cluster", "type": "string" }, "ranked": { "description": "If this type should be ranked", "example": true, "type": "boolean" }, "source_repo_url": { "description": "The url of the external repository where this type is managed", "example": "https://github.com/my-company/incident-io-catalog", "type": "string" }, "type_name": { "description": "The type name of this catalog type, to be used when defining attributes. This is immutable once a CatalogType has been created. For non-externally sync types, it must follow the pattern Custom[\"SomeName\"]", "example": "Custom[\"BackstageGroup\"]", "type": "string" } }, "required": [ "name", "description" ], "type": "object" }, "CatalogCreateTypePayloadV3": { "example": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "description": "Represents Kubernetes clusters that we run inside of GKE.", "icon": "alert", "name": "Kubernetes Cluster", "ranked": true, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "use_name_as_identifier": true }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that can track metadata about this type", "example": { "incident.io/catalog-importer/id": "id-of-config" }, "type": "object" }, "categories": { "description": "What categories is this type considered part of", "example": [ "customer" ], "items": { "enum": [ "customer", "issue-tracker", "product-feature", "service", "on-call", "team", "user" ], "example": "customer", "type": "string" }, "type": "array" }, "color": { "description": "Sets the display color of this type in the dashboard", "enum": [ "yellow", "green", "blue", "violet", "pink", "cyan", "orange" ], "example": "yellow", "type": "string" }, "description": { "description": "Human readble description of this type", "example": "Represents Kubernetes clusters that we run inside of GKE.", "type": "string" }, "icon": { "description": "Sets the display icon of this type in the dashboard", "enum": [ "alert", "bolt", "box", "briefcase", "browser", "bulb", "calendar", "clock", "cog", "components", "database", "doc", "email", "escalation-path", "files", "flag", "folder", "globe", "money", "server", "severity", "status-page", "store", "star", "tag", "user", "users" ], "example": "alert", "type": "string" }, "name": { "description": "Name is the human readable name of this type", "example": "Kubernetes Cluster", "type": "string" }, "ranked": { "description": "If this type should be ranked", "example": true, "type": "boolean" }, "source_repo_url": { "description": "The url of the external repository where this type is managed", "example": "https://github.com/my-company/incident-io-catalog", "type": "string" }, "type_name": { "description": "The type name of this catalog type, to be used when defining attributes. This is immutable once a CatalogType has been created. For non-externally sync types, it must follow the pattern Custom[\"SomeName\"]", "example": "Custom[\"BackstageGroup\"]", "type": "string" }, "use_name_as_identifier": { "description": "If enabled, you can refer to entries of this type by their name, as well as their external ID and any aliases.", "example": true, "type": "boolean" } }, "required": [ "name", "description" ], "type": "object" }, "CatalogCreateTypeResultV2": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV2" } }, "required": [ "catalog_type" ], "type": "object" }, "CatalogCreateTypeResultV3": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "properties": { "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV3" } }, "required": [ "catalog_type" ], "type": "object" }, "CatalogEngineParamBindingPayloadV3": { "example": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } }, "properties": { "array_value": { "description": "If set, this is the array value of the step parameter", "example": [ { "literal": "SEV123" } ], "items": { "$ref": "#/components/schemas/CatalogEngineParamBindingValuePayloadV3" }, "type": "array" }, "value": { "$ref": "#/components/schemas/CatalogEngineParamBindingValuePayloadV3" } }, "type": "object" }, "CatalogEngineParamBindingValuePayloadV3": { "example": { "literal": "SEV123" }, "properties": { "literal": { "description": "If set, this is the literal value of the step parameter", "example": "SEV123", "type": "string" } }, "type": "object" }, "CatalogEntryEngineParamBindingV2": { "example": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } }, "properties": { "array_value": { "description": "If array_value is set, this helps render the values", "example": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "items": { "$ref": "#/components/schemas/CatalogEntryEngineParamBindingValueV2" }, "type": "array" }, "value": { "$ref": "#/components/schemas/CatalogEntryEngineParamBindingValueV2" } }, "type": "object" }, "CatalogEntryEngineParamBindingV3": { "example": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123" } }, "properties": { "array_value": { "description": "If the attribute is multi-valued, the value will be returned here.", "example": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "items": { "$ref": "#/components/schemas/CatalogEntryEngineParamBindingValueV3" }, "type": "array" }, "value": { "$ref": "#/components/schemas/CatalogEntryEngineParamBindingValueV3" } }, "type": "object" }, "CatalogEntryEngineParamBindingValueV2": { "example": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" }, "properties": { "catalog_entry": { "$ref": "#/components/schemas/CatalogEntryReferenceV2" }, "helptext": { "description": "This field is deprecated. It will not be present in any responses, and will be removed in a future version", "example": "abc123", "type": "string" }, "image_url": { "description": "This field is deprecated. It will not be present in any responses, and will be removed in a future version", "example": "abc123", "type": "string" }, "is_image_slack_icon": { "description": "This field is deprecated. It will not be present in any responses, and will be removed in a future version", "example": false, "type": "boolean" }, "label": { "description": "Human readable label to be displayed for user to select", "example": "Lawrence Jones", "type": "string" }, "literal": { "description": "If set, this is the literal value of the step parameter", "example": "SEV123", "type": "string" }, "reference": { "description": "This field is deprecated. It will not be present in any responses, and will be removed in a future version", "example": "incident.severity", "type": "string" }, "sort_key": { "description": "This field is deprecated. It will not be present in any responses, and will be removed in a future version", "example": "abc123", "type": "string" }, "unavailable": { "description": "This field is deprecated. It will not be present in any responses, and will be removed in a future version", "example": false, "type": "boolean" }, "value": { "description": "This field is deprecated. It will not be present in any responses, and will be removed in a future version", "example": "abc123", "type": "string" } }, "required": [ "label", "sort_key" ], "type": "object" }, "CatalogEntryEngineParamBindingValueV3": { "example": { "label": "Lawrence Jones", "literal": "SEV123" }, "properties": { "label": { "description": "A label for this attribute value. If the attribute refers to another Catalog entry, this will be the name of that entry.", "example": "Lawrence Jones", "type": "string" }, "literal": { "description": "The underlying value of the attribute, serialized as a string.\n\nFor String, Text, Number, and Bool typed attributes, this will be empty. For attributes that refer to another catalog entry, this can be the ID, external ID, or one of the aliases of that catalog entry.", "example": "SEV123", "type": "string" } }, "required": [ "label" ], "type": "object" }, "CatalogEntryReferenceV2": { "example": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "archived_at": { "description": "When this entry was archived", "example": "2021-08-17T14:28:57.801578Z", "format": "date-time", "type": "string" }, "catalog_entry_id": { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "catalog_entry_name": { "description": "The name of this entry", "example": "Primary escalation", "type": "string" }, "catalog_type_id": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "catalog_type_id", "catalog_entry_id", "catalog_entry_name" ], "type": "object" }, "CatalogEntrySlimV3V3": { "example": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "properties": { "id": { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Name is the human readable name of this entry", "example": "Primary On-call", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "CatalogEntryV2": { "example": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "aliases": { "description": "Optional aliases that can be used to reference this entry", "example": [ "lawrence@incident.io", "lawrence" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "archived_at": { "description": "When this entry was archived", "example": "2021-08-17T14:28:57.801578Z", "format": "date-time", "type": "string" }, "attribute_values": { "additionalProperties": { "$ref": "#/components/schemas/CatalogEntryEngineParamBindingV2" }, "description": "Values of this entry", "example": { "abc123": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } } }, "type": "object" }, "catalog_type_id": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "created_at": { "description": "When this entry was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "external_id": { "description": "An optional alternative ID for this entry, which is ensured to be unique for the type", "example": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "type": "string" }, "id": { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Name is the human readable name of this entry", "example": "Primary On-call", "type": "string" }, "rank": { "description": "When catalog type is ranked, this is used to help order things", "example": 3, "format": "int32", "type": "integer" }, "updated_at": { "description": "When this entry was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "catalog_type_id", "name", "aliases", "rank", "attribute_values", "created_at", "updated_at" ], "type": "object" }, "CatalogEntryV3": { "example": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "aliases": { "description": "Optional aliases that can be used to reference this entry", "example": [ "lawrence@incident.io", "lawrence" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "archived_at": { "description": "When this entry was archived", "example": "2021-08-17T14:28:57.801578Z", "format": "date-time", "type": "string" }, "attribute_values": { "additionalProperties": { "$ref": "#/components/schemas/CatalogEntryEngineParamBindingV3" }, "description": "Values of this entry", "example": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123" } } }, "type": "object" }, "catalog_type_id": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "created_at": { "description": "When this entry was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "external_id": { "description": "An optional alternative ID for this entry, which is ensured to be unique for the type", "example": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "type": "string" }, "id": { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Name is the human readable name of this entry", "example": "Primary On-call", "type": "string" }, "rank": { "description": "When catalog type is ranked, this is used to help order things", "example": 3, "format": "int32", "type": "integer" }, "updated_at": { "description": "When this entry was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "catalog_type_id", "name", "aliases", "rank", "attribute_values", "created_at", "updated_at" ], "type": "object" }, "CatalogListEntriesResultV2": { "example": { "catalog_entries": [ { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" } ], "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" }, "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "catalog_entries": { "example": [ { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/CatalogEntryV2" }, "type": "array" }, "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV2" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" } }, "required": [ "catalog_type", "catalog_entries", "pagination_meta" ], "type": "object" }, "CatalogListEntriesResultV3": { "example": { "catalog_entries": [ { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" } ], "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true }, "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 } }, "properties": { "catalog_entries": { "example": [ { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/CatalogEntryV3" }, "type": "array" }, "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV3" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultWithTotalV3" } }, "required": [ "catalog_type", "catalog_entries", "pagination_meta" ], "type": "object" }, "CatalogListResourcesResultV2": { "example": { "resources": [ { "category": "custom", "description": "Boolean true or false value", "label": "GitHub Repository", "type": "CatalogEntry[\"01GVGYJSD39FRKVDWACK9NDS4E\"]", "value_docstring": "Either the GraphQL node ID of the repository or a string of \u003cowner\u003e/\u003crepo\u003e, e.g. incident-io/website" } ] }, "properties": { "resources": { "example": [ { "category": "custom", "description": "Boolean true or false value", "label": "GitHub Repository", "type": "CatalogEntry[\"01GVGYJSD39FRKVDWACK9NDS4E\"]", "value_docstring": "Either the GraphQL node ID of the repository or a string of \u003cowner\u003e/\u003crepo\u003e, e.g. incident-io/website" } ], "items": { "$ref": "#/components/schemas/CatalogResourceV2" }, "type": "array" } }, "required": [ "resources" ], "type": "object" }, "CatalogListResourcesResultV3": { "example": { "resources": [ { "category": "custom", "description": "Boolean true or false value", "label": "GitHub Repository", "type": "CatalogEntry[\"01GVGYJSD39FRKVDWACK9NDS4E\"]", "value_docstring": "Either the GraphQL node ID of the repository or a string of \u003cowner\u003e/\u003crepo\u003e, e.g. incident-io/website" } ] }, "properties": { "resources": { "example": [ { "category": "custom", "description": "Boolean true or false value", "label": "GitHub Repository", "type": "CatalogEntry[\"01GVGYJSD39FRKVDWACK9NDS4E\"]", "value_docstring": "Either the GraphQL node ID of the repository or a string of \u003cowner\u003e/\u003crepo\u003e, e.g. incident-io/website" } ], "items": { "$ref": "#/components/schemas/CatalogResourceV3" }, "type": "array" } }, "required": [ "resources" ], "type": "object" }, "CatalogListTypesResultV2": { "example": { "catalog_types": [ { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "catalog_types": { "example": [ { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/CatalogTypeV2" }, "type": "array" } }, "required": [ "catalog_types" ], "type": "object" }, "CatalogListTypesResultV3": { "example": { "catalog_types": [ { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } ] }, "properties": { "catalog_types": { "example": [ { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } ], "items": { "$ref": "#/components/schemas/CatalogTypeV3" }, "type": "array" } }, "required": [ "catalog_types" ], "type": "object" }, "CatalogResourceV2": { "example": { "category": "custom", "description": "Boolean true or false value", "label": "GitHub Repository", "type": "CatalogEntry[\"01GVGYJSD39FRKVDWACK9NDS4E\"]", "value_docstring": "Either the GraphQL node ID of the repository or a string of \u003cowner\u003e/\u003crepo\u003e, e.g. incident-io/website" }, "properties": { "category": { "description": "Which category of resource", "enum": [ "primitive", "custom", "external" ], "example": "custom", "type": "string" }, "description": { "description": "Human readable description for this resource", "example": "Boolean true or false value", "type": "string" }, "label": { "description": "Label for this catalog resource type", "example": "GitHub Repository", "type": "string" }, "type": { "description": "Catalog type name for this resource", "example": "CatalogEntry[\"01GVGYJSD39FRKVDWACK9NDS4E\"]", "type": "string" }, "value_docstring": { "description": "Documentation for the literal string value of this resource", "example": "Either the GraphQL node ID of the repository or a string of \u003cowner\u003e/\u003crepo\u003e, e.g. incident-io/website", "type": "string" } }, "required": [ "type", "label", "description", "value_docstring", "category" ], "type": "object" }, "CatalogResourceV3": { "example": { "category": "custom", "description": "Boolean true or false value", "label": "GitHub Repository", "type": "CatalogEntry[\"01GVGYJSD39FRKVDWACK9NDS4E\"]", "value_docstring": "Either the GraphQL node ID of the repository or a string of \u003cowner\u003e/\u003crepo\u003e, e.g. incident-io/website" }, "properties": { "category": { "description": "Which category of resource", "enum": [ "primitive", "custom", "external" ], "example": "custom", "type": "string" }, "description": { "description": "Human readable description for this resource", "example": "Boolean true or false value", "type": "string" }, "label": { "description": "Label for this catalog resource type", "example": "GitHub Repository", "type": "string" }, "type": { "description": "Catalog type name for this resource", "example": "CatalogEntry[\"01GVGYJSD39FRKVDWACK9NDS4E\"]", "type": "string" }, "value_docstring": { "description": "Documentation for the literal string value of this resource", "example": "Either the GraphQL node ID of the repository or a string of \u003cowner\u003e/\u003crepo\u003e, e.g. incident-io/website", "type": "string" } }, "required": [ "type", "label", "description", "value_docstring", "category" ], "type": "object" }, "CatalogShowEntryResultV2": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" }, "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "catalog_entry": { "$ref": "#/components/schemas/CatalogEntryV2" }, "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV2" } }, "required": [ "catalog_type", "catalog_entry" ], "type": "object" }, "CatalogShowEntryResultV3": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" }, "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "properties": { "catalog_entry": { "$ref": "#/components/schemas/CatalogEntryV3" }, "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV3" } }, "required": [ "catalog_type", "catalog_entry" ], "type": "object" }, "CatalogShowTypeResultV2": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV2" } }, "required": [ "catalog_type" ], "type": "object" }, "CatalogShowTypeResultV3": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "properties": { "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV3" } }, "required": [ "catalog_type" ], "type": "object" }, "CatalogTypeAttributePathItemPayloadV2": { "example": { "attribute_id": "abc123" }, "properties": { "attribute_id": { "description": "the ID of the attribute to use", "example": "abc123", "type": "string" } }, "required": [ "attribute_id" ], "type": "object" }, "CatalogTypeAttributePathItemPayloadV3": { "example": { "attribute_id": "abc123" }, "properties": { "attribute_id": { "description": "the ID of the attribute to use", "example": "abc123", "type": "string" } }, "required": [ "attribute_id" ], "type": "object" }, "CatalogTypeAttributePathItemV2": { "example": { "attribute_id": "abc123", "attribute_name": "abc123" }, "properties": { "attribute_id": { "description": "the ID of the attribute to use", "example": "abc123", "type": "string" }, "attribute_name": { "description": "the name of the attribute to use", "example": "abc123", "type": "string" } }, "required": [ "attribute_id", "attribute_name" ], "type": "object" }, "CatalogTypeAttributePathItemV3": { "example": { "attribute_id": "abc123", "attribute_name": "abc123" }, "properties": { "attribute_id": { "description": "the ID of the attribute to use", "example": "abc123", "type": "string" }, "attribute_name": { "description": "the name of the attribute to use", "example": "abc123", "type": "string" } }, "required": [ "attribute_id", "attribute_name" ], "type": "object" }, "CatalogTypeAttributePayloadV2": { "example": { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123" } ], "type": "Custom[\"Service\"]" }, "properties": { "array": { "description": "Whether this attribute is an array", "example": false, "type": "boolean" }, "backlink_attribute": { "description": "The attribute to use (if this is a backlink)", "example": "abc123", "type": "string" }, "id": { "description": "The ID of this attribute", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "mode": { "description": "Controls how this attribute is modified", "enum": [ "", "manual", "external", "internal", "dynamic", "backlink", "path" ], "example": "", "type": "string", "x-public-api-version": "v2" }, "name": { "description": "Unique name of this attribute", "example": "tier", "type": "string" }, "path": { "description": "The path to use (if this is an path)", "example": [ { "attribute_id": "abc123" } ], "items": { "$ref": "#/components/schemas/CatalogTypeAttributePathItemPayloadV2" }, "type": "array" }, "type": { "description": "Catalog type name for this attribute", "example": "Custom[\"Service\"]", "type": "string" } }, "required": [ "name", "type", "array" ], "type": "object" }, "CatalogTypeAttributePayloadV3": { "example": { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123" } ], "type": "Custom[\"Service\"]" }, "properties": { "array": { "description": "Whether this attribute is an array", "example": false, "type": "boolean" }, "backlink_attribute": { "description": "The attribute to use (if this is a backlink)", "example": "abc123", "type": "string" }, "id": { "description": "The ID of this attribute", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "mode": { "description": "Controls how this attribute is modified", "enum": [ "", "api", "dashboard", "external", "internal", "dynamic", "backlink", "path" ], "example": "", "type": "string", "x-public-api-version": "v3" }, "name": { "description": "Unique name of this attribute", "example": "tier", "type": "string" }, "path": { "description": "The path to use (if this is an path)", "example": [ { "attribute_id": "abc123" } ], "items": { "$ref": "#/components/schemas/CatalogTypeAttributePathItemPayloadV3" }, "type": "array" }, "type": { "description": "Catalog type name for this attribute", "example": "Custom[\"Service\"]", "type": "string" } }, "required": [ "name", "type", "array" ], "type": "object" }, "CatalogTypeAttributeV2": { "example": { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" }, "properties": { "array": { "description": "Whether this attribute is an array", "example": false, "type": "boolean" }, "backlink_attribute": { "description": "The attribute to use (if this is a backlink)", "example": "abc123", "type": "string" }, "id": { "description": "The ID of this attribute", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "mode": { "description": "Controls how this attribute is modified", "enum": [ "", "manual", "external", "internal", "dynamic", "backlink", "path" ], "example": "", "type": "string", "x-public-api-version": "v2" }, "name": { "description": "Unique name of this attribute", "example": "tier", "type": "string" }, "path": { "description": "The path to use (if this is a path attribute)", "example": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "items": { "$ref": "#/components/schemas/CatalogTypeAttributePathItemV2" }, "type": "array" }, "type": { "description": "Catalog type name for this attribute", "example": "Custom[\"Service\"]", "type": "string" } }, "required": [ "id", "mode", "name", "type", "array" ], "type": "object" }, "CatalogTypeAttributeV3": { "example": { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" }, "properties": { "array": { "description": "Whether this attribute is an array", "example": false, "type": "boolean" }, "backlink_attribute": { "description": "The attribute to use (if this is a backlink)", "example": "abc123", "type": "string" }, "id": { "description": "The ID of this attribute", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "mode": { "description": "Controls how this attribute is modified", "enum": [ "", "api", "dashboard", "external", "internal", "dynamic", "backlink", "path" ], "example": "", "type": "string", "x-public-api-version": "v3" }, "name": { "description": "Unique name of this attribute", "example": "tier", "type": "string" }, "path": { "description": "The path to use (if this is a path attribute)", "example": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "items": { "$ref": "#/components/schemas/CatalogTypeAttributePathItemV3" }, "type": "array" }, "type": { "description": "Catalog type name for this attribute", "example": "Custom[\"Service\"]", "type": "string" } }, "required": [ "id", "mode", "name", "type", "array" ], "type": "object" }, "CatalogTypeSchemaV2": { "example": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "properties": { "attributes": { "description": "Attributes of this catalog type", "example": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "items": { "$ref": "#/components/schemas/CatalogTypeAttributeV2" }, "type": "array" }, "version": { "description": "The version number of this schema", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "attributes", "version" ], "type": "object" }, "CatalogTypeSchemaV3": { "example": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "properties": { "attributes": { "description": "Attributes of this catalog type", "example": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "items": { "$ref": "#/components/schemas/CatalogTypeAttributeV3" }, "type": "array" }, "version": { "description": "The version number of this schema", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "attributes", "version" ], "type": "object" }, "CatalogTypeV2": { "example": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "custom", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that can track metadata about this type", "example": { "incident.io/catalog-importer/id": "id-of-config" }, "type": "object" }, "categories": { "description": "What categories is this type considered part of", "example": [ "customer" ], "items": { "enum": [ "customer", "issue-tracker", "product-feature", "service", "on-call", "team", "user" ], "example": "customer", "type": "string", "x-public-api-version": "v2" }, "type": "array" }, "color": { "description": "Sets the display color of this type in the dashboard", "enum": [ "yellow", "green", "blue", "violet", "pink", "cyan", "orange" ], "example": "yellow", "type": "string" }, "created_at": { "description": "When this type was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "Human readble description of this type", "example": "Represents Kubernetes clusters that we run inside of GKE.", "type": "string" }, "dynamic_resource_parameter": { "description": "If this is a dynamic catalog type, this will be the unique parameter for identitfying this resource externally.", "example": "abc123", "type": "string" }, "estimated_count": { "description": "If populated, gives an estimated count of entries for this type", "example": 7, "format": "int64", "type": "integer" }, "icon": { "description": "Sets the display icon of this type in the dashboard", "enum": [ "alert", "bolt", "box", "briefcase", "browser", "bulb", "calendar", "clock", "cog", "components", "database", "doc", "email", "escalation-path", "files", "flag", "folder", "globe", "money", "server", "severity", "status-page", "store", "star", "tag", "user", "users" ], "example": "alert", "type": "string" }, "id": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "is_editable": { "description": "Catalog types that are synced with external resources can't be edited", "example": false, "type": "boolean" }, "last_synced_at": { "description": "When this type was last synced (if it's ever been sync'd)", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "name": { "description": "Name is the human readable name of this type", "example": "Kubernetes Cluster", "type": "string" }, "ranked": { "description": "If this type should be ranked", "example": true, "type": "boolean" }, "registry_type": { "description": "The registry resource this type is synced from, if any", "example": "PagerDutyService", "type": "string" }, "required_integrations": { "description": "If populated, the integrations required for this type", "example": [ "pager_duty" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "schema": { "$ref": "#/components/schemas/CatalogTypeSchemaV2" }, "semantic_type": { "description": "This type has been deprecated, and will always be empty.", "example": "abc123", "type": "string", "x-public-api-version": "v2" }, "source_repo_url": { "description": "The url of the external repository where this type is managed", "example": "https://github.com/my-company/incident-io-catalog", "type": "string" }, "type_name": { "description": "The type name of this catalog type, to be used when defining attributes. This is immutable once a CatalogType has been created. For non-externally sync types, it must follow the pattern Custom[\"SomeName\"]", "example": "Custom[\"BackstageGroup\"]", "type": "string" }, "updated_at": { "description": "When this type was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "description", "type_name", "semantic_type", "ranked", "schema", "icon", "categories", "color", "is_editable", "annotations", "created_at", "updated_at" ], "type": "object" }, "CatalogTypeV3": { "example": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that can track metadata about this type", "example": { "incident.io/catalog-importer/id": "id-of-config" }, "type": "object" }, "categories": { "description": "What categories is this type considered part of", "example": [ "customer" ], "items": { "enum": [ "customer", "issue-tracker", "product-feature", "service", "on-call", "team", "user" ], "example": "customer", "type": "string", "x-public-api-version": "v3" }, "type": "array" }, "color": { "description": "Sets the display color of this type in the dashboard", "enum": [ "yellow", "green", "blue", "violet", "pink", "cyan", "orange" ], "example": "yellow", "type": "string" }, "created_at": { "description": "When this type was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "Human readble description of this type", "example": "Represents Kubernetes clusters that we run inside of GKE.", "type": "string" }, "dynamic_resource_parameter": { "description": "If this is a dynamic catalog type, this will be the unique parameter for identitfying this resource externally.", "example": "abc123", "type": "string" }, "estimated_count": { "description": "If populated, gives an estimated count of entries for this type", "example": 7, "format": "int64", "type": "integer" }, "icon": { "description": "Sets the display icon of this type in the dashboard", "enum": [ "alert", "bolt", "box", "briefcase", "browser", "bulb", "calendar", "clock", "cog", "components", "database", "doc", "email", "escalation-path", "files", "flag", "folder", "globe", "money", "server", "severity", "status-page", "store", "star", "tag", "user", "users" ], "example": "alert", "type": "string" }, "id": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "is_editable": { "description": "Catalog types that are synced with external resources can't be edited", "example": false, "type": "boolean" }, "is_team_type": { "description": "Whether this catalog type is the designated team type in team settings", "example": false, "type": "boolean" }, "last_synced_at": { "description": "When this type was last synced (if it's ever been sync'd)", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "name": { "description": "Name is the human readable name of this type", "example": "Kubernetes Cluster", "type": "string" }, "ranked": { "description": "If this type should be ranked", "example": true, "type": "boolean" }, "registry_type": { "description": "The registry resource this type is synced from, if any", "example": "PagerDutyService", "type": "string" }, "required_integrations": { "description": "If populated, the integrations required for this type", "example": [ "pager_duty" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "schema": { "$ref": "#/components/schemas/CatalogTypeSchemaV3" }, "source_repo_url": { "description": "The url of the external repository where this type is managed", "example": "https://github.com/my-company/incident-io-catalog", "type": "string" }, "type_name": { "description": "The type name of this catalog type, to be used when defining attributes. This is immutable once a CatalogType has been created. For non-externally sync types, it must follow the pattern Custom[\"SomeName\"]", "example": "Custom[\"BackstageGroup\"]", "type": "string" }, "updated_at": { "description": "When this type was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "use_name_as_identifier": { "description": "If enabled, you can refer to entries of this type by their name, as well as their external ID and any aliases.", "example": true, "type": "boolean" } }, "required": [ "id", "name", "description", "type_name", "ranked", "schema", "icon", "categories", "color", "is_editable", "annotations", "created_at", "updated_at", "use_name_as_identifier" ], "type": "object" }, "CatalogUpdateEntryPayloadV2": { "example": { "aliases": [ "lawrence@incident.io", "lawrence" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "name": "Primary On-call", "rank": 3 }, "properties": { "aliases": { "description": "Optional aliases that can be used to reference this entry", "example": [ "lawrence@incident.io", "lawrence" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "attribute_values": { "additionalProperties": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "description": "Values of this entry", "example": { "abc123": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "type": "object" }, "external_id": { "description": "An optional alternative ID for this entry, which is ensured to be unique for the type", "example": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "type": "string" }, "name": { "description": "Name is the human readable name of this entry", "example": "Primary On-call", "type": "string" }, "rank": { "description": "When catalog type is ranked, this is used to help order things", "example": 3, "format": "int32", "type": "integer" } }, "required": [ "name", "attribute_values" ], "type": "object" }, "CatalogUpdateEntryPayloadV3": { "example": { "aliases": [ "lawrence@incident.io", "lawrence" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "name": "Primary On-call", "rank": 3, "update_attributes": [ "abc123" ] }, "properties": { "aliases": { "description": "Optional aliases that can be used to reference this entry", "example": [ "lawrence@incident.io", "lawrence" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "attribute_values": { "additionalProperties": { "$ref": "#/components/schemas/CatalogEngineParamBindingPayloadV3" }, "description": "Values of this entry", "example": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "type": "object" }, "external_id": { "description": "An optional alternative ID for this entry, which is ensured to be unique for the type", "example": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "type": "string" }, "name": { "description": "Name is the human readable name of this entry", "example": "Primary On-call", "type": "string" }, "rank": { "description": "When catalog type is ranked, this is used to help order things", "example": 3, "format": "int32", "type": "integer" }, "update_attributes": { "description": "If provided, only update these attribute_values keys. If not provided, update all attribute values.\nIf you specify an attribute key that's not in your payload, the associated attribute value will be cleared.", "example": [ "abc123" ], "items": { "example": "abc123", "type": "string" }, "type": "array" } }, "required": [ "name", "attribute_values" ], "type": "object" }, "CatalogUpdateEntryResultV2": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" }, "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "catalog_entry": { "$ref": "#/components/schemas/CatalogEntryV2" }, "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV2" } }, "required": [ "catalog_type", "catalog_entry" ], "type": "object" }, "CatalogUpdateEntryResultV3": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" }, "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "properties": { "catalog_entry": { "$ref": "#/components/schemas/CatalogEntryV3" }, "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV3" } }, "required": [ "catalog_type", "catalog_entry" ], "type": "object" }, "CatalogUpdateTypePayloadV2": { "example": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "description": "Represents Kubernetes clusters that we run inside of GKE.", "icon": "alert", "name": "Kubernetes Cluster", "ranked": true, "source_repo_url": "https://github.com/my-company/incident-io-catalog" }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that can track metadata about this type", "example": { "incident.io/catalog-importer/id": "id-of-config" }, "type": "object" }, "categories": { "description": "What categories is this type considered part of", "example": [ "customer" ], "items": { "enum": [ "customer", "issue-tracker", "product-feature", "service", "on-call", "team", "user" ], "example": "customer", "type": "string" }, "type": "array" }, "color": { "description": "Sets the display color of this type in the dashboard", "enum": [ "yellow", "green", "blue", "violet", "pink", "cyan", "orange" ], "example": "yellow", "type": "string" }, "description": { "description": "Human readble description of this type", "example": "Represents Kubernetes clusters that we run inside of GKE.", "type": "string" }, "icon": { "description": "Sets the display icon of this type in the dashboard", "enum": [ "alert", "bolt", "box", "briefcase", "browser", "bulb", "calendar", "clock", "cog", "components", "database", "doc", "email", "escalation-path", "files", "flag", "folder", "globe", "money", "server", "severity", "status-page", "store", "star", "tag", "user", "users" ], "example": "alert", "type": "string" }, "name": { "description": "Name is the human readable name of this type", "example": "Kubernetes Cluster", "type": "string" }, "ranked": { "description": "If this type should be ranked", "example": true, "type": "boolean" }, "source_repo_url": { "description": "The url of the external repository where this type is managed", "example": "https://github.com/my-company/incident-io-catalog", "type": "string" } }, "required": [ "name", "description" ], "type": "object" }, "CatalogUpdateTypePayloadV3": { "example": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "description": "Represents Kubernetes clusters that we run inside of GKE.", "icon": "alert", "name": "Kubernetes Cluster", "ranked": true, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "use_name_as_identifier": true }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that can track metadata about this type", "example": { "incident.io/catalog-importer/id": "id-of-config" }, "type": "object" }, "categories": { "description": "What categories is this type considered part of", "example": [ "customer" ], "items": { "enum": [ "customer", "issue-tracker", "product-feature", "service", "on-call", "team", "user" ], "example": "customer", "type": "string" }, "type": "array" }, "color": { "description": "Sets the display color of this type in the dashboard", "enum": [ "yellow", "green", "blue", "violet", "pink", "cyan", "orange" ], "example": "yellow", "type": "string" }, "description": { "description": "Human readble description of this type", "example": "Represents Kubernetes clusters that we run inside of GKE.", "type": "string" }, "icon": { "description": "Sets the display icon of this type in the dashboard", "enum": [ "alert", "bolt", "box", "briefcase", "browser", "bulb", "calendar", "clock", "cog", "components", "database", "doc", "email", "escalation-path", "files", "flag", "folder", "globe", "money", "server", "severity", "status-page", "store", "star", "tag", "user", "users" ], "example": "alert", "type": "string" }, "name": { "description": "Name is the human readable name of this type", "example": "Kubernetes Cluster", "type": "string" }, "ranked": { "description": "If this type should be ranked", "example": true, "type": "boolean" }, "source_repo_url": { "description": "The url of the external repository where this type is managed", "example": "https://github.com/my-company/incident-io-catalog", "type": "string" }, "use_name_as_identifier": { "description": "If enabled, you can refer to entries of this type by their name, as well as their external ID and any aliases.", "example": true, "type": "boolean" } }, "required": [ "name", "description" ], "type": "object" }, "CatalogUpdateTypeResultV2": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV2" } }, "required": [ "catalog_type" ], "type": "object" }, "CatalogUpdateTypeResultV3": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "properties": { "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV3" } }, "required": [ "catalog_type" ], "type": "object" }, "CatalogUpdateTypeSchemaPayloadV2": { "example": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "properties": { "attributes": { "example": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123" } ], "type": "Custom[\"Service\"]" } ], "items": { "$ref": "#/components/schemas/CatalogTypeAttributePayloadV2" }, "type": "array" }, "version": { "example": 1, "format": "int64", "type": "integer" } }, "required": [ "attributes", "version" ], "type": "object" }, "CatalogUpdateTypeSchemaPayloadV3": { "example": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "properties": { "attributes": { "example": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123" } ], "type": "Custom[\"Service\"]" } ], "items": { "$ref": "#/components/schemas/CatalogTypeAttributePayloadV3" }, "type": "array" }, "version": { "example": 1, "format": "int64", "type": "integer" } }, "required": [ "attributes", "version" ], "type": "object" }, "CatalogUpdateTypeSchemaResultV2": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV2" } }, "required": [ "catalog_type" ], "type": "object" }, "CatalogUpdateTypeSchemaResultV3": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "properties": { "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV3" } }, "required": [ "catalog_type" ], "type": "object" }, "ChatChannelSlimV2": { "example": { "microsoft_teams_channel_id": "abc123", "microsoft_teams_team_id": "abc123", "slack_channel_id": "abc123", "slack_team_id": "abc123" }, "properties": { "microsoft_teams_channel_id": { "description": "ID of the Microsoft Teams channel, if there is one", "example": "abc123", "type": "string" }, "microsoft_teams_team_id": { "description": "ID of the Microsoft Teams team, if there is one", "example": "abc123", "type": "string" }, "slack_channel_id": { "description": "ID of the Slack channel, if there is one", "example": "abc123", "type": "string" }, "slack_team_id": { "description": "ID of the Slack team, if there is one", "example": "abc123", "type": "string" } }, "type": "object" }, "ConditionGroupPayloadV2": { "example": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] }, "properties": { "conditions": { "description": "All conditions in this list must be satisfied for the group to be satisfied", "example": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "items": { "$ref": "#/components/schemas/ConditionPayloadV2" }, "type": "array" } }, "required": [ "conditions" ], "type": "object" }, "ConditionGroupV2": { "example": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] }, "properties": { "conditions": { "description": "All conditions in this list must be satisfied for the group to be satisfied", "example": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "items": { "$ref": "#/components/schemas/ConditionV2" }, "type": "array" } }, "required": [ "conditions" ], "type": "object" }, "ConditionOperationV2": { "example": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "properties": { "label": { "description": "Human readable label to be displayed for user to select", "example": "Lawrence Jones", "type": "string" }, "value": { "description": "Unique identifier for this option", "example": "01FCQSP07Z74QMMYPDDGQB9FTG", "type": "string" } }, "required": [ "label", "value" ], "type": "object" }, "ConditionPayloadV2": { "example": { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" }, "properties": { "operation": { "description": "The name of the operation on the subject", "example": "one_of", "type": "string" }, "param_bindings": { "description": "List of parameter bindings", "example": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "items": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "type": "array" }, "subject": { "description": "The reference of the subject in the trigger scope", "example": "incident.severity", "type": "string" } }, "required": [ "subject", "operation", "param_bindings" ], "type": "object" }, "ConditionSubjectV2": { "example": { "label": "Incident Severity", "reference": "incident.severity" }, "properties": { "label": { "description": "Human readable identifier for the subject", "example": "Incident Severity", "type": "string" }, "reference": { "description": "Reference into the scope for the value of the subject", "example": "incident.severity", "type": "string" } }, "required": [ "label", "reference" ], "type": "object" }, "ConditionV2": { "example": { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } }, "properties": { "operation": { "$ref": "#/components/schemas/ConditionOperationV2" }, "param_bindings": { "description": "Bindings for the operation parameters", "example": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "items": { "$ref": "#/components/schemas/EngineParamBindingV2" }, "type": "array" }, "subject": { "$ref": "#/components/schemas/ConditionSubjectV2" } }, "required": [ "subject", "operation", "param_bindings" ], "type": "object" }, "CustomFieldEntryPayloadV1": { "example": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] }, "properties": { "custom_field_id": { "description": "ID of the custom field this entry is linked against", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "values": { "description": "List of values to associate with this entry. Use an empty array to unset the value of the custom field.", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ], "items": { "$ref": "#/components/schemas/CustomFieldValuePayloadV1" }, "type": "array" } }, "required": [ "custom_field_id", "values" ], "type": "object" }, "CustomFieldEntryPayloadV2": { "example": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] }, "properties": { "custom_field_id": { "description": "ID of the custom field this entry is linked against", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "values": { "description": "List of values to associate with this entry. Use an empty array to unset the value of the custom field.", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ], "items": { "$ref": "#/components/schemas/CustomFieldValuePayloadV2" }, "type": "array" } }, "required": [ "custom_field_id", "values" ], "type": "object" }, "CustomFieldEntryV1": { "example": { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] }, "properties": { "custom_field": { "$ref": "#/components/schemas/CustomFieldTypeInfoV1" }, "values": { "description": "List of custom field values set on this entry", "example": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ], "items": { "$ref": "#/components/schemas/CustomFieldValueV1" }, "type": "array" } }, "required": [ "custom_field", "values" ], "type": "object" }, "CustomFieldEntryV2": { "example": { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] }, "properties": { "custom_field": { "$ref": "#/components/schemas/CustomFieldTypeInfoV2" }, "values": { "description": "List of custom field values set on this entry", "example": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ], "items": { "$ref": "#/components/schemas/CustomFieldValueV2" }, "type": "array" } }, "required": [ "custom_field", "values" ], "type": "object" }, "CustomFieldFilterByOptionsV2": { "example": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "properties": { "catalog_attribute_id": { "description": "This must be an attribute of the catalog type of this custom field. It must be an attribute that points to another catalog type (so not a plain string, number, or boolean attribute).", "example": "01H2FW182TAH0NHEVBY34SCAK0", "type": "string" }, "custom_field_id": { "description": "This must be the ID of a custom field, which must have values of the same type as the attribute you are filtering by.\n\nWhen this filtering field is set on an incident, the options for this custom field will be filtered to only those with the attribute value that matches the value of the filtering field.", "example": "01H2FW182TAH0NHEVBY34SCAK0", "type": "string" } }, "required": [ "custom_field_id", "catalog_attribute_id" ], "type": "object" }, "CustomFieldOptionV1": { "example": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "properties": { "custom_field_id": { "description": "ID of the custom field this option belongs to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "id": { "description": "Unique identifier for the custom field option", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "sort_key": { "default": 1000, "description": "Sort key used to order the custom field options correctly", "example": 10, "format": "int64", "type": "integer" }, "value": { "description": "Human readable name for the custom field option. Values must not start or end with whitespace, or contain tabs or newlines.", "example": "Product", "type": "string" } }, "required": [ "id", "custom_field_id", "value", "sort_key" ], "type": "object" }, "CustomFieldOptionV2": { "example": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "properties": { "custom_field_id": { "description": "ID of the custom field this option belongs to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "id": { "description": "Unique identifier for the custom field option", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "sort_key": { "default": 1000, "description": "Sort key used to order the custom field options correctly", "example": 10, "format": "int64", "type": "integer" }, "value": { "description": "Human readable name for the custom field option. Values must not start or end with whitespace, or contain tabs or newlines.", "example": "Product", "type": "string" } }, "required": [ "id", "custom_field_id", "value", "sort_key" ], "type": "object" }, "CustomFieldOptionsCreatePayloadV1": { "example": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "properties": { "custom_field_id": { "description": "ID of the custom field this option belongs to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "sort_key": { "default": 1000, "description": "Sort key used to order the custom field options correctly", "example": 10, "format": "int64", "type": "integer" }, "value": { "description": "Human readable name for the custom field option. Values must not start or end with whitespace, or contain tabs or newlines.", "example": "Product", "type": "string" } }, "required": [ "custom_field_id", "value" ], "type": "object" }, "CustomFieldOptionsCreateResultV1": { "example": { "custom_field_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } }, "properties": { "custom_field_option": { "$ref": "#/components/schemas/CustomFieldOptionV1" } }, "required": [ "custom_field_option" ], "type": "object" }, "CustomFieldOptionsListResultV1": { "example": { "custom_field_options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "custom_field_options": { "example": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "items": { "$ref": "#/components/schemas/CustomFieldOptionV1" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV1" } }, "required": [ "custom_field_options", "pagination_meta" ], "type": "object" }, "CustomFieldOptionsShowResultV1": { "example": { "custom_field_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } }, "properties": { "custom_field_option": { "$ref": "#/components/schemas/CustomFieldOptionV1" } }, "required": [ "custom_field_option" ], "type": "object" }, "CustomFieldOptionsUpdatePayloadV1": { "example": { "sort_key": 10, "value": "Product" }, "properties": { "sort_key": { "default": 1000, "description": "Sort key used to order the custom field options correctly", "example": 10, "format": "int64", "type": "integer" }, "value": { "description": "Human readable name for the custom field option. Values must not start or end with whitespace, or contain tabs or newlines.", "example": "Product", "type": "string" } }, "required": [ "value", "sort_key" ], "type": "object" }, "CustomFieldOptionsUpdateResultV1": { "example": { "custom_field_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } }, "properties": { "custom_field_option": { "$ref": "#/components/schemas/CustomFieldOptionV1" } }, "required": [ "custom_field_option" ], "type": "object" }, "CustomFieldTypeInfoV1": { "example": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "properties": { "description": { "description": "Description of the custom field", "example": "Which team is impacted by this issue", "type": "string" }, "field_type": { "description": "Type of custom field", "enum": [ "single_select", "multi_select", "text", "link", "numeric" ], "example": "single_select", "type": "string" }, "id": { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Human readable name for the custom field", "example": "Affected Team", "maxLength": 50, "type": "string" }, "options": { "description": "What options are available for this custom field, if this field has options", "example": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "items": { "$ref": "#/components/schemas/CustomFieldOptionV1" }, "type": "array" } }, "required": [ "id", "name", "description", "field_type", "options" ], "type": "object" }, "CustomFieldTypeInfoV2": { "example": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "properties": { "description": { "description": "Description of the custom field", "example": "Which team is impacted by this issue", "type": "string" }, "field_type": { "description": "Type of custom field", "enum": [ "single_select", "multi_select", "text", "link", "numeric" ], "example": "single_select", "type": "string" }, "id": { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Human readable name for the custom field", "example": "Affected Team", "maxLength": 50, "type": "string" }, "options": { "description": "What options are available for this custom field, if this field has options", "example": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "items": { "$ref": "#/components/schemas/CustomFieldOptionV2" }, "type": "array" } }, "required": [ "id", "name", "description", "field_type", "options" ], "type": "object" }, "CustomFieldV1": { "example": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true, "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "catalog_type_id": { "description": "For catalog fields, the ID of the associated catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "created_at": { "description": "When the action was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "Description of the custom field", "example": "Which team is impacted by this issue", "type": "string" }, "field_type": { "description": "Type of custom field", "enum": [ "single_select", "multi_select", "text", "link", "numeric" ], "example": "single_select", "type": "string" }, "id": { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Human readable name for the custom field", "example": "Affected Team", "maxLength": 50, "type": "string" }, "options": { "description": "What options are available for this custom field, if this field has options", "example": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "items": { "$ref": "#/components/schemas/CustomFieldOptionV1" }, "type": "array" }, "required": { "description": "When this custom field must be set during the incident lifecycle. [DEPRECATED: please use required_v2 instead].", "enum": [ "never", "before_closure", "always" ], "example": "never", "type": "string" }, "required_v2": { "description": "When this custom field must be set during the incident lifecycle.", "enum": [ "never", "before_resolution", "always" ], "example": "never", "type": "string" }, "show_before_closure": { "description": "Whether a custom field should be shown in the incident resolve modal. If this custom field is required before resolution, but no value has been set for it, the field will be shown in the resolve modal whatever the value of this setting.", "example": true, "type": "boolean" }, "show_before_creation": { "description": "Whether a custom field should be shown in the incident creation modal. This must be true if the field is always required.", "example": true, "type": "boolean" }, "show_before_update": { "description": "Whether a custom field should be shown in the incident update modal.", "example": true, "type": "boolean" }, "show_in_announcement_post": { "description": "Whether a custom field should be shown in the list of fields as part of the announcement post when set.", "example": true, "type": "boolean" }, "updated_at": { "description": "When the action was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "description", "field_type", "show_before_creation", "show_before_closure", "show_before_update", "options", "created_at", "updated_at" ], "type": "object" }, "CustomFieldV2": { "example": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "catalog_type_id": { "description": "For catalog fields, the ID of the associated catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "created_at": { "description": "When the action was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "Description of the custom field", "example": "Which team is impacted by this issue", "type": "string" }, "field_type": { "description": "Type of custom field", "enum": [ "single_select", "multi_select", "text", "link", "numeric" ], "example": "single_select", "type": "string" }, "filter_by": { "$ref": "#/components/schemas/CustomFieldFilterByOptionsV2" }, "group_by_catalog_attribute_id": { "description": "For catalog fields, the ID of the attribute used to group catalog entries (if applicable)", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "helptext_catalog_attribute_id": { "description": "Which catalog attribute provides helptext for the options", "example": "01H2FW182TAH0NHEVBY34SCAK0", "type": "string" }, "id": { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Human readable name for the custom field", "example": "Affected Team", "maxLength": 50, "type": "string" }, "updated_at": { "description": "When the action was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "description", "field_type", "created_at", "updated_at" ], "type": "object" }, "CustomFieldValuePayloadV1": { "example": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" }, "properties": { "id": { "description": "Unique identifier for the custom field value", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "value_catalog_entry_id": { "description": "ID of the catalog entry. You can also use an ExternalID or an Alias of the catalog entry.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "value_link": { "description": "If the custom field type is 'link', this will contain the value assigned.", "example": "https://google.com/", "type": "string" }, "value_numeric": { "description": "If the custom field type is 'numeric', this will contain the value assigned.", "example": "123.456", "type": "string" }, "value_option_id": { "description": "ID of the custom field option", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "value_text": { "description": "If the custom field type is 'text', this will contain the value assigned.", "example": "This is my text field, I hope you like it", "type": "string" }, "value_timestamp": { "description": "Deprecated: please use incident timestamp values instead", "example": "", "type": "string" } }, "type": "object" }, "CustomFieldValuePayloadV2": { "example": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" }, "properties": { "id": { "description": "Unique identifier for the custom field value", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "value_catalog_entry_id": { "description": "ID of the catalog entry. You can also use an ExternalID or an Alias of the catalog entry.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "value_link": { "description": "If the custom field type is 'link', this will contain the value assigned.", "example": "https://google.com/", "type": "string" }, "value_numeric": { "description": "If the custom field type is 'numeric', this will contain the value assigned.", "example": "123.456", "type": "string" }, "value_option_id": { "description": "ID of the custom field option", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "value_text": { "description": "If the custom field type is 'text', this will contain the value assigned.", "example": "This is my text field, I hope you like it", "type": "string" }, "value_timestamp": { "description": "Deprecated: please use incident timestamp values instead", "example": "", "type": "string" } }, "type": "object" }, "CustomFieldValueV1": { "example": { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" }, "properties": { "value_catalog_entry": { "$ref": "#/components/schemas/EmbeddedCatalogEntryV1" }, "value_link": { "description": "If the custom field type is 'link', this will contain the value assigned.", "example": "https://google.com/", "type": "string" }, "value_numeric": { "description": "If the custom field type is 'numeric', this will contain the value assigned.", "example": "123.456", "type": "string" }, "value_option": { "$ref": "#/components/schemas/CustomFieldOptionV1" }, "value_text": { "description": "If the custom field type is 'text', this will contain the value assigned.", "example": "This is my text field, I hope you like it", "type": "string" } }, "type": "object" }, "CustomFieldValueV2": { "example": { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" }, "properties": { "value_catalog_entry": { "$ref": "#/components/schemas/EmbeddedCatalogEntryV2" }, "value_link": { "description": "If the custom field type is 'link', this will contain the value assigned.", "example": "https://google.com/", "type": "string" }, "value_numeric": { "description": "If the custom field type is 'numeric', this will contain the value assigned.", "example": "123.456", "type": "string" }, "value_option": { "$ref": "#/components/schemas/CustomFieldOptionV2" }, "value_text": { "description": "If the custom field type is 'text', this will contain the value assigned.", "example": "This is my text field, I hope you like it", "type": "string" } }, "type": "object" }, "CustomFieldsCreatePayloadV1": { "example": { "description": "Which team is impacted by this issue", "field_type": "single_select", "name": "Affected Team", "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true }, "properties": { "description": { "description": "Description of the custom field", "example": "Which team is impacted by this issue", "type": "string" }, "field_type": { "description": "Type of custom field", "enum": [ "single_select", "multi_select", "text", "link", "numeric" ], "example": "single_select", "type": "string" }, "name": { "description": "Human readable name for the custom field", "example": "Affected Team", "maxLength": 50, "type": "string" }, "required": { "description": "When this custom field must be set during the incident lifecycle. [DEPRECATED: please use required_v2 instead].", "enum": [ "never", "before_closure", "always" ], "example": "never", "type": "string" }, "required_v2": { "description": "When this custom field must be set during the incident lifecycle.", "enum": [ "never", "before_resolution", "always" ], "example": "never", "type": "string" }, "show_before_closure": { "description": "Whether a custom field should be shown in the incident resolve modal. If this custom field is required before resolution, but no value has been set for it, the field will be shown in the resolve modal whatever the value of this setting.", "example": true, "type": "boolean" }, "show_before_creation": { "description": "Whether a custom field should be shown in the incident creation modal. This must be true if the field is always required.", "example": true, "type": "boolean" }, "show_before_update": { "description": "Whether a custom field should be shown in the incident update modal.", "example": true, "type": "boolean" }, "show_in_announcement_post": { "description": "Whether a custom field should be shown in the list of fields as part of the announcement post when set.", "example": true, "type": "boolean" } }, "required": [ "name", "description", "field_type", "show_before_creation", "show_before_closure", "show_before_update" ], "type": "object" }, "CustomFieldsCreatePayloadV2": { "example": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "description": "Which team is impacted by this issue", "field_type": "single_select", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "name": "Affected Team" }, "properties": { "catalog_type_id": { "description": "For catalog fields, the ID of the associated catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "description": { "description": "Description of the custom field", "example": "Which team is impacted by this issue", "type": "string" }, "field_type": { "description": "Type of custom field", "enum": [ "single_select", "multi_select", "text", "link", "numeric" ], "example": "single_select", "type": "string" }, "filter_by": { "$ref": "#/components/schemas/CustomFieldFilterByOptionsV2" }, "group_by_catalog_attribute_id": { "description": "For catalog fields, the ID of the attribute used to group catalog entries (if applicable)", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "helptext_catalog_attribute_id": { "description": "Which catalog attribute provides helptext for the options", "example": "01H2FW182TAH0NHEVBY34SCAK0", "type": "string" }, "name": { "description": "Human readable name for the custom field", "example": "Affected Team", "maxLength": 50, "type": "string" } }, "required": [ "name", "description", "field_type" ], "type": "object" }, "CustomFieldsCreateResultV1": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "custom_field": { "$ref": "#/components/schemas/CustomFieldV1" } }, "required": [ "custom_field" ], "type": "object" }, "CustomFieldsCreateResultV2": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "custom_field": { "$ref": "#/components/schemas/CustomFieldV2" } }, "required": [ "custom_field" ], "type": "object" }, "CustomFieldsListResultV1": { "example": { "custom_fields": [ { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true, "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "custom_fields": { "example": [ { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true, "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/CustomFieldV1" }, "type": "array" } }, "required": [ "custom_fields" ], "type": "object" }, "CustomFieldsListResultV2": { "example": { "custom_fields": [ { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "custom_fields": { "example": [ { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/CustomFieldV2" }, "type": "array" } }, "required": [ "custom_fields" ], "type": "object" }, "CustomFieldsShowResultV1": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "custom_field": { "$ref": "#/components/schemas/CustomFieldV1" } }, "required": [ "custom_field" ], "type": "object" }, "CustomFieldsShowResultV2": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "custom_field": { "$ref": "#/components/schemas/CustomFieldV2" } }, "required": [ "custom_field" ], "type": "object" }, "CustomFieldsUpdatePayloadV1": { "example": { "description": "Which team is impacted by this issue", "name": "Affected Team", "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true }, "properties": { "description": { "description": "Description of the custom field", "example": "Which team is impacted by this issue", "type": "string" }, "name": { "description": "Human readable name for the custom field", "example": "Affected Team", "maxLength": 50, "type": "string" }, "required": { "description": "When this custom field must be set during the incident lifecycle. [DEPRECATED: please use required_v2 instead].", "enum": [ "never", "before_closure", "always" ], "example": "never", "type": "string" }, "required_v2": { "description": "When this custom field must be set during the incident lifecycle.", "enum": [ "never", "before_resolution", "always" ], "example": "never", "type": "string" }, "show_before_closure": { "description": "Whether a custom field should be shown in the incident resolve modal. If this custom field is required before resolution, but no value has been set for it, the field will be shown in the resolve modal whatever the value of this setting.", "example": true, "type": "boolean" }, "show_before_creation": { "description": "Whether a custom field should be shown in the incident creation modal. This must be true if the field is always required.", "example": true, "type": "boolean" }, "show_before_update": { "description": "Whether a custom field should be shown in the incident update modal.", "example": true, "type": "boolean" }, "show_in_announcement_post": { "description": "Whether a custom field should be shown in the list of fields as part of the announcement post when set.", "example": true, "type": "boolean" } }, "required": [ "name", "description", "show_before_creation", "show_before_closure", "show_before_update" ], "type": "object" }, "CustomFieldsUpdatePayloadV2": { "example": { "description": "Which team is impacted by this issue", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "name": "Affected Team" }, "properties": { "description": { "description": "Description of the custom field", "example": "Which team is impacted by this issue", "type": "string" }, "filter_by": { "$ref": "#/components/schemas/CustomFieldFilterByOptionsV2" }, "group_by_catalog_attribute_id": { "description": "For catalog fields, the ID of the attribute used to group catalog entries (if applicable)", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "helptext_catalog_attribute_id": { "description": "Which catalog attribute provides helptext for the options", "example": "01H2FW182TAH0NHEVBY34SCAK0", "type": "string" }, "name": { "description": "Human readable name for the custom field", "example": "Affected Team", "maxLength": 50, "type": "string" } }, "required": [ "name", "description" ], "type": "object" }, "CustomFieldsUpdateResultV1": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "custom_field": { "$ref": "#/components/schemas/CustomFieldV1" } }, "required": [ "custom_field" ], "type": "object" }, "CustomFieldsUpdateResultV2": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "custom_field": { "$ref": "#/components/schemas/CustomFieldV2" } }, "required": [ "custom_field" ], "type": "object" }, "EmbeddedCatalogEntryV1": { "example": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "properties": { "aliases": { "description": "Optional aliases that can be used to reference this entry", "example": [ "lawrence@incident.io", "lawrence" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "external_id": { "description": "An optional alternative ID for this entry, which is ensured to be unique for the type", "example": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "type": "string" }, "id": { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Name is the human readable name of this entry", "example": "Primary On-call", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "EmbeddedCatalogEntryV2": { "example": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "properties": { "aliases": { "description": "Optional aliases that can be used to reference this entry", "example": [ "lawrence@incident.io", "lawrence" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "external_id": { "description": "An optional alternative ID for this entry, which is ensured to be unique for the type", "example": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "type": "string" }, "id": { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Name is the human readable name of this entry", "example": "Primary On-call", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "EmbeddedIncidentRoleV2": { "example": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "created_at": { "description": "When the role was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "Describes the purpose of the role", "example": "The person currently coordinating the incident", "minLength": 1, "type": "string" }, "id": { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "instructions": { "description": "Provided to whoever is nominated for the role. Note that this will be empty for the 'reporter' role.", "example": "Take point on the incident; Make sure people are clear on responsibilities", "type": "string" }, "name": { "description": "Human readable name of the incident role", "example": "Incident Lead", "minLength": 1, "type": "string" }, "required": { "description": "This field is deprecated.", "example": false, "type": "boolean" }, "role_type": { "description": "Type of incident role", "enum": [ "lead", "reporter", "custom" ], "example": "lead", "type": "string" }, "shortform": { "description": "Short human readable name for Slack. Note that this will be empty for the 'reporter' role.", "example": "lead", "type": "string" }, "updated_at": { "description": "When the role was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "name", "shortform", "description", "instructions", "id", "role_type", "created_at", "updated_at" ], "type": "object" }, "EngineParamBindingPayloadV2": { "example": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "properties": { "array_value": { "description": "If set, this is the array value of the step parameter", "example": [ { "literal": "SEV123", "reference": "incident.severity" } ], "items": { "$ref": "#/components/schemas/EngineParamBindingValuePayloadV2" }, "type": "array" }, "value": { "$ref": "#/components/schemas/EngineParamBindingValuePayloadV2" } }, "type": "object" }, "EngineParamBindingV2": { "example": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "properties": { "array_value": { "description": "If array_value is set, this helps render the values", "example": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "items": { "$ref": "#/components/schemas/EngineParamBindingValueV2" }, "type": "array" }, "value": { "$ref": "#/components/schemas/EngineParamBindingValueV2" } }, "type": "object" }, "EngineParamBindingValuePayloadV2": { "example": { "literal": "SEV123", "reference": "incident.severity" }, "properties": { "literal": { "description": "If set, this is the literal value of the step parameter", "example": "SEV123", "type": "string" }, "reference": { "description": "If set, this is the reference into the trigger scope that is the value of this parameter", "example": "incident.severity", "type": "string" } }, "type": "object" }, "EngineParamBindingValueV2": { "example": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "properties": { "label": { "description": "Human readable label to be displayed for user to select", "example": "Lawrence Jones", "type": "string" }, "literal": { "description": "If set, this is the literal value of the step parameter", "example": "SEV123", "type": "string" }, "reference": { "description": "If set, this is the reference into the trigger scope that is the value of this parameter", "example": "incident.severity", "type": "string" } }, "required": [ "label" ], "type": "object" }, "EngineReferenceV2": { "example": { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -\u003e Affected Team", "type": "IncidentSeverity" }, "properties": { "array": { "description": "If true, the reference can refer to 0 to many items", "example": false, "type": "boolean" }, "key": { "description": "Unique identifier of field will set", "example": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "type": "string" }, "label": { "description": "Human readable label for the field (with context)", "example": "Incident -\u003e Affected Team", "type": "string" }, "type": { "description": "The type of this resource in the engine", "example": "IncidentSeverity", "type": "string" } }, "required": [ "key", "label", "type", "array" ], "type": "object" }, "EscalationCreatorV2": { "description": "The creator of this escalation. Can be a user, a workflow, or an alert. If the escalation came from a call route, this will be empty.", "example": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "properties": { "alert": { "$ref": "#/components/schemas/AlertActorV2" }, "user": { "$ref": "#/components/schemas/UserV2" }, "workflow": { "$ref": "#/components/schemas/WorkflowActorV2" } }, "type": "object" }, "EscalationEventV2": { "example": { "channels": [ { "microsoft_teams_channel_id": "abc123", "microsoft_teams_team_id": "abc123", "slack_channel_id": "abc123", "slack_team_id": "abc123" } ], "event": "entered_grace_period", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "occurred_at": "2021-08-17T13:28:57.801578Z", "urgency": "high", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ] }, "properties": { "channels": { "description": "This field will be populated for notified_channels events.", "example": [ { "microsoft_teams_channel_id": "abc123", "microsoft_teams_team_id": "abc123", "slack_channel_id": "abc123", "slack_team_id": "abc123" } ], "items": { "$ref": "#/components/schemas/ChatChannelSlimV2" }, "type": "array" }, "event": { "description": "The type of event that occured.", "enum": [ "entered_grace_period", "triggered", "notified_users", "notified_channels", "acked", "cancelled", "resolved", "expired" ], "example": "entered_grace_period", "type": "string" }, "id": { "description": "The unique ID for this escalation event", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "occurred_at": { "description": "The time when this escalation event was processed", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "urgency": { "description": "The urgency at which we tried to notify users. This field will be populated for notified_users events.", "enum": [ "high", "low" ], "example": "high", "type": "string" }, "users": { "description": "This field will be populated for notified_users and acked events.", "example": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "items": { "$ref": "#/components/schemas/UserV2" }, "type": "array" } }, "required": [ "id", "event", "occurred_at" ], "type": "object" }, "EscalationPathNodeDelayV2": { "example": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "delay_interval_condition": { "description": "If the delay is relative to a time window, this defines whether we advance when the window is active or inactive", "enum": [ "active", "inactive" ], "example": "active", "type": "string" }, "delay_seconds": { "description": "How long to delay before advancing to the next node in the path, in seconds", "example": 300, "format": "int64", "type": "integer" }, "delay_weekday_interval_config_id": { "description": "If the delay is relative to a time window, this identifies which window it is relative to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "type": "object" }, "EscalationPathNodeIfElsePayloadV2": { "example": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "then_path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ] }, "properties": { "conditions": { "description": "The condition that defines which branch to take", "example": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "items": { "$ref": "#/components/schemas/ConditionPayloadV2" }, "type": "array" }, "else_path": { "description": "The nodes that form the levels if our condition is not met", "example": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "items": { "$ref": "#/components/schemas/EscalationPathNodePayloadV2" }, "type": "array" }, "then_path": { "description": "The nodes that form the levels if our condition is met", "example": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "items": { "$ref": "#/components/schemas/EscalationPathNodePayloadV2" }, "type": "array" } }, "required": [ "then_path", "else_path" ], "type": "object" }, "EscalationPathNodeIfElseV2": { "example": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "then_path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ] }, "properties": { "conditions": { "description": "The condition that defines which branch to take", "example": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "items": { "$ref": "#/components/schemas/ConditionV2" }, "type": "array" }, "else_path": { "description": "The nodes that form the levels if our condition is not met", "example": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "items": { "$ref": "#/components/schemas/EscalationPathNodeV2" }, "type": "array" }, "then_path": { "description": "The nodes that form the levels if our condition is met", "example": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "items": { "$ref": "#/components/schemas/EscalationPathNodeV2" }, "type": "array" } }, "required": [ "conditions", "then_path", "else_path" ], "type": "object" }, "EscalationPathNodeLevelV2": { "example": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "ack_mode": { "description": "Controls the behaviour of acknowledgements for this level, with 'first' cancelling all other escalations on the same level when someone acks", "enum": [ "all", "first" ], "example": "all", "type": "string" }, "round_robin_config": { "$ref": "#/components/schemas/EscalationPathRoundRobinConfigV2" }, "targets": { "description": "The targets (users or schedules) for this level", "example": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "items": { "$ref": "#/components/schemas/EscalationPathTargetV2" }, "type": "array" }, "time_to_ack_interval_condition": { "description": "If the time to ack is relative to a time window, this defines whether we move when the window is active or inactive", "enum": [ "active", "inactive" ], "example": "active", "type": "string" }, "time_to_ack_seconds": { "description": "How long should we wait for this level to acknowledge before proceeding to the next node in the path?", "example": 1800, "format": "int64", "type": "integer" }, "time_to_ack_weekday_interval_config_id": { "description": "If the time to ack is relative to a time window, this identifies which window it is relative to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "targets" ], "type": "object" }, "EscalationPathNodeNotifyChannelV2": { "example": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "targets": { "description": "The targets (Slack channels) for this level", "example": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "items": { "$ref": "#/components/schemas/EscalationPathTargetV2" }, "type": "array" }, "time_to_ack_interval_condition": { "description": "If the time to ack is relative to a time window, this defines whether we move when the window is active or inactive", "enum": [ "active", "inactive" ], "example": "active", "type": "string" }, "time_to_ack_seconds": { "description": "How long should we wait for this level to acknowledge before moving on to the next node in the path?", "example": 1800, "format": "int64", "type": "integer" }, "time_to_ack_weekday_interval_config_id": { "description": "If the time to ack is relative to a time window, this identifies which window it is relative to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "targets" ], "type": "object" }, "EscalationPathNodePayloadV2": { "example": { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" }, "properties": { "delay": { "$ref": "#/components/schemas/EscalationPathNodeDelayV2" }, "id": { "description": "An ID for this node, unique within the escalation path.\n\nThis allows you to reference the node in other nodes, such as when configuring a 'repeat' node.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "if_else": { "$ref": "#/components/schemas/EscalationPathNodeIfElsePayloadV2" }, "level": { "$ref": "#/components/schemas/EscalationPathNodeLevelV2" }, "notify_channel": { "$ref": "#/components/schemas/EscalationPathNodeNotifyChannelV2" }, "repeat": { "$ref": "#/components/schemas/EscalationPathNodeRepeatV2" }, "type": { "description": "The type of this node. Available types are:\n* level: A set of targets (users or schedules) that should be paged, either all at once, or with a round-robin configuration.\n* notify_channel: Send the escalation to a Slack channel, where it can be acked by anyone in the channel.\n* if_else: Branch the escalation based on a set of conditions.\n* repeat: Go back to a previous node and repeat the logic from there.\n* delay: Pause the escalation for a configured duration before advancing to the next node.", "enum": [ "if_else", "repeat", "level", "notify_channel", "delay" ], "example": "if_else", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "EscalationPathNodeRepeatV2": { "example": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "repeat_times": { "description": "How many times to repeat these nodes", "example": 3, "format": "int64", "type": "integer" }, "to_node": { "description": "Which node ID we begin repeating from.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "to_node", "repeat_times" ], "type": "object" }, "EscalationPathNodeV2": { "example": { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" }, "properties": { "delay": { "$ref": "#/components/schemas/EscalationPathNodeDelayV2" }, "id": { "description": "An ID for this node, unique within the escalation path.\n\nThis allows you to reference the node in other nodes, such as when configuring a 'repeat' node.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "if_else": { "$ref": "#/components/schemas/EscalationPathNodeIfElseV2" }, "level": { "$ref": "#/components/schemas/EscalationPathNodeLevelV2" }, "notify_channel": { "$ref": "#/components/schemas/EscalationPathNodeNotifyChannelV2" }, "repeat": { "$ref": "#/components/schemas/EscalationPathNodeRepeatV2" }, "type": { "description": "The type of this node. Available types are:\n* level: A set of targets (users or schedules) that should be paged, either all at once, or with a round-robin configuration.\n* notify_channel: Send the escalation to a Slack channel, where it can be acked by anyone in the channel.\n* if_else: Branch the escalation based on a set of conditions.\n* repeat: Go back to a previous node and repeat the logic from there.\n* delay: Pause the escalation for a configured duration before advancing to the next node.", "enum": [ "if_else", "repeat", "level", "notify_channel", "delay" ], "example": "if_else", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "EscalationPathRepeatConfigV2": { "example": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "properties": { "delay_repeat_on_activity": { "default": false, "description": "When true, incident activity resets the repeat timer.", "example": false, "type": "boolean" }, "repeat_after_seconds": { "description": "Number of seconds we'll wait before repeating an escalation.", "example": 1800, "format": "int32", "maximum": 345600, "minimum": 300, "type": "integer" } }, "required": [ "repeat_after_seconds", "delay_repeat_on_activity" ], "type": "object" }, "EscalationPathRoundRobinConfigV2": { "example": { "enabled": false, "rotate_after_seconds": 120 }, "properties": { "enabled": { "description": "Whether round robin is enabled for this level", "example": false, "type": "boolean" }, "rotate_after_seconds": { "description": "How long should we wait before rotating to the next target in a round robin, if not set will stick with a single target per level.", "example": 120, "format": "int64", "type": "integer" } }, "required": [ "enabled" ], "type": "object" }, "EscalationPathTargetV2": { "example": { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" }, "properties": { "id": { "description": "Uniquely identifies an entity of this type", "example": "lawrencejones", "type": "string" }, "schedule_mode": { "description": "Only set for schedule targets, and either currently_on_call, all_users or all_users_for_rota and specifies which users to fetch from the schedule", "enum": [ "currently_on_call", "all_users_for_rota", "all_users", "" ], "example": "currently_on_call", "type": "string" }, "type": { "description": "Controls what type of entity this target identifies, such as EscalationPolicy or User", "enum": [ "schedule", "user", "slack_channel", "msteams_channel" ], "example": "schedule", "type": "string", "x-public-api-version": "v2" }, "urgency": { "description": "The urgency of this escalation path target", "enum": [ "high", "low" ], "example": "high", "type": "string" } }, "required": [ "type", "id", "urgency" ], "type": "object" }, "EscalationPathV2": { "example": { "current_responders": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Urgent Support", "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "properties": { "current_responders": { "description": "Users who are currently on-call for this escalation path", "example": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "items": { "$ref": "#/components/schemas/UserV2" }, "type": "array" }, "id": { "description": "Unique identifier for this escalation path.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "The name of this escalation path, for the user's reference.", "example": "Urgent Support", "type": "string" }, "path": { "description": "The nodes that form the levels and branches of this escalation path.", "example": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "items": { "$ref": "#/components/schemas/EscalationPathNodeV2" }, "type": "array" }, "repeat_config": { "$ref": "#/components/schemas/EscalationPathRepeatConfigV2" }, "team_ids": { "description": "IDs of the teams that own this escalation path. This will automatically sync escalation paths with the right teams in Catalog. If you have an escalation paths attribute on your Teams, this attribute is required.", "example": [ "01JPQA75EPNEES4479P16P4XAB" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "working_hours": { "description": "The working hours for this escalation path.", "example": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ], "items": { "$ref": "#/components/schemas/WeekdayIntervalConfigV2" }, "type": "array" } }, "required": [ "id", "name", "path", "team_ids" ], "type": "object" }, "EscalationPriorityV2": { "description": "The priority associated with this escalation.", "example": { "name": "P1" }, "properties": { "name": { "description": "The human readable label for this priority", "example": "P1", "type": "string" } }, "required": [ "name" ], "type": "object" }, "EscalationV2": { "example": { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "escalation_path_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "events": [ { "channels": [ { "microsoft_teams_channel_id": "abc123", "microsoft_teams_team_id": "abc123", "slack_channel_id": "abc123", "slack_team_id": "abc123" } ], "event": "entered_grace_period", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "occurred_at": "2021-08-17T13:28:57.801578Z", "urgency": "high", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ] } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "priority": { "name": "P1" }, "related_alerts": [ { "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "related_incidents": [ { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } ], "status": "pending", "title": "Database CPU is high", "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "created_at": { "description": "When this escalation was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "creator": { "$ref": "#/components/schemas/EscalationCreatorV2" }, "escalation_path_id": { "description": "Unique identifier of the escalation path that the escalation was created from", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "events": { "description": "Events which describe the history of this escalation. Events include information about what users or channels were notified and what users acked.", "example": [ { "channels": [ { "microsoft_teams_channel_id": "abc123", "microsoft_teams_team_id": "abc123", "slack_channel_id": "abc123", "slack_team_id": "abc123" } ], "event": "entered_grace_period", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "occurred_at": "2021-08-17T13:28:57.801578Z", "urgency": "high", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ] } ], "items": { "$ref": "#/components/schemas/EscalationEventV2" }, "type": "array" }, "id": { "description": "Unique ID of the escalation", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "priority": { "$ref": "#/components/schemas/EscalationPriorityV2" }, "related_alerts": { "description": "Alerts related to this escalation", "example": [ { "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/AlertSlimV2" }, "type": "array" }, "related_incidents": { "description": "Incidents related to this escalation", "example": [ { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } ], "items": { "$ref": "#/components/schemas/IncidentSlimV2" }, "type": "array" }, "status": { "description": "Status of the escalation", "enum": [ "pending", "triggered", "acked", "resolved", "expired", "cancelled", "snoozed", "delayed", "pending_repeat" ], "example": "pending", "type": "string" }, "title": { "description": "The title of this escalation", "example": "Database CPU is high", "type": "string" }, "updated_at": { "description": "When this escalation was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "created_at", "updated_at", "status", "title", "priority", "creator", "events", "related_incidents", "related_alerts" ], "type": "object" }, "EscalationsCreatePathPayloadV2": { "example": { "name": "Urgent Support", "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "properties": { "name": { "description": "The name of this escalation path, for the user's reference.", "example": "Urgent Support", "type": "string" }, "path": { "description": "The nodes that form the levels and branches of this escalation path.", "example": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "items": { "$ref": "#/components/schemas/EscalationPathNodePayloadV2" }, "type": "array" }, "repeat_config": { "$ref": "#/components/schemas/EscalationPathRepeatConfigV2" }, "team_ids": { "description": "IDs of the teams that own this escalation path. This will automatically sync escalation paths with the right teams in Catalog. If you have an escalation paths attribute on your Teams, this attribute is required.", "example": [ "01JPQA75EPNEES4479P16P4XAB" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "working_hours": { "description": "The working hours for this escalation path.", "example": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ], "items": { "$ref": "#/components/schemas/WeekdayIntervalConfigV2" }, "type": "array" } }, "required": [ "name", "path" ], "type": "object" }, "EscalationsCreatePathResultV2": { "example": { "escalation_path": { "current_responders": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Urgent Support", "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } }, "properties": { "escalation_path": { "$ref": "#/components/schemas/EscalationPathV2" } }, "required": [ "escalation_path" ], "type": "object" }, "EscalationsCreatePayloadV2": { "example": { "description": "Database CPU has been above 90% for 5 minutes", "escalation_path_id": "01H0J1EXE7AXZ2C93K61WBPYEH", "idempotency_key": "2024-01-15-abc123", "title": "Production database experiencing high CPU", "user_ids": [ "01H0J1EXE7AXZ2C93K61WBPYEH", "01H0J1EXE7AXZ2C93K61WBPYEI" ] }, "properties": { "description": { "description": "Additional details about the escalation", "example": "Database CPU has been above 90% for 5 minutes", "type": "string" }, "escalation_path_id": { "description": "ID of the escalation path to follow", "example": "01H0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "idempotency_key": { "description": "Unique key to prevent duplicate escalations. If this key has already been used, the existing escalation will be returned.", "example": "2024-01-15-abc123", "type": "string" }, "title": { "description": "The title of the escalation. This message will be included in all notifications about this escalation.", "example": "Production database experiencing high CPU", "type": "string" }, "user_ids": { "description": "IDs of users to escalate directly to", "example": [ "01H0J1EXE7AXZ2C93K61WBPYEH", "01H0J1EXE7AXZ2C93K61WBPYEI" ], "items": { "example": "abc123", "type": "string" }, "type": "array" } }, "required": [ "idempotency_key", "title" ], "type": "object" }, "EscalationsCreateResultV2": { "example": { "escalation": { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "escalation_path_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "events": [ { "channels": [ { "microsoft_teams_channel_id": "abc123", "microsoft_teams_team_id": "abc123", "slack_channel_id": "abc123", "slack_team_id": "abc123" } ], "event": "entered_grace_period", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "occurred_at": "2021-08-17T13:28:57.801578Z", "urgency": "high", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ] } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "priority": { "name": "P1" }, "related_alerts": [ { "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "related_incidents": [ { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } ], "status": "pending", "title": "Database CPU is high", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "escalation": { "$ref": "#/components/schemas/EscalationV2" } }, "required": [ "escalation" ], "type": "object" }, "EscalationsListPathsResultV2": { "example": { "escalation_paths": [ { "current_responders": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Urgent Support", "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "escalation_paths": { "example": [ { "current_responders": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Urgent Support", "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } ], "items": { "$ref": "#/components/schemas/EscalationPathV2" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" } }, "required": [ "escalation_paths", "pagination_meta" ], "type": "object" }, "EscalationsListResultV2": { "example": { "escalations": [ { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "escalation_path_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "events": [ { "channels": [ { "microsoft_teams_channel_id": "abc123", "microsoft_teams_team_id": "abc123", "slack_channel_id": "abc123", "slack_team_id": "abc123" } ], "event": "entered_grace_period", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "occurred_at": "2021-08-17T13:28:57.801578Z", "urgency": "high", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ] } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "priority": { "name": "P1" }, "related_alerts": [ { "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "related_incidents": [ { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } ], "status": "pending", "title": "Database CPU is high", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "escalations": { "example": [ { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "escalation_path_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "events": [ { "channels": [ { "microsoft_teams_channel_id": "abc123", "microsoft_teams_team_id": "abc123", "slack_channel_id": "abc123", "slack_team_id": "abc123" } ], "event": "entered_grace_period", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "occurred_at": "2021-08-17T13:28:57.801578Z", "urgency": "high", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ] } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "priority": { "name": "P1" }, "related_alerts": [ { "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "related_incidents": [ { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } ], "status": "pending", "title": "Database CPU is high", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/EscalationV2" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" } }, "required": [ "escalations", "pagination_meta" ], "type": "object" }, "EscalationsShowPathResultV2": { "example": { "escalation_path": { "current_responders": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Urgent Support", "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } }, "properties": { "escalation_path": { "$ref": "#/components/schemas/EscalationPathV2" } }, "required": [ "escalation_path" ], "type": "object" }, "EscalationsShowResultV2": { "example": { "escalation": { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "escalation_path_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "events": [ { "channels": [ { "microsoft_teams_channel_id": "abc123", "microsoft_teams_team_id": "abc123", "slack_channel_id": "abc123", "slack_team_id": "abc123" } ], "event": "entered_grace_period", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "occurred_at": "2021-08-17T13:28:57.801578Z", "urgency": "high", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ] } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "priority": { "name": "P1" }, "related_alerts": [ { "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "related_incidents": [ { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } ], "status": "pending", "title": "Database CPU is high", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "escalation": { "$ref": "#/components/schemas/EscalationV2" } }, "required": [ "escalation" ], "type": "object" }, "EscalationsUpdatePathPayloadV2": { "example": { "name": "Urgent Support", "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "properties": { "name": { "description": "The name of this escalation path, for the user's reference.", "example": "Urgent Support", "type": "string" }, "path": { "description": "The nodes that form the levels and branches of this escalation path.", "example": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "items": { "$ref": "#/components/schemas/EscalationPathNodePayloadV2" }, "type": "array" }, "repeat_config": { "$ref": "#/components/schemas/EscalationPathRepeatConfigV2" }, "team_ids": { "description": "IDs of the teams that own this escalation path. This will automatically sync escalation paths with the right teams in Catalog. If you have an escalation paths attribute on your Teams, this attribute is required.", "example": [ "01JPQA75EPNEES4479P16P4XAB" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "working_hours": { "description": "The working hours for this escalation path.", "example": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ], "items": { "$ref": "#/components/schemas/WeekdayIntervalConfigV2" }, "type": "array" } }, "required": [ "name", "path" ], "type": "object" }, "EscalationsUpdatePathResultV2": { "example": { "escalation_path": { "current_responders": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Urgent Support", "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } }, "properties": { "escalation_path": { "$ref": "#/components/schemas/EscalationPathV2" } }, "required": [ "escalation_path" ], "type": "object" }, "ExpressionBranchPayloadV2": { "example": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "condition_groups": { "description": "When one of these condition groups are satisfied, this branch will be evaluated", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" }, "result": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" } }, "required": [ "condition_groups", "result" ], "type": "object" }, "ExpressionBranchV2": { "example": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "condition_groups": { "description": "When one of these condition groups are satisfied, this branch will be evaluated", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV2" }, "type": "array" }, "result": { "$ref": "#/components/schemas/EngineParamBindingV2" } }, "required": [ "condition_groups", "result" ], "type": "object" }, "ExpressionBranchesOptsPayloadV2": { "example": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "properties": { "branches": { "description": "The branches to apply for this operation", "example": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/ExpressionBranchPayloadV2" }, "type": "array" }, "returns": { "$ref": "#/components/schemas/ReturnsMetaV2" } }, "required": [ "branches", "returns" ], "type": "object" }, "ExpressionBranchesOptsV2": { "example": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "properties": { "branches": { "description": "The branches to apply for this operation", "example": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/ExpressionBranchV2" }, "type": "array" }, "returns": { "$ref": "#/components/schemas/ReturnsMetaV2" } }, "required": [ "branches", "returns" ], "type": "object" }, "ExpressionConcatenateOptsPayloadV2": { "example": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "properties": { "reference": { "description": "The reference that you want to concatenate with", "example": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]", "type": "string" } }, "required": [ "reference" ], "type": "object" }, "ExpressionElseBranchPayloadV2": { "example": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "result": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" } }, "required": [ "result" ], "type": "object" }, "ExpressionElseBranchV2": { "example": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "result": { "$ref": "#/components/schemas/EngineParamBindingV2" } }, "required": [ "result" ], "type": "object" }, "ExpressionFilterOptsPayloadV2": { "example": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "properties": { "condition_groups": { "description": "The condition groups to apply in this filter. Only one group needs to be satisfied for the filter to pass.", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" } }, "required": [ "condition_groups" ], "type": "object" }, "ExpressionFilterOptsV2": { "example": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "properties": { "condition_groups": { "description": "The condition groups to apply in this filter. Only one group needs to be satisfied for the filter to pass.", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV2" }, "type": "array" } }, "required": [ "condition_groups" ], "type": "object" }, "ExpressionNavigateOptsPayloadV2": { "example": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "properties": { "reference": { "description": "The reference that you want to navigate to", "example": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]", "type": "string" } }, "required": [ "reference" ], "type": "object" }, "ExpressionNavigateOptsV2": { "example": { "reference": "1235", "reference_label": "Teams" }, "properties": { "reference": { "description": "The reference within the scope to navigate to", "example": "1235", "type": "string" }, "reference_label": { "description": "The name of the reference to navigate to", "example": "Teams", "type": "string" } }, "required": [ "reference", "reference_label" ], "type": "object" }, "ExpressionOperationPayloadV2": { "example": { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } }, "properties": { "branches": { "$ref": "#/components/schemas/ExpressionBranchesOptsPayloadV2" }, "concatenate": { "$ref": "#/components/schemas/ExpressionConcatenateOptsPayloadV2" }, "filter": { "$ref": "#/components/schemas/ExpressionFilterOptsPayloadV2" }, "navigate": { "$ref": "#/components/schemas/ExpressionNavigateOptsPayloadV2" }, "operation_type": { "description": "The type of the operation", "enum": [ "navigate", "filter", "concatenate", "count", "min", "max", "sum", "random", "first", "parse", "branches" ], "example": "navigate", "type": "string" }, "parse": { "$ref": "#/components/schemas/ExpressionParseOptsPayloadV2" } }, "required": [ "operation_type" ], "type": "object" }, "ExpressionOperationV2": { "example": { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } }, "properties": { "branches": { "$ref": "#/components/schemas/ExpressionBranchesOptsV2" }, "filter": { "$ref": "#/components/schemas/ExpressionFilterOptsV2" }, "navigate": { "$ref": "#/components/schemas/ExpressionNavigateOptsV2" }, "operation_type": { "description": "The type of the operation", "enum": [ "navigate", "filter", "concatenate", "count", "min", "max", "sum", "random", "first", "parse", "branches" ], "example": "navigate", "type": "string" }, "parse": { "$ref": "#/components/schemas/ExpressionParseOptsV2" }, "returns": { "$ref": "#/components/schemas/ReturnsMetaV2" } }, "required": [ "operation_type", "returns" ], "type": "object" }, "ExpressionParseOptsPayloadV2": { "example": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "properties": { "returns": { "$ref": "#/components/schemas/ReturnsMetaV2" }, "source": { "description": "Source expression that is evaluated to a result", "example": "metadata.annotations[\"github.com/repo\"]", "type": "string" } }, "required": [ "source", "returns" ], "type": "object" }, "ExpressionParseOptsV2": { "example": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "properties": { "returns": { "$ref": "#/components/schemas/ReturnsMetaV2" }, "source": { "description": "Source expression that is evaluated to a result", "example": "metadata.annotations[\"github.com/repo\"]", "type": "string" } }, "required": [ "source", "returns" ], "type": "object" }, "ExpressionPayloadV2": { "example": { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" }, "properties": { "else_branch": { "$ref": "#/components/schemas/ExpressionElseBranchPayloadV2" }, "label": { "description": "The human readable label of the expression", "example": "Team Slack channel", "type": "string" }, "operations": { "example": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "items": { "$ref": "#/components/schemas/ExpressionOperationPayloadV2" }, "type": "array" }, "reference": { "description": "A short ID that can be used to reference the expression", "example": "abc123", "type": "string" }, "root_reference": { "description": "The root reference for this expression (i.e. where the expression starts)", "example": "incident.status", "type": "string" } }, "required": [ "label", "reference", "root_reference", "operations" ], "type": "object" }, "ExpressionV2": { "example": { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" }, "properties": { "else_branch": { "$ref": "#/components/schemas/ExpressionElseBranchV2" }, "label": { "description": "The human readable label of the expression", "example": "Team Slack channel", "type": "string" }, "operations": { "example": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "items": { "$ref": "#/components/schemas/ExpressionOperationV2" }, "type": "array" }, "reference": { "description": "A short ID that can be used to reference the expression", "example": "abc123", "type": "string" }, "returns": { "$ref": "#/components/schemas/ReturnsMetaV2" }, "root_reference": { "description": "The root reference for this expression (i.e. where the expression starts)", "example": "incident.status", "type": "string" } }, "required": [ "label", "reference", "returns", "root_reference", "operations" ], "type": "object" }, "ExternalIssueReferenceV1": { "example": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "properties": { "issue_name": { "description": "Human readable ID for the issue", "example": "INC-123", "type": "string" }, "issue_permalink": { "description": "URL linking directly to the action in the issue tracker", "example": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "type": "string" }, "provider": { "description": "ID of the issue tracker provider", "enum": [ "asana", "azure_devops", "click_up", "linear", "jira", "jira_server", "github", "gitlab", "service_now", "shortcut" ], "example": "asana", "type": "string" } }, "type": "object" }, "ExternalIssueReferenceV2": { "example": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "properties": { "issue_name": { "description": "Human readable ID for the issue", "example": "INC-123", "type": "string" }, "issue_permalink": { "description": "URL linking directly to the action in the issue tracker", "example": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "type": "string" }, "provider": { "description": "ID of the issue tracker provider", "enum": [ "asana", "azure_devops", "click_up", "linear", "jira", "jira_server", "github", "gitlab", "service_now", "shortcut" ], "example": "asana", "type": "string" } }, "required": [ "provider", "issue_name", "issue_permalink" ], "type": "object" }, "ExternalResourceV1": { "example": { "external_id": "123", "permalink": "https://my.pagerduty.com/incidents/ABC", "resource_type": "pager_duty_incident", "title": "The database has gone down" }, "properties": { "external_id": { "description": "ID of the resource in the external system", "example": "123", "type": "string" }, "permalink": { "description": "URL of the resource", "example": "https://my.pagerduty.com/incidents/ABC", "type": "string" }, "resource_type": { "description": "E.g. PagerDuty: the external system that holds the resource", "enum": [ "pager_duty_incident", "opsgenie_alert", "datadog_monitor_alert", "github_pull_request", "gitlab_merge_request", "sentry_issue", "jira_issue", "jsm_alert", "atlassian_statuspage_incident", "zendesk_ticket", "google_calendar_event", "outlook_calendar_event", "slack_file", "salesforce_case", "scrubbed", "statuspage_incident" ], "example": "pager_duty_incident", "type": "string" }, "title": { "description": "Title of resource", "example": "The database has gone down", "type": "string" } }, "required": [ "permalink", "external_id", "title", "resource_type" ], "type": "object" }, "FollowUpPriorityV2": { "example": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "properties": { "description": { "description": "Description of the follow-up priority option", "example": "A follow-up that requires immediate attention.", "type": "string" }, "id": { "description": "Unique identifier for the follow-up priority option", "example": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "type": "string" }, "name": { "description": "Name of the follow-up priority option", "example": "Urgent", "type": "string" }, "rank": { "description": "Rank is used to order the follow-up priority options correctly", "example": 10, "format": "int64", "type": "integer" } }, "required": [ "id", "name", "rank" ], "type": "object" }, "FollowUpV2": { "example": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "assignee": { "$ref": "#/components/schemas/UserV2" }, "completed_at": { "description": "When the follow-up was completed", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "created_at": { "description": "When the follow-up was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "creator": { "$ref": "#/components/schemas/ActorV2" }, "description": { "description": "Description of the follow-up", "example": "Call the fire brigade", "type": "string" }, "external_issue_reference": { "$ref": "#/components/schemas/ExternalIssueReferenceV2" }, "id": { "description": "Unique identifier for the follow-up", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_id": { "description": "Unique identifier of the incident the follow-up belongs to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "labels": { "description": "Labels associated with this follow-up", "example": [ "bug", "urgent" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "priority": { "$ref": "#/components/schemas/FollowUpPriorityV2" }, "status": { "description": "Status of the follow-up", "enum": [ "outstanding", "completed", "deleted", "not_doing" ], "example": "outstanding", "type": "string" }, "title": { "description": "Title of the follow-up", "example": "Cat is stuck in the tree", "type": "string" }, "updated_at": { "description": "When the follow-up was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "incident_id", "creator", "title", "status", "labels", "created_at", "updated_at" ], "type": "object" }, "FollowUpsListResultV2": { "example": { "follow_ups": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "follow_ups": { "example": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/FollowUpV2" }, "type": "array" } }, "required": [ "follow_ups" ], "type": "object" }, "FollowUpsShowResultV2": { "example": { "follow_up": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "follow_up": { "$ref": "#/components/schemas/FollowUpV2" } }, "required": [ "follow_up" ], "type": "object" }, "GroupingKeyV2": { "example": { "reference": "alert.title" }, "properties": { "reference": { "description": "A reference to a property of the alert to group on", "example": "alert.title", "type": "string" } }, "required": [ "reference" ], "type": "object" }, "IPAllowlistItemV1": { "example": { "label": "London HQ", "value": "192.0.2.0" }, "properties": { "label": { "description": "A label to help identify this IP or prefix", "example": "London HQ", "type": "string" }, "value": { "description": "An IP address or a CIDR IP prefix to allow", "example": "192.0.2.0", "type": "string" } }, "required": [ "value" ], "type": "object" }, "IPAllowlistV1": { "example": { "allowlist": [ { "label": "London HQ", "value": "192.0.2.0" } ], "enabled": true, "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 }, "properties": { "allowlist": { "description": "A list of IP addresses or CIDR prefixes to allow", "example": [ { "label": "London HQ", "value": "192.0.2.0" } ], "items": { "$ref": "#/components/schemas/IPAllowlistItemV1" }, "type": "array" }, "enabled": { "description": "Whether this IP allowlist is enabled or not", "example": true, "type": "boolean" }, "updated_at": { "description": "The time this allowlist was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "version": { "description": "The version of this IP allowlist", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "version", "enabled", "allowlist" ], "type": "object" }, "IPAllowlistsShowIPAllowlistResultV1": { "example": { "ip_allowlist": { "allowlist": [ { "label": "London HQ", "value": "192.0.2.0" } ], "enabled": true, "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "properties": { "ip_allowlist": { "$ref": "#/components/schemas/IPAllowlistV1" } }, "required": [ "ip_allowlist" ], "type": "object" }, "IPAllowlistsUpdateIPAllowlistPayloadV1": { "example": { "allowlist": [ { "label": "London HQ", "value": "192.0.2.0" } ], "enabled": true, "version": 1 }, "properties": { "allowlist": { "description": "A list of IP addresses or CIDR prefixes to allow", "example": [ { "label": "London HQ", "value": "192.0.2.0" } ], "items": { "$ref": "#/components/schemas/IPAllowlistItemV1" }, "type": "array" }, "enabled": { "description": "Whether this IP allowlist is enabled or not", "example": true, "type": "boolean" }, "version": { "description": "The version of this IP allowlist", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "version", "enabled", "allowlist" ], "type": "object" }, "IPAllowlistsUpdateIPAllowlistResultV1": { "example": { "ip_allowlist": { "allowlist": [ { "label": "London HQ", "value": "192.0.2.0" } ], "enabled": true, "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "properties": { "ip_allowlist": { "$ref": "#/components/schemas/IPAllowlistV1" } }, "required": [ "ip_allowlist" ], "type": "object" }, "IdentityTeamV1": { "example": { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Platform" }, "properties": { "id": { "description": "Unique identifier for the team", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "name": { "description": "Human readable name of the team", "example": "Platform", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "IdentityV1": { "example": { "dashboard_url": "https://app.incident.io/my-org", "name": "Alertmanager token", "roles": [ "viewer" ], "team_roles": [ "schedules_editor" ], "teams": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Platform" } ] }, "properties": { "dashboard_url": { "description": "The dashboard URL for this organisation", "example": "https://app.incident.io/my-org", "type": "string" }, "name": { "description": "The name assigned to the current API Key", "example": "Alertmanager token", "type": "string" }, "roles": { "description": "Which roles have been enabled for this key", "example": [ "viewer" ], "items": { "description": "API key roles", "enum": [ "viewer", "incident_creator", "incident_editor", "manage_settings", "global_access", "catalog_viewer", "catalog_editor", "incident_memberships_editor", "schedules_editor", "schedules_reader", "schedule_overrides_editor", "workflows_editor", "private_workflows_editor", "on_call_editor", "escalation_creator", "post_incident_flow_opt_out", "security_settings_editor", "investigation_download", "team_memberships_manage", "status_page_publisher", "postmortems_manage", "api_keys_manage", "notification_methods_manage" ], "example": "viewer", "type": "string", "x-public-api-version": "v1" }, "type": "array" }, "team_roles": { "description": "If set, these roles apply to requests that operate on resources owned by any of the teams in the 'teams' array. These are in addition to any 'roles' which are applied on all requests.", "example": [ "schedules_editor" ], "items": { "description": "API key team roles", "enum": [ "schedules_editor", "schedules_reader", "schedule_overrides_editor", "on_call_editor", "escalation_creator", "api_keys_manage" ], "example": "schedules_editor", "type": "string", "x-public-api-version": "v1" }, "type": "array" }, "teams": { "description": "Teams that this API key is scoped to. If this is not empty, the current API key has additional roles within these teams (see team_roles).", "example": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Platform" } ], "items": { "$ref": "#/components/schemas/IdentityTeamV1" }, "type": "array" } }, "required": [ "name", "roles", "dashboard_url", "team_roles", "teams" ], "type": "object" }, "IncidentAlertV2": { "example": { "alert": { "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" }, "alert_route_id": "01GW2G3V0S59R238FAHPDS1R67", "id": "01GW2G3V0S59R238FAHPDS1R66", "incident": { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } }, "properties": { "alert": { "$ref": "#/components/schemas/AlertSlimV2" }, "alert_route_id": { "description": "The ID of the alert route that created this incident alert", "example": "01GW2G3V0S59R238FAHPDS1R67", "type": "string" }, "id": { "description": "The ID of this alert", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "incident": { "$ref": "#/components/schemas/IncidentSlimV2" } }, "required": [ "id", "alert", "incident" ], "type": "object" }, "IncidentAttachmentV1": { "example": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "resource": { "external_id": "123", "permalink": "https://my.pagerduty.com/incidents/ABC", "resource_type": "pager_duty_incident", "title": "The database has gone down" } }, "properties": { "id": { "description": "Unique identifier of this incident membership", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "incident_id": { "description": "Unique identifier of the incident", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "resource": { "$ref": "#/components/schemas/ExternalResourceV1" } }, "required": [ "id", "incident_id", "resource" ], "type": "object" }, "IncidentAttachmentsCreatePayloadV1": { "example": { "incident_id": "01FDAG4SAP5TYPT98WGR2N7W91", "resource": { "external_id": "123", "resource_type": "pager_duty_incident" } }, "properties": { "incident_id": { "description": "ID of the incident to add an attachment to", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" }, "resource": { "example": { "external_id": "123", "resource_type": "pager_duty_incident" }, "properties": { "external_id": { "description": "ID of the resource in the external system", "example": "123", "type": "string" }, "resource_type": { "description": "E.g. PagerDuty: the external system that holds the resource", "enum": [ "pager_duty_incident", "opsgenie_alert", "datadog_monitor_alert", "github_pull_request", "gitlab_merge_request", "sentry_issue", "jira_issue", "jsm_alert", "atlassian_statuspage_incident", "zendesk_ticket", "google_calendar_event", "outlook_calendar_event", "slack_file", "salesforce_case", "scrubbed", "statuspage_incident" ], "example": "pager_duty_incident", "type": "string" } }, "required": [ "id", "permalink", "external_id", "title", "resource_type", "resource_type_label", "created_at", "updated_at" ], "type": "object" } }, "required": [ "incident_id", "resource" ], "type": "object" }, "IncidentAttachmentsCreateResultV1": { "example": { "incident_attachment": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "resource": { "external_id": "123", "permalink": "https://my.pagerduty.com/incidents/ABC", "resource_type": "pager_duty_incident", "title": "The database has gone down" } } }, "properties": { "incident_attachment": { "$ref": "#/components/schemas/IncidentAttachmentV1" } }, "required": [ "incident_attachment" ], "type": "object" }, "IncidentAttachmentsListResultV1": { "example": { "incident_attachments": [ { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "resource": { "external_id": "123", "permalink": "https://my.pagerduty.com/incidents/ABC", "resource_type": "pager_duty_incident", "title": "The database has gone down" } } ] }, "properties": { "incident_attachments": { "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "resource": { "external_id": "123", "permalink": "https://my.pagerduty.com/incidents/ABC", "resource_type": "pager_duty_incident", "title": "The database has gone down" } } ], "items": { "$ref": "#/components/schemas/IncidentAttachmentV1" }, "type": "array" } }, "required": [ "incident_attachments" ], "type": "object" }, "IncidentDurationMetricV2": { "example": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "properties": { "id": { "description": "Unique ID of this incident duration metric", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "name": { "description": "Unique name of this duration metric", "example": "Lasted", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "IncidentDurationMetricWithValueV2": { "example": { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "value_seconds": 10800 }, "properties": { "duration_metric": { "$ref": "#/components/schemas/IncidentDurationMetricV2" }, "value_seconds": { "description": "The calculated durations for this metric", "example": 10800, "format": "int64", "type": "integer" } }, "required": [ "duration_metric" ], "type": "object" }, "IncidentEditPayloadV2": { "example": { "call_url": "https://zoom.us/foo", "custom_field_entries": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] } ], "incident_role_assignments": [ { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" } ], "incident_status_id": "abc123", "incident_timestamp_values": [ { "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYD5H", "value": "2021-08-17T13:28:57.801578Z" } ], "name": "Our database is sad", "severity_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_channel_name_override": "inc-123-database-down", "summary": "Our database is really really sad, and we don't know why yet." }, "properties": { "call_url": { "description": "The call URL attached to this incident", "example": "https://zoom.us/foo", "type": "string" }, "custom_field_entries": { "description": "Set the incident's custom fields to these values", "example": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] } ], "items": { "$ref": "#/components/schemas/CustomFieldEntryPayloadV2" }, "type": "array" }, "incident_role_assignments": { "description": "Assign incident roles to these people", "example": [ { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" } ], "items": { "$ref": "#/components/schemas/IncidentRoleAssignmentPayloadV2" }, "type": "array" }, "incident_status_id": { "description": "Incident status to move the incident to. Allowed transitions are:\n\n- Moving between statuses within the same category (e.g. between active statuses)\n- Resolving an incident by moving from active/triage to a post-incident or closed status\n- Closing an incident from a post-incident status\n\nWhen resolving to a post-incident status, the incident enters the post-incident flow and tasks are created. The status must belong to the post-incident flow that applies to this incident based on its severity, incident type, and other properties. If you specify a status from a different post-incident flow, the request will fail with a validation error.\n\nWhen resolving directly to closed, any configured post-incident flow is skipped entirely. This requires the 'Close incidents by opting out of post-incident flow' permission on the API key, if your incident lifecycle normally requires you to run a post-incident flow for this incident.\n\nNote: Once an incident is in the post-incident flow, its status is managed automatically based on task completion. Moving between post-incident statuses via the API is not recommended as the system will recalculate the correct status when tasks are updated.", "example": "abc123", "type": "string" }, "incident_timestamp_values": { "description": "Assign the incident's timestamps to these values", "example": [ { "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYD5H", "value": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/IncidentTimestampValuePayloadV2" }, "type": "array" }, "name": { "description": "Explanation of the incident", "example": "Our database is sad", "type": "string" }, "severity_id": { "description": "The ID of the current severity of this incident", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "slack_channel_name_override": { "description": "Override the name of the incident Slack channel", "example": "inc-123-database-down", "type": "string" }, "summary": { "description": "Detailed description of the incident", "example": "Our database is really really sad, and we don't know why yet.", "type": "string" } }, "type": "object" }, "IncidentMembershipV1": { "example": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "updated_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "properties": { "created_at": { "description": "When the membership was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of this incident membership", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "incident_id": { "description": "Unique identifier of the incident", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "updated_at": { "description": "When the membership was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "user": { "$ref": "#/components/schemas/UserV1" } }, "required": [ "id", "user", "incident_id", "created_at", "updated_at" ], "type": "object" }, "IncidentMembershipsCreatePayloadV1": { "example": { "incident_id": "01ET65M7ZADYFCKD4K1AE2QNMC", "user_id": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "properties": { "incident_id": { "example": "01ET65M7ZADYFCKD4K1AE2QNMC", "type": "string" }, "user_id": { "example": "01FCQSP07Z74QMMYPDDGQB9FTG", "type": "string" } }, "required": [ "user_id", "incident_id" ], "type": "object" }, "IncidentMembershipsCreateResultV1": { "example": { "incident_membership": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "updated_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } } }, "properties": { "incident_membership": { "$ref": "#/components/schemas/IncidentMembershipV1" } }, "required": [ "incident_membership" ], "type": "object" }, "IncidentMembershipsRevokePayloadV1": { "example": { "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "user_id": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "properties": { "incident_id": { "description": "Revoke memberships to incident", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "user_id": { "example": "01FCQSP07Z74QMMYPDDGQB9FTG", "type": "string" } }, "required": [ "user_id", "incident_id" ], "type": "object" }, "IncidentRelationshipDetailsV1": { "example": { "external_id": 123, "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "The database is down" }, "properties": { "external_id": { "description": "External ID of this incident often prepended with 'INC-'", "example": 123, "format": "int64", "type": "integer" }, "id": { "description": "Unique identifier of this incident", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "name": { "description": "Name of this incident", "example": "The database is down", "type": "string" } }, "required": [ "id", "name", "external_id" ], "type": "object" }, "IncidentRelationshipV1": { "example": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "incident": { "external_id": 123, "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "The database is down" } }, "properties": { "id": { "description": "Unique identifier of this incident relationship", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "incident": { "$ref": "#/components/schemas/IncidentRelationshipDetailsV1" } }, "required": [ "id", "incident" ], "type": "object" }, "IncidentRelationshipsListResultV1": { "example": { "incident_relationships": [ { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "incident": { "external_id": 123, "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "The database is down" } } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "incident_relationships": { "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "incident": { "external_id": 123, "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "The database is down" } } ], "items": { "$ref": "#/components/schemas/IncidentRelationshipV1" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV1" } }, "required": [ "incident_relationships" ], "type": "object" }, "IncidentRoleAssignmentPayloadV1": { "example": { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" }, "properties": { "assignee": { "$ref": "#/components/schemas/UserReferencePayloadV1" }, "incident_role_id": { "description": "Unique ID of an incident role. Note that the 'reporter' role can only be assigned when creating an incident.", "example": "01FH5TZRWMNAFB0DZ23FD1TV96", "type": "string" } }, "required": [ "incident_role_id", "assignee" ], "type": "object" }, "IncidentRoleAssignmentPayloadV2": { "example": { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" }, "properties": { "assignee": { "$ref": "#/components/schemas/UserReferencePayloadV2" }, "incident_role_id": { "description": "Unique ID of an incident role. Note that the 'reporter' role can only be assigned when creating an incident.", "example": "01FH5TZRWMNAFB0DZ23FD1TV96", "type": "string" } }, "required": [ "incident_role_id" ], "type": "object" }, "IncidentRoleAssignmentV1": { "example": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "assignee": { "$ref": "#/components/schemas/UserV1" }, "role": { "$ref": "#/components/schemas/IncidentRoleV1" } }, "required": [ "role" ], "type": "object" }, "IncidentRoleAssignmentV2": { "example": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "assignee": { "$ref": "#/components/schemas/UserV2" }, "role": { "$ref": "#/components/schemas/EmbeddedIncidentRoleV2" } }, "required": [ "role" ], "type": "object" }, "IncidentRoleV1": { "example": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "created_at": { "description": "When the role was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "Describes the purpose of the role", "example": "The person currently coordinating the incident", "minLength": 1, "type": "string" }, "id": { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "instructions": { "description": "Provided to whoever is nominated for the role. Note that this will be empty for the 'reporter' role.", "example": "Take point on the incident; Make sure people are clear on responsibilities", "type": "string" }, "name": { "description": "Human readable name of the incident role", "example": "Incident Lead", "minLength": 1, "type": "string" }, "required": { "description": "DEPRECATED: this will always be false.", "example": false, "type": "boolean" }, "role_type": { "description": "Type of incident role", "enum": [ "lead", "reporter", "custom" ], "example": "lead", "type": "string" }, "shortform": { "description": "Short human readable name for Slack. Note that this will be empty for the 'reporter' role.", "example": "lead", "type": "string" }, "updated_at": { "description": "When the role was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "name", "shortform", "description", "instructions", "id", "role_type", "created_at", "updated_at" ], "type": "object" }, "IncidentRoleV2": { "example": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "created_at": { "description": "When the role was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "Describes the purpose of the role", "example": "The person currently coordinating the incident", "minLength": 1, "type": "string" }, "id": { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "instructions": { "description": "Provided to whoever is nominated for the role. Note that this will be empty for the 'reporter' role.", "example": "Take point on the incident; Make sure people are clear on responsibilities", "type": "string" }, "name": { "description": "Human readable name of the incident role", "example": "Incident Lead", "minLength": 1, "type": "string" }, "role_type": { "description": "Type of incident role", "enum": [ "lead", "reporter", "custom" ], "example": "lead", "type": "string" }, "shortform": { "description": "Short human readable name for Slack. Note that this will be empty for the 'reporter' role.", "example": "lead", "type": "string" }, "updated_at": { "description": "When the role was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "name", "shortform", "description", "instructions", "id", "role_type", "created_at", "updated_at" ], "type": "object" }, "IncidentRolesCreatePayloadV1": { "example": { "description": "The person currently coordinating the incident", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "shortform": "lead" }, "properties": { "description": { "description": "Describes the purpose of the role", "example": "The person currently coordinating the incident", "minLength": 1, "type": "string" }, "instructions": { "description": "Provided to whoever is nominated for the role. Note that this will be empty for the 'reporter' role.", "example": "Take point on the incident; Make sure people are clear on responsibilities", "type": "string" }, "name": { "description": "Human readable name of the incident role", "example": "Incident Lead", "minLength": 1, "type": "string" }, "required": { "description": "DEPRECATED: this will always be false.", "example": false, "type": "boolean" }, "shortform": { "description": "Short human readable name for Slack. Note that this will be empty for the 'reporter' role.", "example": "lead", "type": "string" } }, "required": [ "name", "shortform", "description", "instructions", "required" ], "type": "object" }, "IncidentRolesCreatePayloadV2": { "example": { "description": "The person currently coordinating the incident", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "shortform": "lead" }, "properties": { "description": { "description": "Describes the purpose of the role", "example": "The person currently coordinating the incident", "minLength": 1, "type": "string" }, "instructions": { "description": "Provided to whoever is nominated for the role. Note that this will be empty for the 'reporter' role.", "example": "Take point on the incident; Make sure people are clear on responsibilities", "type": "string" }, "name": { "description": "Human readable name of the incident role", "example": "Incident Lead", "minLength": 1, "type": "string" }, "shortform": { "description": "Short human readable name for Slack. Note that this will be empty for the 'reporter' role.", "example": "lead", "type": "string" } }, "required": [ "name", "shortform", "description", "instructions" ], "type": "object" }, "IncidentRolesCreateResultV1": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_role": { "$ref": "#/components/schemas/IncidentRoleV1" } }, "required": [ "incident_role" ], "type": "object" }, "IncidentRolesCreateResultV2": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_role": { "$ref": "#/components/schemas/IncidentRoleV2" } }, "required": [ "incident_role" ], "type": "object" }, "IncidentRolesListResultV1": { "example": { "incident_roles": [ { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "incident_roles": { "example": [ { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/IncidentRoleV1" }, "type": "array" } }, "required": [ "incident_roles" ], "type": "object" }, "IncidentRolesListResultV2": { "example": { "incident_roles": [ { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "incident_roles": { "example": [ { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/IncidentRoleV2" }, "type": "array" } }, "required": [ "incident_roles" ], "type": "object" }, "IncidentRolesShowResultV1": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_role": { "$ref": "#/components/schemas/IncidentRoleV1" } }, "required": [ "incident_role" ], "type": "object" }, "IncidentRolesShowResultV2": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_role": { "$ref": "#/components/schemas/IncidentRoleV2" } }, "required": [ "incident_role" ], "type": "object" }, "IncidentRolesUpdatePayloadV1": { "example": { "description": "The person currently coordinating the incident", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "shortform": "lead" }, "properties": { "description": { "description": "Describes the purpose of the role", "example": "The person currently coordinating the incident", "minLength": 1, "type": "string" }, "instructions": { "description": "Provided to whoever is nominated for the role. Note that this will be empty for the 'reporter' role.", "example": "Take point on the incident; Make sure people are clear on responsibilities", "type": "string" }, "name": { "description": "Human readable name of the incident role", "example": "Incident Lead", "minLength": 1, "type": "string" }, "required": { "description": "DEPRECATED: this will always be false.", "example": false, "type": "boolean" }, "shortform": { "description": "Short human readable name for Slack. Note that this will be empty for the 'reporter' role.", "example": "lead", "type": "string" } }, "required": [ "name", "shortform", "description", "instructions" ], "type": "object" }, "IncidentRolesUpdatePayloadV2": { "example": { "description": "The person currently coordinating the incident", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "shortform": "lead" }, "properties": { "description": { "description": "Describes the purpose of the role", "example": "The person currently coordinating the incident", "minLength": 1, "type": "string" }, "instructions": { "description": "Provided to whoever is nominated for the role. Note that this will be empty for the 'reporter' role.", "example": "Take point on the incident; Make sure people are clear on responsibilities", "type": "string" }, "name": { "description": "Human readable name of the incident role", "example": "Incident Lead", "minLength": 1, "type": "string" }, "shortform": { "description": "Short human readable name for Slack. Note that this will be empty for the 'reporter' role.", "example": "lead", "type": "string" } }, "required": [ "name", "shortform", "description", "instructions" ], "type": "object" }, "IncidentRolesUpdateResultV1": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_role": { "$ref": "#/components/schemas/IncidentRoleV1" } }, "required": [ "incident_role" ], "type": "object" }, "IncidentRolesUpdateResultV2": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_role": { "$ref": "#/components/schemas/IncidentRoleV2" } }, "required": [ "incident_role" ], "type": "object" }, "IncidentSlimV2": { "description": "Incident slim is a subset of the full incident object, listing key fields.", "example": { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" }, "properties": { "external_id": { "description": "External identifier for the incident - often displayed with an INC- prefix", "example": 123, "format": "int64", "type": "integer" }, "id": { "description": "Unique identifier for the incident", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" }, "name": { "description": "Explanation of the incident", "example": "Our database is sad", "type": "string" }, "reference": { "description": "Reference to this incident, as displayed across the product", "example": "INC-123", "type": "string" }, "status_category": { "description": "The category of the incidents status", "enum": [ "triage", "declined", "merged", "canceled", "active", "post-incident", "closed", "paused" ], "example": "triage", "type": "string" }, "summary": { "description": "Detailed description of the incident", "example": "Our database is really really sad, and we don't know why yet.", "type": "string" }, "visibility": { "description": "Whether the incident should be open to anyone in your Slack workspace (public), or invite-only (private). For more information on Private Incidents see our [docs](https://docs.incident.io/incidents/sensitive-incidents).", "enum": [ "public", "private" ], "example": "public", "type": "string" } }, "required": [ "id", "external_id", "name", "reference", "visibility", "status_category" ], "type": "object" }, "IncidentStatusV1": { "example": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "category": { "description": "What category of status it is. All statuses apart from live (renamed in the app to Active) and learning (renamed in the app to Post-incident) are managed by incident.io and cannot be configured", "enum": [ "triage", "declined", "merged", "canceled", "live", "learning", "closed", "paused" ], "example": "triage", "type": "string" }, "created_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "Rich text description of the incident status", "example": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "type": "string" }, "id": { "description": "Unique ID of this incident status", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "name": { "description": "Unique name of this status", "example": "Closed", "type": "string" }, "rank": { "description": "Order of this incident status", "example": 4, "format": "int64", "type": "integer" }, "updated_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "description", "rank", "category", "created_at", "updated_at" ], "type": "object" }, "IncidentStatusV2": { "example": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "category": { "description": "What category of status it is. All statuses apart from live (renamed in the app to Active) and learning (renamed in the app to Post-incident) are managed by incident.io and cannot be configured", "enum": [ "triage", "declined", "merged", "canceled", "live", "learning", "closed", "paused" ], "example": "triage", "type": "string" }, "created_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "Rich text description of the incident status", "example": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "type": "string" }, "id": { "description": "Unique ID of this incident status", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "name": { "description": "Unique name of this status", "example": "Closed", "type": "string" }, "rank": { "description": "Order of this incident status", "example": 4, "format": "int64", "type": "integer" }, "updated_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "description", "rank", "category", "created_at", "updated_at" ], "type": "object" }, "IncidentStatusesCreatePayloadV1": { "example": { "category": "live", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "name": "Closed" }, "properties": { "category": { "description": "Whether the status should be considered 'live' (now renamed to active), 'learning' (now renamed to post-incident) or 'closed'. The triage and declined statuses cannot be created or modified.", "enum": [ "live", "learning", "closed" ], "example": "live", "type": "string" }, "description": { "description": "Rich text description of the incident status", "example": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "type": "string" }, "name": { "description": "Unique name of this status", "example": "Closed", "type": "string" } }, "required": [ "name", "description", "category" ], "type": "object" }, "IncidentStatusesCreateResultV1": { "example": { "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_status": { "$ref": "#/components/schemas/IncidentStatusV1" } }, "required": [ "incident_status" ], "type": "object" }, "IncidentStatusesListResultV1": { "example": { "incident_statuses": [ { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "incident_statuses": { "example": [ { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/IncidentStatusV1" }, "type": "array" } }, "required": [ "incident_statuses" ], "type": "object" }, "IncidentStatusesShowResultV1": { "example": { "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_status": { "$ref": "#/components/schemas/IncidentStatusV1" } }, "required": [ "incident_status" ], "type": "object" }, "IncidentStatusesUpdatePayloadV1": { "example": { "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "name": "Closed" }, "properties": { "description": { "description": "Rich text description of the incident status", "example": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "type": "string" }, "name": { "description": "Unique name of this status", "example": "Closed", "type": "string" } }, "required": [ "name", "description" ], "type": "object" }, "IncidentStatusesUpdateResultV1": { "example": { "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_status": { "$ref": "#/components/schemas/IncidentStatusV1" } }, "required": [ "incident_status" ], "type": "object" }, "IncidentTimestampV2": { "example": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "properties": { "id": { "description": "Unique ID of this incident timestamp", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "name": { "description": "Unique name of this timestamp", "example": "Impact started", "type": "string" }, "rank": { "description": "Order in which this timestamp should be shown", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "id", "name", "rank" ], "type": "object" }, "IncidentTimestampValuePayloadV2": { "example": { "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYD5H", "value": "2021-08-17T13:28:57.801578Z" }, "properties": { "incident_timestamp_id": { "description": "The id of the incident timestamp that this incident timestamp value is associated with.", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "value": { "description": "The current value of this timestamp, for this incident", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "incident_timestamp_id" ], "type": "object" }, "IncidentTimestampValueV1": { "example": { "last_occurred_at": "2021-08-17T13:28:57.801578Z", "name": "last_activity" }, "properties": { "last_occurred_at": { "description": "When this last occurred, if it did", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "name": { "description": "Name of the lifecycle event", "example": "last_activity", "type": "string" } }, "required": [ "name" ], "type": "object" }, "IncidentTimestampValueV2": { "example": { "value": "2021-08-17T13:28:57.801578Z" }, "properties": { "value": { "description": "The current value of this timestamp, for this incident", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "type": "object" }, "IncidentTimestampWithValueV2": { "example": { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "value": { "value": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_timestamp": { "$ref": "#/components/schemas/IncidentTimestampV2" }, "value": { "$ref": "#/components/schemas/IncidentTimestampValueV2" } }, "required": [ "incident_timestamp" ], "type": "object" }, "IncidentTimestampsListResultV2": { "example": { "incident_timestamps": [ { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 } ] }, "properties": { "incident_timestamps": { "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 } ], "items": { "$ref": "#/components/schemas/IncidentTimestampV2" }, "type": "array" } }, "required": [ "incident_timestamps" ], "type": "object" }, "IncidentTimestampsShowResultV2": { "example": { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 } }, "properties": { "incident_timestamp": { "$ref": "#/components/schemas/IncidentTimestampV2" } }, "required": [ "incident_timestamp" ], "type": "object" }, "IncidentTypeV1": { "example": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "create_in_triage": { "description": "Whether incidents of this must always, or can optionally, be created in triage", "enum": [ "always", "optional" ], "example": "always", "type": "string" }, "created_at": { "description": "When this resource was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "What is this incident type for?", "example": "Customer facing production outages", "type": "string" }, "id": { "description": "Unique identifier for this Incident Type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "is_default": { "description": "The default Incident Type is used when no other type is explicitly specified", "example": false, "type": "boolean" }, "name": { "description": "The name of this Incident Type", "example": "Production Outage", "type": "string" }, "private_incidents_only": { "description": "Should all incidents created with this Incident Type be private?", "example": false, "type": "boolean" }, "updated_at": { "description": "When this resource was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "is_default", "description", "private_incidents_only", "created_at", "updated_at", "create_in_triage" ], "type": "object" }, "IncidentTypeV2": { "example": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "create_in_triage": { "description": "Whether incidents of this must always, or can optionally, be created in triage", "enum": [ "always", "optional" ], "example": "always", "type": "string" }, "created_at": { "description": "When this resource was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "What is this incident type for?", "example": "Customer facing production outages", "type": "string" }, "id": { "description": "Unique identifier for this Incident Type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "is_default": { "description": "The default Incident Type is used when no other type is explicitly specified", "example": false, "type": "boolean" }, "name": { "description": "The name of this Incident Type", "example": "Production Outage", "type": "string" }, "private_incidents_only": { "description": "Should all incidents created with this Incident Type be private?", "example": false, "type": "boolean" }, "updated_at": { "description": "When this resource was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "is_default", "description", "private_incidents_only", "created_at", "updated_at", "create_in_triage" ], "type": "object" }, "IncidentTypesListResultV1": { "example": { "incident_types": [ { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "incident_types": { "example": [ { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/IncidentTypeV1" }, "type": "array" } }, "required": [ "incident_types" ], "type": "object" }, "IncidentTypesShowResultV1": { "example": { "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_type": { "$ref": "#/components/schemas/IncidentTypeV1" } }, "required": [ "incident_type" ], "type": "object" }, "IncidentUpdateV2": { "example": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merged_into_incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "message": "We're working on a fix, hoping to ship in the next 30 minutes", "new_incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "new_severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "properties": { "created_at": { "description": "When the update was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier for this incident update", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_id": { "description": "The incident this update relates to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "merged_into_incident_id": { "description": "The ID of the incident this incident was merged into, if the to state of this update is 'merged'.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "message": { "description": "Message that explains the context behind the update", "example": "We're working on a fix, hoping to ship in the next 30 minutes", "type": "string" }, "new_incident_status": { "$ref": "#/components/schemas/IncidentStatusV2" }, "new_severity": { "$ref": "#/components/schemas/SeverityV2" }, "updater": { "$ref": "#/components/schemas/ActorV2" } }, "required": [ "id", "incident_id", "new_incident_status", "updater", "created_at" ], "type": "object" }, "IncidentUpdatesListResultV2": { "example": { "incident_updates": [ { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merged_into_incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "message": "We're working on a fix, hoping to ship in the next 30 minutes", "new_incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "new_severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "incident_updates": { "example": [ { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merged_into_incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "message": "We're working on a fix, hoping to ship in the next 30 minutes", "new_incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "new_severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } } ], "items": { "$ref": "#/components/schemas/IncidentUpdateV2" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" } }, "required": [ "incident_updates" ], "type": "object" }, "IncidentV1": { "example": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "real", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "status": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "timestamps": [ { "last_occurred_at": "2021-08-17T13:28:57.801578Z", "name": "last_activity" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public" }, "properties": { "call_url": { "description": "The call URL attached to this incident", "example": "https://zoom.us/foo", "type": "string" }, "created_at": { "description": "When the incident was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "creator": { "$ref": "#/components/schemas/ActorV1" }, "custom_field_entries": { "description": "Custom field entries for this incident", "example": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "items": { "$ref": "#/components/schemas/CustomFieldEntryV1" }, "type": "array" }, "id": { "description": "Unique identifier for the incident", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" }, "incident_role_assignments": { "description": "A list of who is assigned to each role for this incident", "example": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "items": { "$ref": "#/components/schemas/IncidentRoleAssignmentV1" }, "type": "array" }, "incident_type": { "$ref": "#/components/schemas/IncidentTypeV1" }, "mode": { "description": "Whether the incident is real, a test, a tutorial, or importing as a retrospective incident", "enum": [ "real", "test", "tutorial" ], "example": "real", "type": "string" }, "name": { "description": "Explanation of the incident", "example": "Our database is sad", "type": "string" }, "permalink": { "description": "A permanent link to the homepage for this incident", "example": "https://app.incident.io/incidents/123", "type": "string" }, "postmortem_document_url": { "description": "The URL of the incident post-mortem document", "example": "https://docs.google.com/my_doc_id", "type": "string" }, "reference": { "description": "Reference to this incident, as displayed across the product", "example": "INC-123", "type": "string" }, "severity": { "$ref": "#/components/schemas/SeverityV1" }, "slack_channel_id": { "description": "ID of the Slack channel in the organisation Slack workspace. Note that the channel is sometimes created asynchronously, so may not be present when the incident is just created.", "example": "C02AW36C1M5", "type": "string" }, "slack_channel_name": { "description": "Name of the slack channel", "example": "inc-165-green-parrot", "type": "string" }, "slack_team_id": { "description": "ID of the Slack team / workspace. This is only required if you are using a Slack Enterprise Grid with multiple teams.", "example": "T02A1FSLE8J", "type": "string" }, "status": { "description": "Current status of the incident", "enum": [ "triage", "investigating", "fixing", "monitoring", "closed", "declined" ], "example": "triage", "type": "string" }, "summary": { "description": "Detailed description of the incident", "example": "Our database is really really sad, and we don't know why yet.", "type": "string" }, "timestamps": { "description": "Incident lifecycle events and when they last occurred", "example": [ { "last_occurred_at": "2021-08-17T13:28:57.801578Z", "name": "last_activity" } ], "items": { "$ref": "#/components/schemas/IncidentTimestampValueV1" }, "type": "array" }, "updated_at": { "description": "When the incident was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "visibility": { "description": "Whether the incident should be open to anyone in your Slack workspace (public), or invite-only (private). For more information on Private Incidents see our [docs](https://docs.incident.io/incidents/sensitive-incidents).", "enum": [ "public", "private" ], "example": "public", "type": "string" } }, "required": [ "status", "id", "reference", "name", "visibility", "mode", "creator", "incident_role_assignments", "custom_field_entries", "slack_team_id", "slack_channel_id", "created_at", "updated_at" ], "type": "object" }, "IncidentV2": { "example": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "value_seconds": 10800 } ], "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "has_debrief": false, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "incident_timestamp_values": [ { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "value": { "value": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "standard", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_ids": [ "01FCNDV6P870EA6S7TK1DSYD5H" ], "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 }, "properties": { "call_url": { "description": "The call URL attached to this incident", "example": "https://zoom.us/foo", "type": "string" }, "created_at": { "description": "When the incident was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "creator": { "$ref": "#/components/schemas/ActorV2" }, "custom_field_entries": { "description": "Custom field entries for this incident", "example": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "items": { "$ref": "#/components/schemas/CustomFieldEntryV2" }, "type": "array" }, "duration_metrics": { "description": "Incident duration metrics and their measurements for this incident", "example": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "value_seconds": 10800 } ], "items": { "$ref": "#/components/schemas/IncidentDurationMetricWithValueV2" }, "type": "array" }, "external_issue_reference": { "$ref": "#/components/schemas/ExternalIssueReferenceV2" }, "has_debrief": { "description": "If this incident has a debrief attached", "example": false, "type": "boolean" }, "id": { "description": "Unique identifier for the incident", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" }, "incident_role_assignments": { "description": "A list of who is assigned to each role for this incident", "example": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "items": { "$ref": "#/components/schemas/IncidentRoleAssignmentV2" }, "type": "array" }, "incident_status": { "$ref": "#/components/schemas/IncidentStatusV2" }, "incident_timestamp_values": { "description": "Incident lifecycle events and when they occurred", "example": [ { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "value": { "value": "2021-08-17T13:28:57.801578Z" } } ], "items": { "$ref": "#/components/schemas/IncidentTimestampWithValueV2" }, "type": "array" }, "incident_type": { "$ref": "#/components/schemas/IncidentTypeV2" }, "mode": { "description": "Whether the incident is real, a test, a tutorial, or importing as a retrospective incident", "enum": [ "standard", "retrospective", "test", "tutorial" ], "example": "standard", "type": "string" }, "name": { "description": "Explanation of the incident", "example": "Our database is sad", "type": "string" }, "permalink": { "description": "A permanent link to the homepage for this incident", "example": "https://app.incident.io/incidents/123", "type": "string" }, "postmortem_document_ids": { "description": "An array of IDs of postmortem documents for this incident", "example": [ "01FCNDV6P870EA6S7TK1DSYD5H" ], "items": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "type": "array" }, "postmortem_document_url": { "description": "The URL of the incident post-mortem document", "example": "https://docs.google.com/my_doc_id", "type": "string" }, "reference": { "description": "Reference to this incident, as displayed across the product", "example": "INC-123", "type": "string" }, "severity": { "$ref": "#/components/schemas/SeverityV2" }, "slack_channel_id": { "description": "ID of the Slack channel in the organisation Slack workspace. Note that the channel is sometimes created asynchronously, so may not be present when the incident is just created.", "example": "C02AW36C1M5", "type": "string" }, "slack_channel_name": { "description": "Name of the slack channel", "example": "inc-165-green-parrot", "type": "string" }, "slack_team_id": { "description": "ID of the Slack team / workspace. This is only required if you are using a Slack Enterprise Grid with multiple teams.", "example": "T02A1FSLE8J", "type": "string" }, "summary": { "description": "Detailed description of the incident", "example": "Our database is really really sad, and we don't know why yet.", "type": "string" }, "updated_at": { "description": "When the incident was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "visibility": { "description": "Whether the incident should be open to anyone in your Slack workspace (public), or invite-only (private). For more information on Private Incidents see our [docs](https://docs.incident.io/incidents/sensitive-incidents).", "enum": [ "public", "private" ], "example": "public", "type": "string" }, "workload_minutes_late": { "description": "Amount of time spent on the incident in late hours", "example": 40.7, "format": "double", "type": "number" }, "workload_minutes_sleeping": { "description": "Amount of time spent on the incident in sleeping hours", "example": 0, "format": "double", "type": "number" }, "workload_minutes_total": { "description": "Amount of time spent on the incident in total", "example": 60.7, "format": "double", "type": "number" }, "workload_minutes_working": { "description": "Amount of time spent on the incident in working hours", "example": 20, "format": "double", "type": "number" } }, "required": [ "incident_status", "id", "reference", "name", "visibility", "mode", "creator", "incident_role_assignments", "custom_field_entries", "slack_team_id", "slack_channel_id", "created_at", "updated_at" ], "type": "object" }, "IncidentWithStatusChangeV2": { "example": { "incident": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "value_seconds": 10800 } ], "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "has_debrief": false, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "incident_timestamp_values": [ { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "value": { "value": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "standard", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_ids": [ "01FCNDV6P870EA6S7TK1DSYD5H" ], "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 }, "message": "We're working on a fix, hoping to ship in the next 30 minutes", "new_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "previous_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident": { "$ref": "#/components/schemas/IncidentV2" }, "message": { "description": "Message that explains the context behind the update", "example": "We're working on a fix, hoping to ship in the next 30 minutes", "type": "string" }, "new_status": { "$ref": "#/components/schemas/IncidentStatusV2" }, "previous_status": { "$ref": "#/components/schemas/IncidentStatusV2" } }, "required": [ "incident", "previous_status", "new_status" ], "type": "object" }, "IncidentsCreatePayloadV1": { "example": { "custom_field_entries": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] } ], "idempotency_key": "alert-uuid", "incident_role_assignments": [ { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" } ], "incident_type_id": "01FH5TZRWMNAFB0DZ23FD1TV96", "mode": "real", "name": "Our database is sad", "severity_id": "01FH5TZRWMNAFB0DZ23FD1TV96", "slack_team_id": "T02A1FSLE8J", "source_message_channel_id": "C02AW36C1M5", "source_message_timestamp": "1653650280.526509", "status": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" }, "properties": { "custom_field_entries": { "description": "Set the incident's custom fields to these values", "example": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] } ], "items": { "$ref": "#/components/schemas/CustomFieldEntryPayloadV1" }, "type": "array" }, "idempotency_key": { "description": "Unique string used to de-duplicate incident create requests", "example": "alert-uuid", "type": "string" }, "incident_role_assignments": { "description": "Assign incident roles to these people", "example": [ { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" } ], "items": { "$ref": "#/components/schemas/IncidentRoleAssignmentPayloadV1" }, "type": "array" }, "incident_type_id": { "description": "Incident type to create this incident as", "example": "01FH5TZRWMNAFB0DZ23FD1TV96", "type": "string" }, "mode": { "description": "Whether the incident is real or test", "enum": [ "real", "test" ], "example": "real", "type": "string" }, "name": { "description": "Explanation of the incident", "example": "Our database is sad", "type": "string" }, "severity_id": { "description": "Severity to create incident as", "example": "01FH5TZRWMNAFB0DZ23FD1TV96", "type": "string" }, "slack_team_id": { "description": "ID of the Slack team / workspace. This is only required if you are using a Slack Enterprise Grid with multiple teams.", "example": "T02A1FSLE8J", "type": "string" }, "source_message_channel_id": { "description": "Channel ID of the source message, if this incident was created from one", "example": "C02AW36C1M5", "type": "string" }, "source_message_timestamp": { "description": "Timestamp of the source message, if this incident was created from one", "example": "1653650280.526509", "type": "string" }, "status": { "description": "Current status of the incident", "enum": [ "triage", "investigating", "fixing", "monitoring", "closed", "declined" ], "example": "triage", "type": "string" }, "summary": { "description": "Detailed description of the incident", "example": "Our database is really really sad, and we don't know why yet.", "type": "string" }, "visibility": { "description": "Whether the incident should be open to anyone in your Slack workspace (public), or invite-only (private). For more information on Private Incidents see our [docs](https://docs.incident.io/incidents/sensitive-incidents).", "enum": [ "public", "private" ], "example": "public", "type": "string" } }, "required": [ "idempotency_key", "visibility" ], "type": "object" }, "IncidentsCreatePayloadV2": { "example": { "custom_field_entries": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] } ], "idempotency_key": "alert-uuid", "incident_role_assignments": [ { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" } ], "incident_status_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "incident_timestamp_values": [ { "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYD5H", "value": "2021-08-17T13:28:57.801578Z" } ], "incident_type_id": "01FH5TZRWMNAFB0DZ23FD1TV96", "mode": "standard", "name": "Our database is sad", "retrospective_incident_options": { "external_id": 123, "postmortem_document_url": "https://docs.google.com/my_doc_id", "slack_channel_id": "abc123" }, "severity_id": "01FH5TZRWMNAFB0DZ23FD1TV96", "slack_channel_name_override": "inc-123-database-down", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" }, "properties": { "custom_field_entries": { "description": "Set the incident's custom fields to these values", "example": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] } ], "items": { "$ref": "#/components/schemas/CustomFieldEntryPayloadV2" }, "type": "array" }, "idempotency_key": { "description": "Unique string used to de-duplicate incident create requests", "example": "alert-uuid", "type": "string" }, "incident_role_assignments": { "description": "Assign incident roles to these people", "example": [ { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" } ], "items": { "$ref": "#/components/schemas/IncidentRoleAssignmentPayloadV2" }, "type": "array" }, "incident_status_id": { "description": "Incident status to assign to the incident", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "incident_timestamp_values": { "description": "Assign the incident's timestamps to these values", "example": [ { "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYD5H", "value": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/IncidentTimestampValuePayloadV2" }, "type": "array" }, "incident_type_id": { "description": "Incident type to create this incident as", "example": "01FH5TZRWMNAFB0DZ23FD1TV96", "type": "string" }, "mode": { "description": "Whether the incident is real, a test, a tutorial, or importing as a retrospective incident", "enum": [ "standard", "retrospective", "test", "tutorial" ], "example": "standard", "type": "string" }, "name": { "description": "Explanation of the incident", "example": "Our database is sad", "type": "string" }, "retrospective_incident_options": { "$ref": "#/components/schemas/RetrospectiveIncidentOptionsV2" }, "severity_id": { "description": "Severity to create incident as", "example": "01FH5TZRWMNAFB0DZ23FD1TV96", "type": "string" }, "slack_channel_name_override": { "description": "Name of the Slack channel to create for this incident", "example": "inc-123-database-down", "type": "string" }, "slack_team_id": { "description": "Slack Team to create the incident in", "example": "T02A1FSLE8J", "type": "string" }, "summary": { "description": "Detailed description of the incident", "example": "Our database is really really sad, and we don't know why yet.", "type": "string" }, "visibility": { "description": "Whether the incident should be open to anyone in your Slack workspace (public), or invite-only (private). For more information on Private Incidents see our [docs](https://docs.incident.io/incidents/sensitive-incidents).", "enum": [ "public", "private" ], "example": "public", "type": "string" } }, "required": [ "idempotency_key", "visibility" ], "type": "object" }, "IncidentsCreateResultV1": { "example": { "incident": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "real", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "status": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "timestamps": [ { "last_occurred_at": "2021-08-17T13:28:57.801578Z", "name": "last_activity" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public" } }, "properties": { "incident": { "$ref": "#/components/schemas/IncidentV1" } }, "required": [ "incident" ], "type": "object" }, "IncidentsCreateResultV2": { "example": { "incident": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "value_seconds": 10800 } ], "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "has_debrief": false, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "incident_timestamp_values": [ { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "value": { "value": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "standard", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_ids": [ "01FCNDV6P870EA6S7TK1DSYD5H" ], "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 } }, "properties": { "incident": { "$ref": "#/components/schemas/IncidentV2" } }, "required": [ "incident" ], "type": "object" }, "IncidentsEditPayloadV2": { "example": { "incident": { "call_url": "https://zoom.us/foo", "custom_field_entries": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] } ], "incident_role_assignments": [ { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" } ], "incident_status_id": "abc123", "incident_timestamp_values": [ { "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYD5H", "value": "2021-08-17T13:28:57.801578Z" } ], "name": "Our database is sad", "severity_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_channel_name_override": "inc-123-database-down", "summary": "Our database is really really sad, and we don't know why yet." }, "notify_incident_channel": true }, "properties": { "incident": { "$ref": "#/components/schemas/IncidentEditPayloadV2" }, "notify_incident_channel": { "description": "Should we send Slack channel notifications to inform responders of this update? Note that this won't work if the Slack channel has already been archived.", "example": true, "type": "boolean" } }, "required": [ "incident", "notify_incident_channel" ], "type": "object" }, "IncidentsEditResultV2": { "example": { "incident": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "value_seconds": 10800 } ], "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "has_debrief": false, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "incident_timestamp_values": [ { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "value": { "value": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "standard", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_ids": [ "01FCNDV6P870EA6S7TK1DSYD5H" ], "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 } }, "properties": { "incident": { "$ref": "#/components/schemas/IncidentV2" } }, "required": [ "incident" ], "type": "object" }, "IncidentsImportPostmortemDocumentPayloadV2": { "example": { "content": "## Summary\n\nA database migration caused increased latency...", "title": "INC-123: Post-incident review" }, "properties": { "content": { "description": "The document content as GitHub-Flavored Markdown", "example": "## Summary\n\nA database migration caused increased latency...", "type": "string" }, "title": { "description": "Title of the postmortem document", "example": "INC-123: Post-incident review", "type": "string" } }, "required": [ "title", "content" ], "type": "object" }, "IncidentsImportPostmortemDocumentResultV2": { "example": { "postmortem_document": { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" } }, "properties": { "postmortem_document": { "$ref": "#/components/schemas/PostmortemDocumentV1" } }, "required": [ "postmortem_document" ], "type": "object" }, "IncidentsListResultV1": { "example": { "incidents": [ { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "real", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "status": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "timestamps": [ { "last_occurred_at": "2021-08-17T13:28:57.801578Z", "name": "last_activity" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 } }, "properties": { "incidents": { "example": [ { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "real", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "status": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "timestamps": [ { "last_occurred_at": "2021-08-17T13:28:57.801578Z", "name": "last_activity" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public" } ], "items": { "$ref": "#/components/schemas/IncidentV1" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultWithTotalV1" } }, "required": [ "incidents" ], "type": "object" }, "IncidentsListResultV2": { "example": { "incidents": [ { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "value_seconds": 10800 } ], "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "has_debrief": false, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "incident_timestamp_values": [ { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "value": { "value": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "standard", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_ids": [ "01FCNDV6P870EA6S7TK1DSYD5H" ], "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 } }, "properties": { "incidents": { "example": [ { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "value_seconds": 10800 } ], "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "has_debrief": false, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "incident_timestamp_values": [ { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "value": { "value": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "standard", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_ids": [ "01FCNDV6P870EA6S7TK1DSYD5H" ], "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 } ], "items": { "$ref": "#/components/schemas/IncidentV2" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultWithTotalV2" } }, "required": [ "incidents" ], "type": "object" }, "IncidentsShowResultV1": { "example": { "incident": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "real", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "status": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "timestamps": [ { "last_occurred_at": "2021-08-17T13:28:57.801578Z", "name": "last_activity" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public" } }, "properties": { "incident": { "$ref": "#/components/schemas/IncidentV1" } }, "required": [ "incident" ], "type": "object" }, "IncidentsShowResultV2": { "example": { "incident": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "value_seconds": 10800 } ], "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "has_debrief": false, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "incident_timestamp_values": [ { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "value": { "value": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "standard", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_ids": [ "01FCNDV6P870EA6S7TK1DSYD5H" ], "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 } }, "properties": { "incident": { "$ref": "#/components/schemas/IncidentV2" } }, "required": [ "incident" ], "type": "object" }, "MaintenanceWindowEscalationTargetPayloadV1": { "example": { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "escalation_paths": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "users": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" } }, "type": "object" }, "MaintenanceWindowEscalationTargetV1": { "example": { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "escalation_paths": { "$ref": "#/components/schemas/EngineParamBindingV2" }, "users": { "$ref": "#/components/schemas/EngineParamBindingV2" } }, "type": "object" }, "MaintenanceWindowNotifyChannelPayloadV1": { "description": "A channel to receive notifications about this maintenance window", "example": { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public" }, "properties": { "channel_id": { "description": "The external provider channel ID (e.g. Slack channel ID)", "example": "C0ACTHQMHS8", "type": "string" }, "channel_name": { "description": "Human readable name of the channel", "example": "general", "type": "string" }, "channel_type": { "description": "The type of channel (e.g. public, private)", "example": "public", "type": "string" } }, "required": [ "channel_id", "channel_type" ], "type": "object" }, "MaintenanceWindowNotifyChannelV1": { "description": "A channel that will receive notifications about this maintenance window", "example": { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false }, "properties": { "channel_id": { "description": "The external provider channel ID (e.g. Slack channel ID)", "example": "C0ACTHQMHS8", "type": "string" }, "channel_name": { "description": "Human readable name of the channel", "example": "general", "type": "string" }, "channel_type": { "description": "The type of channel (e.g. public, private)", "example": "public", "type": "string" }, "is_private": { "description": "Whether the channel is private", "example": false, "type": "boolean" } }, "required": [ "channel_id", "channel_type" ], "type": "object" }, "MaintenanceWindowV1": { "example": { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "alert_condition_groups": { "description": "Condition groups that determine which alerts this maintenance window applies to", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV2" }, "type": "array" }, "archived_at": { "description": "When this maintenance window was archived, if it has been", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "created_at": { "description": "When this maintenance window was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "end_at": { "description": "When the maintenance window ends", "example": "2021-08-17T14:28:57.801578Z", "format": "date-time", "type": "string" }, "escalation_targets": { "description": "If set, alerts matching this window will be escalated to these targets", "example": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/MaintenanceWindowEscalationTargetV1" }, "type": "array" }, "id": { "description": "Unique identifier for this maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_id": { "description": "If set, alerts matching this window will be automatically attached to this incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "lead": { "$ref": "#/components/schemas/ActorV2" }, "name": { "description": "Human readable name for the maintenance window", "example": "Planned database migration", "type": "string" }, "notification_message": { "description": "Custom message included in notifications about this maintenance window", "example": "Scheduled downtime for database migration", "type": "string" }, "notify_channels": { "description": "Channels to notify about the maintenance window starting and ending", "example": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "items": { "$ref": "#/components/schemas/MaintenanceWindowNotifyChannelV1" }, "type": "array" }, "notify_end_minutes_before": { "description": "Minutes before the end to send a notification to the configured channels", "example": 5, "format": "int64", "type": "integer" }, "notify_start_minutes_before": { "description": "Minutes before the start to send a notification to the configured channels", "example": 15, "format": "int64", "type": "integer" }, "reroute_on_end": { "description": "Whether to retrigger firing alerts through alert routing when the window ends", "example": false, "type": "boolean" }, "resolve_on_end": { "description": "Whether to automatically resolve all firing alerts that matched this window when it ends", "example": false, "type": "boolean" }, "show_in_sidebar": { "description": "Whether to show this maintenance window in the dashboard sidebar when active", "example": true, "type": "boolean" }, "start_at": { "description": "When the maintenance window starts", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "updated_at": { "description": "When this maintenance window was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "lead", "start_at", "end_at", "alert_condition_groups", "resolve_on_end", "reroute_on_end", "show_in_sidebar", "created_at", "updated_at" ], "type": "object" }, "MaintenanceWindowsCreatePayloadV1": { "example": { "alert_condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public" } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "alert_condition_groups": { "description": "Condition groups that determine which alerts this maintenance window applies to", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" }, "end_at": { "description": "When the maintenance window should end", "example": "2021-08-17T14:28:57.801578Z", "format": "date-time", "type": "string" }, "escalation_targets": { "description": "If set, alerts matching this window will be escalated to these targets", "example": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/MaintenanceWindowEscalationTargetPayloadV1" }, "type": "array" }, "incident_id": { "description": "If set, alerts matching this window will be automatically attached to this incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "lead": { "$ref": "#/components/schemas/UserReferencePayloadV2" }, "name": { "description": "Human readable name for the maintenance window", "example": "Planned database migration", "type": "string" }, "notification_message": { "description": "Custom message included in notifications about this maintenance window", "example": "Scheduled downtime for database migration", "type": "string" }, "notify_channels": { "description": "Channels to notify about the maintenance window starting and ending", "example": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public" } ], "items": { "$ref": "#/components/schemas/MaintenanceWindowNotifyChannelPayloadV1" }, "type": "array" }, "notify_end_minutes_before": { "description": "Minutes before the end to send a notification to the configured channels", "example": 5, "format": "int64", "type": "integer" }, "notify_start_minutes_before": { "description": "Minutes before the start to send a notification to the configured channels", "example": 15, "format": "int64", "type": "integer" }, "reroute_on_end": { "description": "Whether to retrigger firing alerts through alert routing when the window ends", "example": false, "type": "boolean" }, "resolve_on_end": { "description": "Whether to automatically resolve all firing alerts that matched this window when it ends", "example": false, "type": "boolean" }, "show_in_sidebar": { "description": "Whether to show this maintenance window in the dashboard sidebar when active", "example": true, "type": "boolean" }, "start_at": { "description": "When the maintenance window should start", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "name", "lead", "start_at", "end_at", "alert_condition_groups", "show_in_sidebar" ], "type": "object" }, "MaintenanceWindowsCreateResultV1": { "example": { "maintenance_window": { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "maintenance_window": { "$ref": "#/components/schemas/MaintenanceWindowV1" } }, "required": [ "maintenance_window" ], "type": "object" }, "MaintenanceWindowsListResultV1": { "example": { "maintenance_windows": [ { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "maintenance_windows": { "example": [ { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/MaintenanceWindowV1" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV1" } }, "required": [ "maintenance_windows", "pagination_meta" ], "type": "object" }, "MaintenanceWindowsShowResultV1": { "example": { "maintenance_window": { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "maintenance_window": { "$ref": "#/components/schemas/MaintenanceWindowV1" } }, "required": [ "maintenance_window" ], "type": "object" }, "MaintenanceWindowsUpdatePayloadV1": { "example": { "alert_condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public" } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "alert_condition_groups": { "description": "Condition groups that determine which alerts this maintenance window applies to", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" }, "end_at": { "description": "When the maintenance window should end", "example": "2021-08-17T14:28:57.801578Z", "format": "date-time", "type": "string" }, "escalation_targets": { "description": "If set, alerts matching this window will be escalated to these targets", "example": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/MaintenanceWindowEscalationTargetPayloadV1" }, "type": "array" }, "incident_id": { "description": "If set, alerts matching this window will be automatically attached to this incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "lead": { "$ref": "#/components/schemas/UserReferencePayloadV2" }, "name": { "description": "Human readable name for the maintenance window", "example": "Planned database migration", "type": "string" }, "notification_message": { "description": "Custom message included in notifications about this maintenance window", "example": "Scheduled downtime for database migration", "type": "string" }, "notify_channels": { "description": "Channels to notify about the maintenance window starting and ending", "example": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public" } ], "items": { "$ref": "#/components/schemas/MaintenanceWindowNotifyChannelPayloadV1" }, "type": "array" }, "notify_end_minutes_before": { "description": "Minutes before the end to send a notification to the configured channels", "example": 5, "format": "int64", "type": "integer" }, "notify_start_minutes_before": { "description": "Minutes before the start to send a notification to the configured channels", "example": 15, "format": "int64", "type": "integer" }, "reroute_on_end": { "description": "Whether to retrigger firing alerts through alert routing when the window ends", "example": false, "type": "boolean" }, "resolve_on_end": { "description": "Whether to automatically resolve all firing alerts that matched this window when it ends", "example": false, "type": "boolean" }, "show_in_sidebar": { "description": "Whether to show this maintenance window in the dashboard sidebar when active", "example": true, "type": "boolean" }, "start_at": { "description": "When the maintenance window should start", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "name", "lead", "start_at", "end_at", "alert_condition_groups", "show_in_sidebar" ], "type": "object" }, "MaintenanceWindowsUpdateResultV1": { "example": { "maintenance_window": { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "maintenance_window": { "$ref": "#/components/schemas/MaintenanceWindowV1" } }, "required": [ "maintenance_window" ], "type": "object" }, "ManagementMetaV2": { "example": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "managed_by": "dashboard", "source_url": "https://github.com/my-company/infrastructure" }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that track metadata about this resource", "example": { "incident.io/terraform/version": "3.0.0" }, "type": "object" }, "managed_by": { "description": "How is this resource managed", "enum": [ "dashboard", "terraform", "external" ], "example": "dashboard", "type": "string" }, "source_url": { "description": "The url of the external repository where this resource is managed (if there is one)", "example": "https://github.com/my-company/infrastructure", "type": "string" } }, "required": [ "annotations", "managed_by" ], "type": "object" }, "OnCallNotificationMethodPublicV2": { "example": { "address": "•••••••6789", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_usable": true, "method_type": "app" }, "properties": { "address": { "description": "The address of this method (e.g. redacted phone number, email address, device name, Slack user name)", "example": "•••••••6789", "type": "string" }, "id": { "description": "Unique identifier for this notification method", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "is_usable": { "description": "Whether this method is ready to receive notifications. For phone, this means verified. For app devices, this means push notifications can be sent. For email, Slack, and Microsoft Teams this is always true.", "example": true, "type": "boolean" }, "method_type": { "description": "The type of notification method. Phone methods do not differentiate between voice call and SMS.", "enum": [ "app", "email", "microsoft_teams", "phone", "slack" ], "example": "app", "type": "string", "x-public-api-version": "v2" } }, "required": [ "id", "method_type", "is_usable", "address" ], "type": "object" }, "OnCallNotificationRuleAppDetailsPublicV2": { "example": { "push_notification_criticality": "critical" }, "properties": { "push_notification_criticality": { "description": "Controls the interruption level of push notifications. 'critical' bypasses Do Not Disturb, 'active' respects it.", "enum": [ "critical", "active" ], "example": "critical", "type": "string", "x-public-api-version": "v2" } }, "required": [ "push_notification_criticality" ], "type": "object" }, "OnCallNotificationRuleMethodTargetAllPublicV2": { "example": {}, "type": "object" }, "OnCallNotificationRuleMethodTargetPublicV2": { "example": { "all": {}, "specific": { "id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "specific" }, "properties": { "all": { "$ref": "#/components/schemas/OnCallNotificationRuleMethodTargetAllPublicV2" }, "specific": { "$ref": "#/components/schemas/OnCallNotificationRuleMethodTargetSpecificPublicV2" }, "type": { "description": "Whether this targets a specific method or all methods of a given type.", "enum": [ "specific", "all" ], "example": "specific", "type": "string" } }, "required": [ "type" ], "type": "object" }, "OnCallNotificationRuleMethodTargetSpecificPublicV2": { "example": { "id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "id": { "description": "The ID of the notification method. References a method from the notification methods list.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "id" ], "type": "object" }, "OnCallNotificationRulePublicV2": { "example": { "app": { "push_notification_criticality": "critical" }, "delay_seconds": 0, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "method_target": { "all": {}, "specific": { "id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "specific" }, "method_type": "app", "rule_type": "low_urgency" }, "properties": { "app": { "$ref": "#/components/schemas/OnCallNotificationRuleAppDetailsPublicV2" }, "delay_seconds": { "description": "Delay in seconds before this rule activates. 0 means immediate.", "example": 0, "format": "int64", "maximum": 1200, "minimum": 0, "type": "integer" }, "id": { "description": "Unique identifier for this notification rule", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "method_target": { "$ref": "#/components/schemas/OnCallNotificationRuleMethodTargetPublicV2" }, "method_type": { "description": "The type of notification method. Phone methods do not differentiate between voice call and SMS.", "enum": [ "app", "email", "microsoft_teams", "phone", "slack" ], "example": "app", "type": "string", "x-public-api-version": "v2" }, "rule_type": { "description": "The urgency level this rule applies to", "enum": [ "high_urgency", "low_urgency" ], "example": "low_urgency", "type": "string", "x-public-api-version": "v2" } }, "required": [ "id", "method_type", "method_target", "rule_type" ], "type": "object" }, "PaginationMetaResultV1": { "example": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "properties": { "after": { "description": "If provided, pass this as the 'after' param to load the next page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "page_size": { "default": 25, "description": "What was the maximum number of results requested", "example": 25, "format": "int64", "maximum": 250, "type": "integer" } }, "required": [ "page_size" ], "type": "object" }, "PaginationMetaResultV2": { "example": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "properties": { "after": { "description": "If provided, pass this as the 'after' param to load the next page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "page_size": { "default": 25, "description": "What was the maximum number of results requested", "example": 25, "format": "int64", "maximum": 250, "type": "integer" } }, "required": [ "page_size" ], "type": "object" }, "PaginationMetaResultV3": { "example": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "properties": { "after": { "description": "If provided, pass this as the 'after' param to load the next page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "page_size": { "default": 25, "description": "What was the maximum number of results requested", "example": 25, "format": "int64", "maximum": 250, "type": "integer" } }, "required": [ "page_size" ], "type": "object" }, "PaginationMetaResultWithTotalV1": { "example": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 }, "properties": { "after": { "description": "If provided, pass this as the 'after' param to load the next page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "page_size": { "default": 25, "description": "What was the maximum number of results requested", "example": 25, "format": "int64", "maximum": 250, "type": "integer" }, "total_record_count": { "description": "How many matching records were there in total, if known", "example": 238, "format": "int64", "type": "integer" } }, "required": [ "page_size" ], "type": "object" }, "PaginationMetaResultWithTotalV2": { "example": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 }, "properties": { "after": { "description": "If provided, pass this as the 'after' param to load the next page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "page_size": { "default": 25, "description": "What was the maximum number of results requested", "example": 25, "format": "int64", "maximum": 250, "type": "integer" }, "total_record_count": { "description": "How many matching records were there in total, if known", "example": 238, "format": "int64", "type": "integer" } }, "required": [ "page_size" ], "type": "object" }, "PaginationMetaResultWithTotalV3": { "example": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 }, "properties": { "after": { "description": "If provided, pass this as the 'after' param to load the next page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "page_size": { "default": 25, "description": "What was the maximum number of results requested", "example": 25, "format": "int64", "maximum": 250, "type": "integer" }, "total_record_count": { "description": "How many matching records were there in total, if known", "example": 238, "format": "int64", "type": "integer" } }, "required": [ "page_size" ], "type": "object" }, "PartialEntryPayloadV3": { "description": "Represents a partial entry update, allowing selective field updates", "example": { "aliases": [ "abc123" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "entry_id": "abc123", "external_id": "abc123", "name": "abc123", "rank": 1 }, "properties": { "aliases": { "description": "If specified, will update the aliases of the entry. When omitted, preserves the existing aliases.", "example": [ "abc123" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "attribute_values": { "additionalProperties": { "$ref": "#/components/schemas/CatalogEngineParamBindingPayloadV3" }, "description": "The attribute values to apply to this entry", "example": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "type": "object" }, "entry_id": { "description": "ID of the relevant catalog entry", "example": "abc123", "type": "string" }, "external_id": { "description": "If specified, will update the external ID of the entry. When omitted, preserves the existing external ID.", "example": "abc123", "type": "string" }, "name": { "description": "If specified, will update the name of the entry. When omitted, preserves the existing name.", "example": "abc123", "type": "string" }, "rank": { "description": "If specified, will update the rank of the entry. When omitted, rank will be set to null (allowing rank removal).", "example": 1, "format": "int32", "type": "integer" } }, "required": [ "entry_id", "attribute_values" ], "type": "object" }, "PostmortemDocumentV1": { "example": { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" }, "properties": { "created_at": { "description": "Timestamp for when the document was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "document_url": { "description": "A URL to view the post-mortem document in the incident.io dashboard", "example": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "type": "string" }, "editors": { "description": "The list of users who have edited this post-mortem document", "example": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "items": { "$ref": "#/components/schemas/UserV1" }, "type": "array" }, "exported_urls": { "description": "URLs of any external locations this document has been exported to", "example": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "id": { "description": "Unique identifier for the post-mortem document", "example": "01GDZEW57FDA1K4S63MGMQ5DS9", "type": "string" }, "incident_id": { "description": "The unique identifier of the incident that this post-mortem document belongs to", "example": "01GBA8J19SMXQWPJMX3P2ESCVG", "type": "string" }, "status": { "description": "The current status of this post-mortem document", "enum": [ "in_progress", "in_review", "completed" ], "example": "in_progress", "type": "string" }, "title": { "description": "The display title of the post-mortem document", "example": "INC-123: Database is sad", "type": "string" }, "type": { "description": "Whether this is a native incident.io post-mortem or one hosted in an external provider", "enum": [ "in_app", "external" ], "example": "in_app", "type": "string" }, "updated_at": { "description": "Timestamp for when the document was last updated", "example": "abc123", "type": "string" } }, "required": [ "id", "incident_id", "title", "status", "created_at", "updated_at", "document_url", "exported_urls", "editors", "type" ], "type": "object" }, "PostmortemDocumentWithStatusChangeV1": { "example": { "new_status": "complete", "postmortem_document": { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" }, "previous_status": "review" }, "properties": { "new_status": { "description": "The newly assigned status of the postmortem document", "enum": [ "not_started", "created", "review", "complete" ], "example": "complete", "type": "string" }, "postmortem_document": { "$ref": "#/components/schemas/PostmortemDocumentV1" }, "previous_status": { "description": "The previous status of this postmortem document", "enum": [ "not_started", "created", "review", "complete" ], "example": "review", "type": "string" } }, "required": [ "postmortem_document", "previous_status", "new_status" ], "type": "object" }, "PostmortemDocumentsListResultV1": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "postmortem_documents": [ { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" } ] }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV1" }, "postmortem_documents": { "example": [ { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" } ], "items": { "$ref": "#/components/schemas/PostmortemDocumentV1" }, "type": "array" } }, "required": [ "postmortem_documents", "pagination_meta" ], "type": "object" }, "PostmortemDocumentsShowContentResultV1": { "example": { "markdown": "# Incident Postmortem\n\n## Summary\n\nThis incident was investigated by Alice Smith and affected the API Gateway service.\n\n## Timeline\n\n### 2024-06-15 (UTC)\n\n* [10:30] **Alert fired**\n\n* [10:35] **Incident declared**\n\n## Follow-ups\n\n* **Add monitoring** - Assignee: Alice Smith\n" }, "properties": { "markdown": { "description": "The full content of the post-mortem document, rendered as markdown. Includes all sections, resolved mentions, timeline, follow-ups, and custom fields.", "example": "# Incident Postmortem\n\n## Summary\n\nThis incident was investigated by Alice Smith and affected the API Gateway service.\n\n## Timeline\n\n### 2024-06-15 (UTC)\n\n* [10:30] **Alert fired**\n\n* [10:35] **Incident declared**\n\n## Follow-ups\n\n* **Add monitoring** - Assignee: Alice Smith\n", "type": "string" } }, "required": [ "markdown" ], "type": "object" }, "PostmortemDocumentsShowResultV1": { "example": { "postmortem_document": { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" } }, "properties": { "postmortem_document": { "$ref": "#/components/schemas/PostmortemDocumentV1" } }, "required": [ "postmortem_document" ], "type": "object" }, "PostmortemDocumentsUpdateStatusPayloadV1": { "example": { "status": "completed" }, "properties": { "status": { "description": "The new status to set the post-mortem document to", "enum": [ "in_progress", "in_review", "completed" ], "example": "completed", "type": "string" } }, "required": [ "status" ], "type": "object" }, "PostmortemDocumentsUpdateStatusResultV1": { "example": { "postmortem_document": { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" } }, "properties": { "postmortem_document": { "$ref": "#/components/schemas/PostmortemDocumentV1" } }, "required": [ "postmortem_document" ], "type": "object" }, "RBACRoleV2": { "example": { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" }, "properties": { "description": { "description": "Description of the purpose for the RBAC role", "example": "Elevated permissions for the customer success team.", "type": "string" }, "id": { "description": "Unique identifier of the RBAC role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Name of the RBAC role", "example": "Customer Success", "type": "string" }, "slug": { "description": "Unique human-readable slug for the RBAC role", "example": "customer-success", "type": "string" } }, "required": [ "id", "name", "slug" ], "type": "object" }, "RetrospectiveIncidentOptionsV2": { "example": { "external_id": 123, "postmortem_document_url": "https://docs.google.com/my_doc_id", "slack_channel_id": "abc123" }, "properties": { "external_id": { "description": "The external ID (e.g. the 123 in INC-123) to assign to the incident. This can be useful when importing incidents. If you want to use this field, you'll need to talk to us first.", "example": 123, "format": "int64", "type": "integer" }, "postmortem_document_url": { "description": "The URL of the postmortem, if there is one", "example": "https://docs.google.com/my_doc_id", "type": "string" }, "slack_channel_id": { "description": "Pass the ID of a Slack channel to attach the incident to an existing channel, rather than creating a new one", "example": "abc123", "type": "string" } }, "type": "object" }, "ReturnsMetaV2": { "example": { "array": true, "type": "IncidentStatus" }, "properties": { "array": { "description": "Whether the return value should be single or multi-value", "example": true, "type": "boolean" }, "type": { "description": "Expected return type of this expression (what to try casting the result to)", "example": "IncidentStatus", "type": "string" } }, "required": [ "type", "array" ], "type": "object" }, "ScheduleConfigCreatePayloadV2": { "example": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "properties": { "rotations": { "example": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ], "items": { "$ref": "#/components/schemas/ScheduleRotationCreatePayloadV2" }, "type": "array" } }, "type": "object" }, "ScheduleConfigUpdatePayloadV2": { "example": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "properties": { "rotations": { "example": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ], "items": { "$ref": "#/components/schemas/ScheduleRotationUpdatePayloadV2" }, "type": "array" } }, "type": "object" }, "ScheduleConfigV2": { "example": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "properties": { "rotations": { "description": "Rotas in this schedule", "example": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ], "items": { "$ref": "#/components/schemas/ScheduleRotationV2" }, "type": "array" } }, "required": [ "rotations" ], "type": "object" }, "ScheduleCreatePayloadV2": { "example": { "annotations": { "incident.io/terraform/version": "version-of-terraform" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "holidays_public_config": { "country_codes": [ "abc123" ] }, "name": "Primary On-call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "America/Los_Angeles" }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that can track metadata about the schedule", "example": { "incident.io/terraform/version": "version-of-terraform" }, "type": "object" }, "config": { "$ref": "#/components/schemas/ScheduleConfigCreatePayloadV2" }, "holidays_public_config": { "$ref": "#/components/schemas/ScheduleHolidaysPublicConfigPayloadV2" }, "name": { "description": "Name of the schedule", "example": "Primary On-call Schedule", "type": "string" }, "team_ids": { "description": "IDs of teams that own this schedule", "example": [ "01JPQA75EPNEES4479P16P4XAB" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "timezone": { "description": "Timezone of the schedule", "example": "America/Los_Angeles", "type": "string" } }, "type": "object" }, "ScheduleEntriesListPayloadV2": { "example": { "final": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "overrides": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "scheduled": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ] }, "properties": { "final": { "example": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "items": { "$ref": "#/components/schemas/ScheduleEntryV2" }, "type": "array" }, "overrides": { "example": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "items": { "$ref": "#/components/schemas/ScheduleEntryV2" }, "type": "array" }, "scheduled": { "example": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "items": { "$ref": "#/components/schemas/ScheduleEntryV2" }, "type": "array" } }, "required": [ "scheduled", "overrides", "final" ], "type": "object" }, "ScheduleEntryV2": { "example": { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } }, "properties": { "end_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "entry_id": { "description": "Unique identifier of the schedule entry", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "fingerprint": { "description": "A unique identifier for this entry, used to determine a unique shift", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "layer_id": { "description": "If present, the layer this entry applies to on the rota", "example": "01G0J1EXE7AXZ2C93K61WBPYNH", "type": "string" }, "rotation_id": { "description": "If present, the rotation this entry applies to on the schedule", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "start_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "user": { "$ref": "#/components/schemas/UserV2" } }, "required": [ "start_at", "end_at" ], "type": "object" }, "ScheduleHolidaysPublicConfigPayloadV2": { "example": { "country_codes": [ "abc123" ] }, "properties": { "country_codes": { "description": "ISO 3166-1 alpha-2 country codes for the countries that this schedule is configured to view holidays for", "example": [ "abc123" ], "items": { "example": "abc123", "type": "string" }, "type": "array" } }, "required": [ "country_codes" ], "type": "object" }, "ScheduleHolidaysPublicConfigV2": { "example": { "country_codes": [ "GB", "FR" ] }, "properties": { "country_codes": { "description": "ISO 3166-1 alpha-2 country codes for the countries that this schedule is configured to view holidays for", "example": [ "GB", "FR" ], "items": { "example": "abc123", "type": "string" }, "type": "array" } }, "required": [ "country_codes" ], "type": "object" }, "ScheduleLayerCreatePayloadV2": { "example": { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" }, "properties": { "id": { "description": "Unique identifier of the layer", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "name": { "description": "Name of the layer", "example": "Layer 1", "type": "string" } }, "required": [ "name" ], "type": "object" }, "ScheduleLayerUpdatePayloadV2": { "example": { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" }, "properties": { "id": { "description": "Unique identifier of the layer", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "name": { "description": "Name of the layer", "example": "Layer 1", "type": "string" } }, "type": "object" }, "ScheduleLayerV2": { "example": { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" }, "properties": { "id": { "description": "Unique identifier of the layer", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "name": { "description": "Name of the layer", "example": "Layer 1", "type": "string" } }, "type": "object" }, "ScheduleOverrideV2": { "example": { "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "schedule_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } }, "properties": { "created_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "end_at": { "description": "End of the override", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "id": { "description": "Unique internal ID of the schedule override", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "layer_id": { "description": "The layer on the rotation on the schedule that this override applies to", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "rotation_id": { "description": "The rotation on the schedule that this override applies to", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "schedule_id": { "description": "The schedule that this override applies to", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "start_at": { "description": "Start of the override", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "updated_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "user": { "$ref": "#/components/schemas/UserV2" } }, "required": [ "id", "schedule_id", "rotation_id", "layer_id", "start_at", "end_at", "created_at", "updated_at" ], "type": "object" }, "ScheduleReplicaCreatePayloadV2": { "example": { "mirror_window_days": 14, "replica_fallback_user_id": "PA7AXXN", "replica_provider": "pagerduty", "replica_provider_id": "PO8107X", "sources": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ] }, "properties": { "mirror_window_days": { "description": "How many days ahead to mirror this schedule into the external provider. Defaults to 14 if not set; maximum 90.", "example": 14, "format": "int64", "maximum": 90, "minimum": 1, "type": "integer" }, "replica_fallback_user_id": { "description": "The ID of a user in the external provider that will be assigned whenever nobody is on-call in the incident.io schedule. External providers typically require someone to always be on-call, so this user fills gaps where incident.io has no one scheduled.", "example": "PA7AXXN", "type": "string" }, "replica_provider": { "description": "The external provider where this schedule is replicated to", "enum": [ "native", "pagerduty", "opsgenie", "jira" ], "example": "pagerduty", "type": "string" }, "replica_provider_id": { "description": "The ID of the schedule in the external provider that this replica syncs to. For PagerDuty this is the schedule ID (e.g. PO8107X), for Opsgenie the schedule ID, and for Jira Service Management the schedule ID.", "example": "PO8107X", "type": "string" }, "sources": { "description": "The specific rotation and layer combinations from the schedule to replicate. Each source identifies a single layer within a rotation to sync to the external provider.", "example": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ], "items": { "$ref": "#/components/schemas/ScheduleReplicaSourceV2" }, "type": "array" } }, "required": [ "sources", "replica_provider", "replica_provider_id", "replica_fallback_user_id" ], "type": "object" }, "ScheduleReplicaSourceV2": { "example": { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" }, "properties": { "layer_id": { "description": "The ID of the layer within the rotation to replicate. Rotations can have multiple layers that stack on top of each other, and you must specify which layer to replicate.", "example": "01G0J1EXE7AXZ2C93K61WBPYNH", "type": "string" }, "rotation_id": { "description": "The ID of the rotation within the schedule to replicate. Each schedule can have multiple rotations, and you can choose which ones to include in the replica.", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } }, "required": [ "rotation_id", "layer_id" ], "type": "object" }, "ScheduleReplicaUserStatusV2": { "example": { "external_user_id": "PJYTRGS", "user_id": "01G0J1EXE7AXZ2C93K61WBPYEH" }, "properties": { "external_user_id": { "description": "The corresponding user ID in the external provider (e.g. a PagerDuty user ID). If set, the user has been successfully mapped to an external user and will be included in the replica. If null, the user could not be resolved and syncing may produce errors.", "example": "PJYTRGS", "type": "string" }, "user_id": { "description": "The incident.io user ID for a user who appears in the schedule rotation.", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } }, "required": [ "user_id" ], "type": "object" }, "ScheduleReplicaV2": { "example": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_sync_error": "Failed to find external user for Milly", "last_synced_at": "2023-11-07T13:33:30Z", "mirror_window_days": 14, "replica_fallback_user_id": "PA7AXXN", "replica_provider": "pagerduty", "replica_provider_id": "PO8107X", "schedule_id": "01FDAG4SAP5TYPT98WGR2N7W91", "sources": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "user_statuses": [ { "external_user_id": "PJYTRGS", "user_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ] }, "properties": { "created_at": { "description": "When this schedule replica was first created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the schedule replica", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "last_sync_error": { "description": "The most recent error encountered while syncing this replica to the external provider, if any. Common errors include unmapped users or connectivity issues with the external provider. Null if the last sync was successful.", "example": "Failed to find external user for Milly", "type": "string" }, "last_synced_at": { "description": "When the replica was last successfully synced to the external provider. Null if the replica has never been successfully synced.", "example": "2023-11-07T13:33:30Z", "format": "date-time", "type": "string" }, "mirror_window_days": { "description": "How many days ahead to mirror this schedule into the external provider. Defaults to 14 if not set; maximum 90.", "example": 14, "format": "int64", "maximum": 90, "minimum": 1, "type": "integer" }, "replica_fallback_user_id": { "description": "The ID of a user in the external provider that will be assigned whenever nobody is on-call in the incident.io schedule. External providers typically require someone to always be on-call, so this user fills gaps where incident.io has no one scheduled.", "example": "PA7AXXN", "type": "string" }, "replica_provider": { "description": "The external provider where this schedule is replicated to", "enum": [ "native", "pagerduty", "opsgenie", "jira" ], "example": "pagerduty", "type": "string" }, "replica_provider_id": { "description": "The ID of the schedule in the external provider that this replica syncs to. For PagerDuty this is the schedule ID (e.g. PO8107X), for Opsgenie the schedule ID, and for Jira Service Management the schedule ID.", "example": "PO8107X", "type": "string" }, "schedule_id": { "description": "The ID of the incident.io schedule that this replica is syncing from", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" }, "sources": { "description": "The specific rotation and layer combinations from the schedule that are being replicated. Each source identifies a single layer within a rotation to sync to the external provider.", "example": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ], "items": { "$ref": "#/components/schemas/ScheduleReplicaSourceV2" }, "type": "array" }, "updated_at": { "description": "When this schedule replica was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "user_statuses": { "description": "The mapping status of each incident.io user in the schedule to their corresponding user in the external provider. Users must be mapped for the replica to sync their on-call shifts correctly.", "example": [ { "external_user_id": "PJYTRGS", "user_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ], "items": { "$ref": "#/components/schemas/ScheduleReplicaUserStatusV2" }, "type": "array" } }, "required": [ "id", "schedule_id", "sources", "replica_provider", "replica_provider_id", "replica_fallback_user_id", "user_statuses", "created_at", "updated_at" ], "type": "object" }, "ScheduleRotationCreatePayloadV2": { "example": { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] }, "properties": { "effective_from": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "handover_start_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "handovers": { "example": [ { "interval": 1, "interval_type": "hourly" } ], "items": { "$ref": "#/components/schemas/ScheduleRotationHandoverV2" }, "type": "array" }, "id": { "description": "Unique identifier of the rotation", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "layers": { "example": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "items": { "$ref": "#/components/schemas/ScheduleLayerCreatePayloadV2" }, "type": "array" }, "name": { "description": "Name of the rotation", "example": "My Rotation", "type": "string" }, "scheduling_mode": { "description": "Scheduling algorithm to use for this rotation. 'fair' balances workload by considering handover duration, while 'sequential' uses simple round-robin rotation through users. Only applies when you have asymmetric handovers (e.g., 2 days then 5 days).", "enum": [ "fair", "sequential" ], "example": "fair", "type": "string" }, "users": { "example": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "items": { "$ref": "#/components/schemas/UserReferencePayloadV2" }, "type": "array" }, "working_interval": { "description": "DEPRECATED: Use working_intervals instead.", "example": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "items": { "$ref": "#/components/schemas/ScheduleRotationWorkingIntervalCreatePayloadV2" }, "type": "array" }, "working_intervals": { "example": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "items": { "$ref": "#/components/schemas/ScheduleRotationWorkingIntervalCreatePayloadV2" }, "type": "array" } }, "required": [ "name" ], "type": "object" }, "ScheduleRotationHandoverV2": { "example": { "interval": 1, "interval_type": "hourly" }, "properties": { "interval": { "example": 1, "format": "int64", "type": "integer" }, "interval_type": { "description": "How often a handover occurs", "enum": [ "hourly", "daily", "weekly" ], "example": "hourly", "type": "string", "x-public-api-version": "v2" } }, "type": "object" }, "ScheduleRotationUpdatePayloadV2": { "example": { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] }, "properties": { "effective_from": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "handover_start_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "handovers": { "example": [ { "interval": 1, "interval_type": "hourly" } ], "items": { "$ref": "#/components/schemas/ScheduleRotationHandoverV2" }, "type": "array" }, "id": { "description": "Unique identifier of the rotation", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "layers": { "example": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "items": { "$ref": "#/components/schemas/ScheduleLayerUpdatePayloadV2" }, "type": "array" }, "name": { "description": "Name of the rotation", "example": "My Rotation", "type": "string" }, "scheduling_mode": { "description": "Scheduling algorithm to use for this rotation. 'fair' balances workload by considering handover duration, while 'sequential' uses simple round-robin rotation through users. Only applies when you have asymmetric handovers (e.g., 2 days then 5 days).", "enum": [ "fair", "sequential" ], "example": "fair", "type": "string" }, "users": { "example": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "items": { "$ref": "#/components/schemas/UserReferencePayloadV2" }, "type": "array" }, "working_interval": { "description": "DEPRECATED: Use working_intervals instead.", "example": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "items": { "$ref": "#/components/schemas/ScheduleRotationWorkingIntervalV2" }, "type": "array" }, "working_intervals": { "example": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "items": { "$ref": "#/components/schemas/ScheduleRotationWorkingIntervalV2" }, "type": "array" } }, "type": "object" }, "ScheduleRotationV2": { "example": { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] }, "properties": { "effective_from": { "description": "When this rotation config will be effective from", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "handover_start_at": { "description": "Defines the next moment we'll trigger a handover", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "handovers": { "description": "Defines the handover intervals for this rota, in order they should apply", "example": [ { "interval": 1, "interval_type": "hourly" } ], "items": { "$ref": "#/components/schemas/ScheduleRotationHandoverV2" }, "type": "array" }, "id": { "description": "Unique internal ID of the rotation", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "layers": { "description": "Controls how many people are on-call concurrently", "example": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "items": { "$ref": "#/components/schemas/ScheduleLayerV2" }, "type": "array" }, "name": { "description": "Human readable name synced from external provider", "example": "Primary On-Call Schedule", "type": "string" }, "scheduling_mode": { "description": "Scheduling algorithm to use for this rotation. 'fair' balances workload by considering handover duration, while 'sequential' uses simple round-robin rotation through users. Only applies when you have asymmetric handovers (e.g., 2 days then 5 days).", "enum": [ "fair", "sequential" ], "example": "fair", "type": "string" }, "users": { "description": "Users who are available to be scheduled on this rota", "example": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "items": { "$ref": "#/components/schemas/UserV2" }, "type": "array" }, "working_interval": { "description": "DEPRECATED: Use working_intervals instead.", "example": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "items": { "$ref": "#/components/schemas/ScheduleRotationWorkingIntervalV2" }, "type": "array" }, "working_intervals": { "description": "Optional restrictions that define when to schedule people for this rota", "example": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "items": { "$ref": "#/components/schemas/ScheduleRotationWorkingIntervalV2" }, "type": "array" } }, "required": [ "id", "name", "layers", "users", "working_intervals", "handover_start_at", "handovers" ], "type": "object" }, "ScheduleRotationWorkingIntervalCreatePayloadV2": { "example": { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" }, "properties": { "end_time": { "description": "End time of the interval, in 24hr format", "example": "17:00", "type": "string" }, "start_time": { "description": "Start time of the interval, in 24hr format", "example": "09:00", "type": "string" }, "weekday": { "description": "Weekdays for use with a schedule", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "example": "monday", "type": "string", "x-public-api-version": "v2" } }, "required": [ "weekday", "start_time", "end_time" ], "type": "object" }, "ScheduleRotationWorkingIntervalV2": { "example": { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" }, "properties": { "end_time": { "description": "End time of the interval, in 24hr format", "example": "17:00", "type": "string" }, "start_time": { "description": "Start time of the interval, in 24hr format", "example": "09:00", "type": "string" }, "weekday": { "description": "Weekdays for use with a schedule", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "example": "monday", "type": "string", "x-public-api-version": "v2" } }, "required": [ "weekday", "start_time", "end_time" ], "type": "object" }, "ScheduleUpdatePayloadV2": { "example": { "annotations": { "incident.io/terraform/version": "version-of-terraform" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "holidays_public_config": { "country_codes": [ "abc123" ] }, "name": "Primary On-call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "America/Los_Angeles" }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that can track metadata about the schedule", "example": { "incident.io/terraform/version": "version-of-terraform" }, "type": "object" }, "config": { "$ref": "#/components/schemas/ScheduleConfigUpdatePayloadV2" }, "holidays_public_config": { "$ref": "#/components/schemas/ScheduleHolidaysPublicConfigPayloadV2" }, "name": { "description": "Name of the schedule", "example": "Primary On-call Schedule", "type": "string" }, "team_ids": { "description": "IDs of teams that own this schedule", "example": [ "01JPQA75EPNEES4479P16P4XAB" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "timezone": { "description": "Timezone of the schedule", "example": "America/Los_Angeles", "type": "string" } }, "type": "object" }, "ScheduleV2": { "example": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "created_at": "2021-08-17T13:28:57.801578Z", "current_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "holidays_public_config": { "country_codes": [ "GB", "FR" ] }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "next_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that track metadata about this resource", "example": { "incident.io/terraform/version": "3.0.0" }, "type": "object" }, "config": { "$ref": "#/components/schemas/ScheduleConfigV2" }, "created_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "current_shifts": { "description": "Shifts that are ongoing for this schedule", "example": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "items": { "$ref": "#/components/schemas/ScheduleEntryV2" }, "type": "array" }, "holidays_public_config": { "$ref": "#/components/schemas/ScheduleHolidaysPublicConfigV2" }, "id": { "description": "Unique internal ID of the schedule", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "name": { "description": "Human readable name synced from external provider", "example": "Primary On-Call Schedule", "type": "string" }, "next_shifts": { "description": "The shifts after the next changeover. Note that on the list schedules endpoint, this will always be empty if the page size requested is greater than 25.", "example": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "items": { "$ref": "#/components/schemas/ScheduleEntryV2" }, "type": "array" }, "team_ids": { "description": "IDs of teams that own this schedule", "example": [ "01JPQA75EPNEES4479P16P4XAB" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "timezone": { "description": "Timezone of the schedule, as interpreted at the point of generating the report", "example": "Europe/London", "type": "string" }, "updated_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "timezone", "team_ids", "created_at", "updated_at", "annotations" ], "type": "object" }, "SchedulesCreateOverridePayloadV2": { "example": { "end_at": "2021-08-17T14:00:00.000000Z", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "schedule_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:00:00.000000Z", "user": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } }, "properties": { "end_at": { "description": "End time of the override", "example": "2021-08-17T14:00:00.000000Z", "format": "date-time", "type": "string" }, "layer_id": { "description": "The layer this override applies to", "example": "01G0J1EXE7AXZ2C93K61WBPYNH", "type": "string" }, "rotation_id": { "description": "The rotation this override applies to", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "schedule_id": { "description": "The schedule this override applies to", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "start_at": { "description": "Start time of the override", "example": "2021-08-17T13:00:00.000000Z", "format": "date-time", "type": "string" }, "user": { "$ref": "#/components/schemas/UserReferencePayloadV2" } }, "required": [ "start_at", "end_at", "schedule_id", "rotation_id", "layer_id", "user" ], "type": "object" }, "SchedulesCreateOverrideResultV2": { "example": { "override": { "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "schedule_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } }, "properties": { "override": { "$ref": "#/components/schemas/ScheduleOverrideV2" } }, "required": [ "override" ], "type": "object" }, "SchedulesCreatePayloadV2": { "example": { "schedule": { "annotations": { "incident.io/terraform/version": "version-of-terraform" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "holidays_public_config": { "country_codes": [ "abc123" ] }, "name": "Primary On-call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "America/Los_Angeles" } }, "properties": { "schedule": { "$ref": "#/components/schemas/ScheduleCreatePayloadV2" } }, "required": [ "schedule" ], "type": "object" }, "SchedulesCreateResultV2": { "example": { "schedule": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "created_at": "2021-08-17T13:28:57.801578Z", "current_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "holidays_public_config": { "country_codes": [ "GB", "FR" ] }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "next_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "schedule": { "$ref": "#/components/schemas/ScheduleV2" } }, "required": [ "schedule" ], "type": "object" }, "SchedulesCreateScheduleReplicaPayloadV2": { "example": { "schedule_replica": { "mirror_window_days": 14, "replica_fallback_user_id": "PA7AXXN", "replica_provider": "pagerduty", "replica_provider_id": "PO8107X", "sources": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ] } }, "properties": { "schedule_replica": { "$ref": "#/components/schemas/ScheduleReplicaCreatePayloadV2" } }, "required": [ "schedule_replica" ], "type": "object" }, "SchedulesCreateScheduleReplicaResultV2": { "example": { "schedule_replica": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_sync_error": "Failed to find external user for Milly", "last_synced_at": "2023-11-07T13:33:30Z", "mirror_window_days": 14, "replica_fallback_user_id": "PA7AXXN", "replica_provider": "pagerduty", "replica_provider_id": "PO8107X", "schedule_id": "01FDAG4SAP5TYPT98WGR2N7W91", "sources": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "user_statuses": [ { "external_user_id": "PJYTRGS", "user_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ] } }, "properties": { "schedule_replica": { "$ref": "#/components/schemas/ScheduleReplicaV2" } }, "required": [ "schedule_replica" ], "type": "object" }, "SchedulesListResultV2": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 }, "schedules": [ { "annotations": { "incident.io/terraform/version": "3.0.0" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "created_at": "2021-08-17T13:28:57.801578Z", "current_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "holidays_public_config": { "country_codes": [ "GB", "FR" ] }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "next_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultWithTotalV2" }, "schedules": { "example": [ { "annotations": { "incident.io/terraform/version": "3.0.0" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "created_at": "2021-08-17T13:28:57.801578Z", "current_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "holidays_public_config": { "country_codes": [ "GB", "FR" ] }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "next_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/ScheduleV2" }, "type": "array" } }, "required": [ "schedules" ], "type": "object" }, "SchedulesListScheduleEntriesResultV2": { "example": { "pagination_meta": { "after": "abc123", "after_url": "abc123" }, "schedule_entries": { "final": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "overrides": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "scheduled": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ] } }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/AfterPaginationMetaResultV2" }, "schedule_entries": { "$ref": "#/components/schemas/ScheduleEntriesListPayloadV2" } }, "required": [ "schedule_entries" ], "type": "object" }, "SchedulesListScheduleReplicasResultV2": { "example": { "schedule_replicas": [ { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_sync_error": "Failed to find external user for Milly", "last_synced_at": "2023-11-07T13:33:30Z", "mirror_window_days": 14, "replica_fallback_user_id": "PA7AXXN", "replica_provider": "pagerduty", "replica_provider_id": "PO8107X", "schedule_id": "01FDAG4SAP5TYPT98WGR2N7W91", "sources": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "user_statuses": [ { "external_user_id": "PJYTRGS", "user_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ] } ] }, "properties": { "schedule_replicas": { "example": [ { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_sync_error": "Failed to find external user for Milly", "last_synced_at": "2023-11-07T13:33:30Z", "mirror_window_days": 14, "replica_fallback_user_id": "PA7AXXN", "replica_provider": "pagerduty", "replica_provider_id": "PO8107X", "schedule_id": "01FDAG4SAP5TYPT98WGR2N7W91", "sources": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "user_statuses": [ { "external_user_id": "PJYTRGS", "user_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ] } ], "items": { "$ref": "#/components/schemas/ScheduleReplicaV2" }, "type": "array" } }, "required": [ "schedule_replicas" ], "type": "object" }, "SchedulesShowResultV2": { "example": { "schedule": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "created_at": "2021-08-17T13:28:57.801578Z", "current_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "holidays_public_config": { "country_codes": [ "GB", "FR" ] }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "next_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "schedule": { "$ref": "#/components/schemas/ScheduleV2" } }, "required": [ "schedule" ], "type": "object" }, "SchedulesShowScheduleReplicaResultV2": { "example": { "schedule_replica": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_sync_error": "Failed to find external user for Milly", "last_synced_at": "2023-11-07T13:33:30Z", "mirror_window_days": 14, "replica_fallback_user_id": "PA7AXXN", "replica_provider": "pagerduty", "replica_provider_id": "PO8107X", "schedule_id": "01FDAG4SAP5TYPT98WGR2N7W91", "sources": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "user_statuses": [ { "external_user_id": "PJYTRGS", "user_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ] } }, "properties": { "schedule_replica": { "$ref": "#/components/schemas/ScheduleReplicaV2" } }, "required": [ "schedule_replica" ], "type": "object" }, "SchedulesUpdatePayloadV2": { "example": { "schedule": { "annotations": { "incident.io/terraform/version": "version-of-terraform" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "holidays_public_config": { "country_codes": [ "abc123" ] }, "name": "Primary On-call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "America/Los_Angeles" } }, "properties": { "schedule": { "$ref": "#/components/schemas/ScheduleUpdatePayloadV2" } }, "required": [ "schedule" ], "type": "object" }, "SchedulesUpdateResultV2": { "example": { "schedule": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "created_at": "2021-08-17T13:28:57.801578Z", "current_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "holidays_public_config": { "country_codes": [ "GB", "FR" ] }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "next_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "schedule": { "$ref": "#/components/schemas/ScheduleV2" } }, "required": [ "schedule" ], "type": "object" }, "SeveritiesCreatePayloadV1": { "example": { "description": "Issues with **low impact**.", "name": "Minor", "rank": 1 }, "properties": { "description": { "description": "Description of the severity", "example": "Issues with **low impact**.", "type": "string" }, "name": { "description": "Human readable name of the severity", "example": "Minor", "maxLength": 50, "type": "string" }, "rank": { "description": "Rank to help sort severities (lower numbers are less severe)", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "name", "description" ], "type": "object" }, "SeveritiesCreateResultV1": { "example": { "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "severity": { "$ref": "#/components/schemas/SeverityV1" } }, "required": [ "severity" ], "type": "object" }, "SeveritiesListResultV1": { "example": { "severities": [ { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "severities": { "example": [ { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/SeverityV1" }, "type": "array" } }, "required": [ "severities" ], "type": "object" }, "SeveritiesShowResultV1": { "example": { "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "severity": { "$ref": "#/components/schemas/SeverityV1" } }, "required": [ "severity" ], "type": "object" }, "SeveritiesUpdatePayloadV1": { "example": { "description": "Issues with **low impact**.", "name": "Minor", "rank": 1 }, "properties": { "description": { "description": "Description of the severity", "example": "Issues with **low impact**.", "type": "string" }, "name": { "description": "Human readable name of the severity", "example": "Minor", "maxLength": 50, "type": "string" }, "rank": { "description": "Rank to help sort severities (lower numbers are less severe)", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "name", "description" ], "type": "object" }, "SeveritiesUpdateResultV1": { "example": { "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "severity": { "$ref": "#/components/schemas/SeverityV1" } }, "required": [ "severity" ], "type": "object" }, "SeverityV1": { "example": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "created_at": { "description": "When the action was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "Description of the severity", "example": "Issues with **low impact**.", "type": "string" }, "id": { "description": "Unique identifier of the severity", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Human readable name of the severity", "example": "Minor", "maxLength": 50, "type": "string" }, "rank": { "description": "Rank to help sort severities (lower numbers are less severe)", "example": 1, "format": "int64", "type": "integer" }, "updated_at": { "description": "When the action was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "rank", "created_at", "updated_at", "id", "name", "description" ], "type": "object" }, "SeverityV2": { "example": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "created_at": { "description": "When the action was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "Description of the severity", "example": "Issues with **low impact**.", "type": "string" }, "id": { "description": "Unique identifier of the severity", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Human readable name of the severity", "example": "Minor", "maxLength": 50, "type": "string" }, "rank": { "description": "Rank to help sort severities (lower numbers are less severe)", "example": 1, "format": "int64", "type": "integer" }, "updated_at": { "description": "When the action was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "description", "rank", "created_at", "updated_at" ], "type": "object" }, "StatusPageIncidentAffectedComponentV2": { "example": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" }, "properties": { "component_id": { "description": "The ID of the affected component. This may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG2", "type": "string" }, "component_status": { "description": "The status of the relevant component in a status page incident", "enum": [ "operational", "degraded_performance", "partial_outage", "full_outage" ], "example": "operational", "type": "string", "x-public-api-version": "v2" } }, "required": [ "component_id", "component_status" ], "type": "object" }, "StatusPageIncidentComponentImpactV2": { "example": { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "component_id": { "description": "The ID of the affected component. This may be found by calling the ShowStatusPageStructure endpoint.", "example": "01GW7P4ES31Q6V1ZQH321T0GJN", "type": "string" }, "component_status": { "description": "The status of the relevant component impact in a status page incident - this excludes the operational status.", "enum": [ "degraded_performance", "partial_outage", "full_outage" ], "example": "degraded_performance", "type": "string", "x-public-api-version": "v2" }, "end_at": { "description": "When the component left this status. If this is null, the impact is ongoing.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "start_at": { "description": "When the component entered this status", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "component_id", "component_status", "start_at" ], "type": "object" }, "StatusPageIncidentUpdateV2": { "example": { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" }, "properties": { "component_statuses": { "description": "The updated statuses of affected components", "example": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "items": { "$ref": "#/components/schemas/StatusPageIncidentAffectedComponentV2" }, "type": "array" }, "id": { "description": "A unique ID for this status page incident update", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_status": { "description": "Current status for this incident", "enum": [ "investigating", "identified", "monitoring", "resolved" ], "example": "investigating", "type": "string", "x-public-api-version": "v2" }, "message": { "description": "Markdown update on what's changed about this status page incident", "example": "abc123", "type": "string" }, "published_at": { "description": "When this status page incident update was published to the status page", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "status_page_incident_id": { "description": "The ID of the corresponding status page incident", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } }, "required": [ "id", "status_page_incident_id", "published_at", "message", "incident_status", "component_statuses" ], "type": "object" }, "StatusPageIncidentV2": { "example": { "component_impacts": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "name": "Elevated API latency", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] }, "properties": { "component_impacts": { "description": "A list of time periods that this status page incident had an impact on a component", "example": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/StatusPageIncidentComponentImpactV2" }, "type": "array" }, "id": { "description": "A unique ID for this status page incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_status": { "description": "Current status for this incident", "enum": [ "investigating", "identified", "monitoring", "resolved" ], "example": "investigating", "type": "string", "x-public-api-version": "v2" }, "name": { "description": "A title for the incident", "example": "Elevated API latency", "type": "string" }, "published_at": { "description": "When this status page incident was published to the status page", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "status_page_id": { "description": "The ID of the corresponding status page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "updates": { "description": "A list of updates posted to this status page incident", "example": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ], "items": { "$ref": "#/components/schemas/StatusPageIncidentUpdateV2" }, "type": "array" } }, "required": [ "id", "status_page_id", "name", "published_at", "incident_status", "updates", "component_impacts" ], "type": "object" }, "StatusPageLinkedResponseIncidentV1": { "example": { "id": "01FDAG4SAH3GYPT98WGR2N7W91", "linked_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "id": { "description": "ID of the Response incident", "example": "01FDAG4SAH3GYPT98WGR2N7W91", "type": "string" }, "linked_at": { "description": "When the Response incident was linked to the status page incident", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "linked_at" ], "type": "object" }, "StatusPageMaintenanceAffectedComponentV2": { "example": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" }, "properties": { "component_id": { "description": "The ID of the affected component. This may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG2", "type": "string" }, "component_status": { "description": "The status of the relevant component in a status page maintenance window", "enum": [ "operational", "under_maintenance" ], "example": "operational", "type": "string", "x-public-api-version": "v2" } }, "required": [ "component_id", "component_status" ], "type": "object" }, "StatusPageMaintenanceComponentMaintenancePeriodV2": { "example": { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "component_id": { "description": "The ID of the affected component. This may be found by calling the ShowStatusPageStructure endpoint.", "example": "01GW7P4ES31Q6V1ZQH321T0GJN", "type": "string" }, "end_at": { "description": "When the component stopped being under maintenance. If this is null, the impact is ongoing.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "start_at": { "description": "When the component started being under maintenance", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "component_id", "start_at" ], "type": "object" }, "StatusPageMaintenanceUpdateV2": { "example": { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" }, "properties": { "component_statuses": { "description": "The updated statuses of affected components", "example": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "items": { "$ref": "#/components/schemas/StatusPageMaintenanceAffectedComponentV2" }, "type": "array" }, "id": { "description": "A unique ID for this status page maintenance update", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "maintenance_status": { "description": "Current status for this maintenance window", "enum": [ "maintenance_scheduled", "maintenance_in_progress", "maintenance_complete" ], "example": "maintenance_scheduled", "type": "string", "x-public-api-version": "v2" }, "message": { "description": "Markdown update on what's changed about this status page maintenance window", "example": "abc123", "type": "string" }, "published_at": { "description": "When this status page maintenance update was published to the status page", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "status_page_maintenance_id": { "description": "The ID of the corresponding status page maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } }, "required": [ "id", "status_page_maintenance_id", "published_at", "message", "maintenance_status", "component_statuses" ], "type": "object" }, "StatusPageMaintenanceV2": { "example": { "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] }, "properties": { "component_maintenance_periods": { "description": "A list of time periods where components were under maintenance during this status page maintenance window", "example": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/StatusPageMaintenanceComponentMaintenancePeriodV2" }, "type": "array" }, "id": { "description": "A unique ID for this status page maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "maintenance_status": { "description": "Current status for this maintenance window", "enum": [ "maintenance_scheduled", "maintenance_in_progress", "maintenance_complete" ], "example": "maintenance_scheduled", "type": "string", "x-public-api-version": "v2" }, "name": { "description": "A title for the maintenance window", "example": "Routine infrastructure upgrade", "type": "string" }, "published_at": { "description": "When this status page maintenance window was published to the status page", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "status_page_id": { "description": "The ID of the corresponding status page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "updates": { "description": "A list of updates posted to this status page maintenance window", "example": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ], "items": { "$ref": "#/components/schemas/StatusPageMaintenanceUpdateV2" }, "type": "array" } }, "required": [ "id", "status_page_id", "name", "published_at", "maintenance_status", "updates", "component_maintenance_periods" ], "type": "object" }, "StatusPageStructureComponentV2": { "example": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "properties": { "component_id": { "description": "The ID of the affected component. This may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" }, "name": { "description": "The name of this component", "example": "App", "type": "string" } }, "required": [ "component_id", "name" ], "type": "object" }, "StatusPageStructureGroupV2": { "example": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" }, "properties": { "components": { "description": "Array of components belonging to this group", "example": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "items": { "$ref": "#/components/schemas/StatusPageStructureComponentV2" }, "type": "array" }, "id": { "description": "Unique ID of this component group", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" }, "name": { "description": "The name of this component group", "example": "EU Data center", "type": "string" } }, "required": [ "id", "name", "components" ], "type": "object" }, "StatusPageStructureItemV2": { "example": { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" }, "sub_page": { "id": "01FCNDV6P870EA6S7TK1DSYDG1", "items": [ { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" } } ], "name": "United Kingdom" } }, "properties": { "component": { "$ref": "#/components/schemas/StatusPageStructureComponentV2" }, "group": { "$ref": "#/components/schemas/StatusPageStructureGroupV2" }, "sub_page": { "$ref": "#/components/schemas/StatusPageStructureSubPageV2" } }, "type": "object" }, "StatusPageStructureSubPageItemV2": { "example": { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" } }, "properties": { "component": { "$ref": "#/components/schemas/StatusPageStructureComponentV2" }, "group": { "$ref": "#/components/schemas/StatusPageStructureGroupV2" } }, "type": "object" }, "StatusPageStructureSubPageV2": { "example": { "id": "01FCNDV6P870EA6S7TK1DSYDG1", "items": [ { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" } } ], "name": "United Kingdom" }, "properties": { "id": { "description": "Unique ID of this subpage", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" }, "items": { "description": "Array of components and groups belonging to this subpage", "example": [ { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" } } ], "items": { "$ref": "#/components/schemas/StatusPageStructureSubPageItemV2" }, "type": "array" }, "name": { "description": "The name of this subpage", "example": "United Kingdom", "type": "string" } }, "required": [ "id", "name", "items" ], "type": "object" }, "StatusPageStructureV2": { "example": { "items": [ { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" }, "sub_page": { "id": "01FCNDV6P870EA6S7TK1DSYDG1", "items": [ { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" } } ], "name": "United Kingdom" } } ] }, "properties": { "items": { "description": "Array of components and groups to display in the status page", "example": [ { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" }, "sub_page": { "id": "01FCNDV6P870EA6S7TK1DSYDG1", "items": [ { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" } } ], "name": "United Kingdom" } } ], "items": { "$ref": "#/components/schemas/StatusPageStructureItemV2" }, "type": "array" } }, "required": [ "items" ], "type": "object" }, "StatusPageV2": { "example": { "description": "This status page is our public status page.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Our public status page", "public_url": "https://statuspage.incident.io/our-public-status-page" }, "properties": { "description": { "description": "The description of this status page", "example": "This status page is our public status page.", "type": "string" }, "id": { "description": "Unique ID of this status page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "The title of this status page", "example": "Our public status page", "type": "string" }, "public_url": { "description": "The public URL of this status page", "example": "https://statuspage.incident.io/our-public-status-page", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "StatusPagesCreateStatusPageIncidentPayloadV2": { "example": { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "idempotency_key": "alert-12345-abcde", "incident_status": "investigating", "message": "We are currently investigating reports of elevated error rates affecting our API.", "name": "Elevated API latency", "notify_subscribers": true, "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "component_statuses": { "description": "An array of mappings from component ID to current component status", "example": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "items": { "$ref": "#/components/schemas/StatusPageIncidentAffectedComponentV2" }, "type": "array" }, "idempotency_key": { "description": "A unique key to de-duplicate requests. If you send a request with an idempotency_key that was already used, the original response will be returned.", "example": "alert-12345-abcde", "type": "string" }, "incident_status": { "description": "Current status for this status page incident", "enum": [ "investigating", "identified", "monitoring", "resolved" ], "example": "investigating", "type": "string" }, "message": { "description": "Markdown initial update on this status page incident", "example": "We are currently investigating reports of elevated error rates affecting our API.", "maxLength": 4096, "type": "string" }, "name": { "description": "A title for the incident", "example": "Elevated API latency", "maxLength": 200, "type": "string" }, "notify_subscribers": { "description": "Whether to notify subscribers about this status page incident. This will not work if your status page has more than 1000 subscribers.", "example": true, "type": "boolean" }, "status_page_id": { "description": "ID of the status page. You can find this by calling the ListStatusPages endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "status_page_id", "name", "incident_status", "idempotency_key", "message", "notify_subscribers" ], "type": "object" }, "StatusPagesCreateStatusPageIncidentResultV2": { "example": { "status_page_incident": { "component_impacts": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "name": "Elevated API latency", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "properties": { "status_page_incident": { "$ref": "#/components/schemas/StatusPageIncidentV2" } }, "type": "object" }, "StatusPagesCreateStatusPageIncidentUpdatePayloadV2": { "example": { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "incident_status": "investigating", "message": "The fix has been deployed and we are monitoring the situation. Some users may still experience intermittent issues.", "notify_subscribers": true, "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" }, "properties": { "component_statuses": { "description": "An array of mappings from component ID to component status. This must not be set if the status page incident status is being set to \"resolved\", as all components statuses will update to \"operational\".", "example": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "items": { "$ref": "#/components/schemas/StatusPageIncidentAffectedComponentV2" }, "type": "array" }, "incident_status": { "description": "Optional new status for this status page incident. If not provided, the status will remain unchanged. Setting to \"resolved\" will end the incident and all component statuses will update to \"operational\".", "enum": [ "investigating", "identified", "monitoring", "resolved" ], "example": "investigating", "type": "string" }, "message": { "description": "Markdown update on what's changed about this status page incident", "example": "The fix has been deployed and we are monitoring the situation. Some users may still experience intermittent issues.", "maxLength": 4096, "type": "string" }, "notify_subscribers": { "description": "Whether to notify subscribers about this incident update. This will not work if your status page has more than 1000 subscribers.", "example": true, "type": "boolean" }, "status_page_incident_id": { "description": "ID of the status page incident", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } }, "required": [ "status_page_incident_id", "message", "notify_subscribers" ], "type": "object" }, "StatusPagesCreateStatusPageIncidentUpdateResultV2": { "example": { "status_page_incident_update": { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } }, "properties": { "status_page_incident_update": { "$ref": "#/components/schemas/StatusPageIncidentUpdateV2" } }, "type": "object" }, "StatusPagesCreateStatusPageMaintenancePayloadV2": { "example": { "affected_component_ids": [ "01FCNDV6P870EA6S7TK1DSYDG2" ], "end_at": "2025-01-28T12:00:00Z", "idempotency_key": "maintenance-12345-abcde", "maintenance_status": "maintenance_scheduled", "message": "Planned maintenance has been scheduled to upgrade our infrastructure. We expect minimal disruption, but some features may be briefly unavailable.", "name": "Routine infrastructure upgrade", "notify_subscribers": true, "start_at": "2025-01-28T10:00:00Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "affected_component_ids": { "description": "An array of IDs of component affected by the maintenance window", "example": [ "01FCNDV6P870EA6S7TK1DSYDG2" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "end_at": { "description": "The time the maintenance window ends", "example": "2025-01-28T12:00:00Z", "format": "date-time", "type": "string" }, "idempotency_key": { "description": "A unique key to de-duplicate requests. If you send a request with an idempotency_key that was already used, the original response will be returned.", "example": "maintenance-12345-abcde", "type": "string" }, "maintenance_status": { "description": "Current status for this status page maintenance window", "enum": [ "maintenance_scheduled", "maintenance_in_progress", "maintenance_complete" ], "example": "maintenance_scheduled", "type": "string" }, "message": { "description": "Markdown initial update on this status page maintenance window", "example": "Planned maintenance has been scheduled to upgrade our infrastructure. We expect minimal disruption, but some features may be briefly unavailable.", "maxLength": 4096, "type": "string" }, "name": { "description": "A title for the maintenance window", "example": "Routine infrastructure upgrade", "maxLength": 200, "type": "string" }, "notify_subscribers": { "description": "Whether to notify subscribers about this status page maintenance. This will not work if your status page has more than 1000 subscribers.", "example": true, "type": "boolean" }, "start_at": { "description": "The time the maintenance window starts", "example": "2025-01-28T10:00:00Z", "format": "date-time", "type": "string" }, "status_page_id": { "description": "ID of the status page. You can find this by calling the ListStatusPages endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "status_page_id", "name", "maintenance_status", "idempotency_key", "affected_component_ids", "start_at", "end_at", "message", "notify_subscribers" ], "type": "object" }, "StatusPagesCreateStatusPageMaintenanceResultV2": { "example": { "status_page_maintenance": { "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "properties": { "status_page_maintenance": { "$ref": "#/components/schemas/StatusPageMaintenanceV2" } }, "type": "object" }, "StatusPagesCreateStatusPageMaintenanceUpdatePayloadV2": { "example": { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "maintenance_status": "maintenance_scheduled", "message": "Scheduled maintenance is underway for our database infrastructure. Some services may experience brief interruptions during this window.", "notify_subscribers": true, "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" }, "properties": { "component_statuses": { "description": "An array of mappings from component ID to component status. This must not be set if the status page maintenance window status is being set to \"maintenance_complete\", as all components statuses will update to \"operational\".", "example": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "items": { "$ref": "#/components/schemas/StatusPageMaintenanceAffectedComponentV2" }, "type": "array" }, "maintenance_status": { "description": "Optional new status for this status page maintenance window. If not provided, the status will remain unchanged. Setting to \"maintenance_complete\" will end the maintenance window and all component statuses will update to \"operational\".", "enum": [ "maintenance_scheduled", "maintenance_in_progress", "maintenance_complete" ], "example": "maintenance_scheduled", "type": "string" }, "message": { "description": "Markdown update on what's changed about this status page maintenance window", "example": "Scheduled maintenance is underway for our database infrastructure. Some services may experience brief interruptions during this window.", "maxLength": 4096, "type": "string" }, "notify_subscribers": { "description": "Whether to notify subscribers about this status page maintenance update. This will not work if your status page has more than 1000 subscribers.", "example": true, "type": "boolean" }, "status_page_maintenance_id": { "description": "ID of the status page maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } }, "required": [ "status_page_maintenance_id", "message", "notify_subscribers" ], "type": "object" }, "StatusPagesCreateStatusPageMaintenanceUpdateResultV2": { "example": { "status_page_maintenance_update": { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } }, "properties": { "status_page_maintenance_update": { "$ref": "#/components/schemas/StatusPageMaintenanceUpdateV2" } }, "type": "object" }, "StatusPagesListResponseIncidentsResultV1": { "example": { "incidents": [ { "id": "01FDAG4SAH3GYPT98WGR2N7W91", "linked_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "incidents": { "example": [ { "id": "01FDAG4SAH3GYPT98WGR2N7W91", "linked_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/StatusPageLinkedResponseIncidentV1" }, "type": "array" } }, "required": [ "incidents" ], "type": "object" }, "StatusPagesListStatusPageIncidentsResultV2": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "status_page_incidents": [ { "component_impacts": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "name": "Elevated API latency", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } ] }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" }, "status_page_incidents": { "example": [ { "component_impacts": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "name": "Elevated API latency", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } ], "items": { "$ref": "#/components/schemas/StatusPageIncidentV2" }, "type": "array" } }, "required": [ "status_page_incidents", "pagination_meta" ], "type": "object" }, "StatusPagesListStatusPageMaintenancesResultV2": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "status_page_maintenances": [ { "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } ] }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" }, "status_page_maintenances": { "example": [ { "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } ], "items": { "$ref": "#/components/schemas/StatusPageMaintenanceV2" }, "type": "array" } }, "required": [ "status_page_maintenances", "pagination_meta" ], "type": "object" }, "StatusPagesListStatusPagesResultV2": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "status_pages": [ { "description": "This status page is our public status page.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Our public status page", "public_url": "https://statuspage.incident.io/our-public-status-page" } ] }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" }, "status_pages": { "example": [ { "description": "This status page is our public status page.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Our public status page", "public_url": "https://statuspage.incident.io/our-public-status-page" } ], "items": { "$ref": "#/components/schemas/StatusPageV2" }, "type": "array" } }, "required": [ "status_pages", "pagination_meta" ], "type": "object" }, "StatusPagesShowStatusPageIncidentResultV2": { "example": { "status_page_incident": { "component_impacts": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "name": "Elevated API latency", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "properties": { "status_page_incident": { "$ref": "#/components/schemas/StatusPageIncidentV2" } }, "type": "object" }, "StatusPagesShowStatusPageMaintenanceResultV2": { "example": { "status_page_maintenance": { "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "properties": { "status_page_maintenance": { "$ref": "#/components/schemas/StatusPageMaintenanceV2" } }, "type": "object" }, "StatusPagesShowStatusPageStructureResultV2": { "example": { "current_structure": { "items": [ { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" }, "sub_page": { "id": "01FCNDV6P870EA6S7TK1DSYDG1", "items": [ { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" } } ], "name": "United Kingdom" } } ] } }, "properties": { "current_structure": { "$ref": "#/components/schemas/StatusPageStructureV2" } }, "required": [ "current_structure" ], "type": "object" }, "StatusPagesUpdateStatusPageIncidentPayloadV2": { "example": { "name": "Elevated API latency" }, "properties": { "name": { "description": "A title for the incident", "example": "Elevated API latency", "maxLength": 200, "type": "string" } }, "required": [ "name" ], "type": "object" }, "StatusPagesUpdateStatusPageIncidentResultV2": { "example": { "status_page_incident": { "component_impacts": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "name": "Elevated API latency", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "properties": { "status_page_incident": { "$ref": "#/components/schemas/StatusPageIncidentV2" } }, "type": "object" }, "StepConfigPayloadV2": { "example": { "for_each": "abc123", "id": "abc123", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ] }, "properties": { "for_each": { "description": "Reference to an expression that returns resources to run this step over", "example": "abc123", "type": "string" }, "id": { "description": "Unique ID of this step in a workflow", "example": "abc123", "type": "string" }, "name": { "description": "Unique name of the step in the engine", "example": "pagerduty.escalate", "type": "string" }, "param_bindings": { "description": "List of parameter bindings", "example": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "items": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "type": "array" } }, "required": [ "id", "name", "param_bindings" ], "type": "object" }, "StepConfigSlimV2": { "example": { "label": "PagerDuty Escalate", "name": "pagerduty.escalate" }, "properties": { "label": { "description": "Human readable identifier for this step", "example": "PagerDuty Escalate", "type": "string" }, "name": { "description": "Unique name of the step in the engine", "example": "pagerduty.escalate", "type": "string" } }, "required": [ "name", "label" ], "type": "object" }, "StepConfigV2": { "example": { "for_each": "abc123", "id": "abc123", "label": "PagerDuty Escalate", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ] }, "properties": { "for_each": { "description": "Reference to an expression that returns resources to run this step over", "example": "abc123", "type": "string" }, "id": { "description": "Unique ID of this step in a workflow", "example": "abc123", "type": "string" }, "label": { "description": "Human readable identifier for this step", "example": "PagerDuty Escalate", "type": "string" }, "name": { "description": "Unique name of the step in the engine", "example": "pagerduty.escalate", "type": "string" }, "param_bindings": { "description": "Bindings for the step parameters", "example": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "items": { "$ref": "#/components/schemas/EngineParamBindingV2" }, "type": "array" } }, "required": [ "id", "name", "label", "param_bindings" ], "type": "object" }, "TeamV3": { "example": { "catalog_entry": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "id": "abc123", "members": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "slack_user_id": "U02AYNF2XJM" } ], "name": "abc123" }, "properties": { "catalog_entry": { "$ref": "#/components/schemas/CatalogEntrySlimV3V3" }, "id": { "description": "Unique ID of the team", "example": "abc123", "type": "string" }, "members": { "description": "Members of the team", "example": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "slack_user_id": "U02AYNF2XJM" } ], "items": { "$ref": "#/components/schemas/UserV3" }, "type": "array" }, "name": { "description": "Name of the team", "example": "abc123", "type": "string" } }, "required": [ "id", "name", "catalog_entry", "members" ], "type": "object" }, "TeamsListResultV3": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "teams": [ { "catalog_entry": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "id": "abc123", "members": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "slack_user_id": "U02AYNF2XJM" } ], "name": "abc123" } ] }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV3" }, "teams": { "example": [ { "catalog_entry": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "id": "abc123", "members": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "slack_user_id": "U02AYNF2XJM" } ], "name": "abc123" } ], "items": { "$ref": "#/components/schemas/TeamV3" }, "type": "array" } }, "required": [ "teams", "pagination_meta" ], "type": "object" }, "TeamsShowResultV3": { "example": { "team": { "catalog_entry": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "id": "abc123", "members": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "slack_user_id": "U02AYNF2XJM" } ], "name": "abc123" } }, "properties": { "team": { "$ref": "#/components/schemas/TeamV3" } }, "required": [ "team" ], "type": "object" }, "TelemetryDataSourceV2": { "description": "A telemetry data source integration", "example": { "created_at": "2021-08-17T13:28:57.801578Z", "enabled": true, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary Prometheus", "provider": "grafana", "source_type": "grafana", "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "created_at": { "description": "When this data source was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "enabled": { "description": "Whether this data source is enabled", "example": true, "type": "boolean" }, "id": { "description": "Unique identifier for this data source", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "name": { "description": "Human-readable name of the data source", "example": "Primary Prometheus", "type": "string" }, "provider": { "description": "Provider that hosts this data source", "example": "grafana", "type": "string" }, "source_type": { "description": "Type of data source (e.g., prometheus, loki, tempo)", "example": "grafana", "type": "string" }, "updated_at": { "description": "When this data source was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "provider", "source_type", "enabled", "created_at", "updated_at" ], "type": "object" }, "TelemetryDatadogUpdateConfigV2": { "description": "Datadog-specific credential updates", "example": { "api_key": "abc123" }, "properties": { "api_key": { "description": "New Datadog API key", "example": "abc123", "type": "string" } }, "type": "object" }, "TelemetryGrafanaUpdateConfigV2": { "description": "Grafana-specific credential updates", "example": { "api_key": "glsa_123" }, "properties": { "api_key": { "description": "New Grafana service account token", "example": "glsa_123", "type": "string" } }, "type": "object" }, "TelemetryUpdateDataSourcePayloadV2": { "example": { "datadog_config": { "api_key": "abc123" }, "grafana_config": { "api_key": "glsa_123" }, "name": "Production Grafana" }, "properties": { "datadog_config": { "$ref": "#/components/schemas/TelemetryDatadogUpdateConfigV2" }, "grafana_config": { "$ref": "#/components/schemas/TelemetryGrafanaUpdateConfigV2" }, "name": { "description": "Updated display name", "example": "Production Grafana", "type": "string" } }, "type": "object" }, "TelemetryUpdateDataSourceResultV2": { "example": { "data_source": { "created_at": "2021-08-17T13:28:57.801578Z", "enabled": true, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary Prometheus", "provider": "grafana", "source_type": "grafana", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "data_source": { "$ref": "#/components/schemas/TelemetryDataSourceV2" } }, "required": [ "data_source" ], "type": "object" }, "TriggerSlimV2": { "example": { "label": "Incident Updated", "name": "incident.updated" }, "properties": { "label": { "description": "Human readable identifier for this trigger", "example": "Incident Updated", "type": "string" }, "name": { "description": "Unique name of the trigger", "example": "incident.updated", "type": "string" } }, "required": [ "name", "label" ], "type": "object" }, "UserReferencePayloadV1": { "example": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "properties": { "email": { "description": "The user's email address, matching the email on their Slack account", "example": "bob@example.com", "type": "string" }, "id": { "description": "The incident.io ID of a user", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "slack_user_id": { "description": "The ID of the user's Slack account.", "example": "USER123", "type": "string" } }, "type": "object" }, "UserReferencePayloadV2": { "example": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "properties": { "email": { "description": "The user's email address, matching the email on their Slack account", "example": "bob@example.com", "type": "string" }, "id": { "description": "The incident.io ID of a user", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "slack_user_id": { "description": "The ID of the user's Slack account.", "example": "USER123", "type": "string" } }, "type": "object" }, "UserSeatsV2": { "example": { "on_call": "full_access", "response": "viewer_only" }, "properties": { "on_call": { "description": "On-call seat access level", "enum": [ "full_access", "viewer_only", "none" ], "example": "full_access", "type": "string" }, "response": { "description": "Response seat access level", "enum": [ "full_access", "viewer_only", "none" ], "example": "viewer_only", "type": "string" } }, "required": [ "on_call", "response" ], "type": "object" }, "UserV1": { "example": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "properties": { "email": { "description": "Email address of the user.", "example": "lisa@incident.io", "type": "string" }, "id": { "description": "Unique identifier of the user", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Name of the user", "example": "Lisa Karlin Curtis", "type": "string" }, "role": { "description": "DEPRECATED: Role of the user as of March 9th 2023, this value is no longer updated.", "enum": [ "viewer", "responder", "administrator", "owner", "unset" ], "example": "viewer", "type": "string" }, "slack_user_id": { "description": "Slack ID of the user", "example": "U02AYNF2XJM", "type": "string" } }, "required": [ "role", "id", "name" ], "type": "object" }, "UserV2": { "example": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "properties": { "email": { "description": "Email address of the user.", "example": "lisa@incident.io", "type": "string" }, "id": { "description": "Unique identifier of the user", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Name of the user", "example": "Lisa Karlin Curtis", "type": "string" }, "role": { "description": "DEPRECATED: Role of the user as of March 9th 2023, this value is no longer updated.", "enum": [ "viewer", "responder", "administrator", "owner", "unset" ], "example": "owner", "type": "string" }, "slack_user_id": { "description": "Slack ID of the user", "example": "U02AYNF2XJM", "type": "string" } }, "required": [ "role", "id", "name" ], "type": "object" }, "UserV3": { "example": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "slack_user_id": "U02AYNF2XJM" }, "properties": { "email": { "description": "Email address of the user.", "example": "lisa@incident.io", "type": "string" }, "id": { "description": "Unique identifier of the user", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Name of the user", "example": "Lisa Karlin Curtis", "type": "string" }, "slack_user_id": { "description": "Slack ID of the user", "example": "U02AYNF2XJM", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "UserWithRolesV2": { "example": { "base_role": { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" }, "custom_roles": [ { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" } ], "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "seats": { "on_call": "full_access", "response": "viewer_only" }, "slack_user_id": "U02AYNF2XJM" }, "properties": { "base_role": { "$ref": "#/components/schemas/RBACRoleV2" }, "custom_roles": { "example": [ { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" } ], "items": { "$ref": "#/components/schemas/RBACRoleV2" }, "type": "array" }, "email": { "description": "Email address of the user.", "example": "lisa@incident.io", "type": "string" }, "id": { "description": "Unique identifier of the user", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Name of the user", "example": "Lisa Karlin Curtis", "type": "string" }, "role": { "description": "DEPRECATED: Role of the user as of March 9th 2023, this value is no longer updated.", "enum": [ "viewer", "responder", "administrator", "owner", "unset" ], "example": "owner", "type": "string" }, "seats": { "$ref": "#/components/schemas/UserSeatsV2" }, "slack_user_id": { "description": "Slack ID of the user", "example": "U02AYNF2XJM", "type": "string" } }, "required": [ "base_role", "custom_roles", "seats", "role", "id", "name" ], "type": "object" }, "UsersListNotificationMethodsResultV2": { "example": { "notification_methods": [ { "address": "•••••••6789", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_usable": true, "method_type": "app" } ] }, "properties": { "notification_methods": { "example": [ { "address": "•••••••6789", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_usable": true, "method_type": "app" } ], "items": { "$ref": "#/components/schemas/OnCallNotificationMethodPublicV2" }, "type": "array" } }, "required": [ "notification_methods" ], "type": "object" }, "UsersListNotificationRulesResultV2": { "example": { "notification_rules": [ { "app": { "push_notification_criticality": "critical" }, "delay_seconds": 0, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "method_target": { "all": {}, "specific": { "id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "specific" }, "method_type": "app", "rule_type": "low_urgency" } ] }, "properties": { "notification_rules": { "example": [ { "app": { "push_notification_criticality": "critical" }, "delay_seconds": 0, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "method_target": { "all": {}, "specific": { "id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "specific" }, "method_type": "app", "rule_type": "low_urgency" } ], "items": { "$ref": "#/components/schemas/OnCallNotificationRulePublicV2" }, "type": "array" } }, "required": [ "notification_rules" ], "type": "object" }, "UsersListResultV2": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "users": [ { "base_role": { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" }, "custom_roles": [ { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" } ], "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "seats": { "on_call": "full_access", "response": "viewer_only" }, "slack_user_id": "U02AYNF2XJM" } ] }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" }, "users": { "example": [ { "base_role": { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" }, "custom_roles": [ { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" } ], "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "seats": { "on_call": "full_access", "response": "viewer_only" }, "slack_user_id": "U02AYNF2XJM" } ], "items": { "$ref": "#/components/schemas/UserWithRolesV2" }, "type": "array" } }, "required": [ "users", "pagination_meta" ], "type": "object" }, "UsersShowPagingProviderResultV2": { "example": { "preferred_escalation_provider": "native" }, "properties": { "preferred_escalation_provider": { "description": "The user's effective escalation provider.", "enum": [ "native", "opsgenie", "pagerduty", "splunk_on_call" ], "example": "native", "type": "string" } }, "type": "object" }, "UsersShowResultV2": { "example": { "user": { "base_role": { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" }, "custom_roles": [ { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" } ], "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "seats": { "on_call": "full_access", "response": "viewer_only" }, "slack_user_id": "U02AYNF2XJM" } }, "properties": { "user": { "$ref": "#/components/schemas/UserWithRolesV2" } }, "required": [ "user" ], "type": "object" }, "UsersUpdatePagingProviderPayloadV2": { "example": { "preferred_escalation_provider": "native" }, "properties": { "preferred_escalation_provider": { "description": "The preferred escalation provider for the user.", "enum": [ "native", "opsgenie", "pagerduty", "splunk_on_call" ], "example": "native", "type": "string" } }, "required": [ "preferred_escalation_provider" ], "type": "object" }, "UtilitiesIdentityResultV1": { "example": { "identity": { "dashboard_url": "https://app.incident.io/my-org", "name": "Alertmanager token", "roles": [ "viewer" ], "team_roles": [ "schedules_editor" ], "teams": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Platform" } ] } }, "properties": { "identity": { "$ref": "#/components/schemas/IdentityV1" } }, "required": [ "identity" ], "type": "object" }, "WebhookIncidentUserV2": { "example": { "actor_user_id": "abc123", "incident_id": "abc123", "user_id": "abc123" }, "properties": { "actor_user_id": { "description": "The ID of the user who performed this action. If the action was not taken by a user, for example it was taken by a Workflow, this will be empty.", "example": "abc123", "type": "string" }, "incident_id": { "description": "The ID of the incident", "example": "abc123", "type": "string" }, "user_id": { "description": "The ID of the user", "example": "abc123", "type": "string" } }, "required": [ "incident_id", "user_id" ], "type": "object" }, "WebhookIncidentV2": { "example": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "value_seconds": 10800 } ], "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "has_debrief": false, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "incident_timestamp_values": [ { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "value": { "value": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "standard", "most_recent_update_message": "We're working on a fix, hoping to ship in the next 30 minutes", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_ids": [ "01FCNDV6P870EA6S7TK1DSYD5H" ], "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "related_incidents": [ "INC-237" ], "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 }, "properties": { "call_url": { "description": "The call URL attached to this incident", "example": "https://zoom.us/foo", "type": "string" }, "created_at": { "description": "When the incident was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "creator": { "$ref": "#/components/schemas/ActorV2" }, "custom_field_entries": { "description": "Custom field entries for this incident", "example": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "items": { "$ref": "#/components/schemas/CustomFieldEntryV2" }, "type": "array" }, "duration_metrics": { "description": "Incident duration metrics and their measurements for this incident", "example": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "value_seconds": 10800 } ], "items": { "$ref": "#/components/schemas/IncidentDurationMetricWithValueV2" }, "type": "array" }, "external_issue_reference": { "$ref": "#/components/schemas/ExternalIssueReferenceV2" }, "has_debrief": { "description": "If this incident has a debrief attached", "example": false, "type": "boolean" }, "id": { "description": "Unique identifier for the incident", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" }, "incident_role_assignments": { "description": "A list of who is assigned to each role for this incident", "example": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "items": { "$ref": "#/components/schemas/IncidentRoleAssignmentV2" }, "type": "array" }, "incident_status": { "$ref": "#/components/schemas/IncidentStatusV2" }, "incident_timestamp_values": { "description": "Incident lifecycle events and when they occurred", "example": [ { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "value": { "value": "2021-08-17T13:28:57.801578Z" } } ], "items": { "$ref": "#/components/schemas/IncidentTimestampWithValueV2" }, "type": "array" }, "incident_type": { "$ref": "#/components/schemas/IncidentTypeV2" }, "mode": { "description": "Whether the incident is real, a test, a tutorial, or importing as a retrospective incident", "enum": [ "standard", "retrospective", "test", "tutorial" ], "example": "standard", "type": "string" }, "most_recent_update_message": { "description": "Message that explains the context behind the update", "example": "We're working on a fix, hoping to ship in the next 30 minutes", "type": "string" }, "name": { "description": "Explanation of the incident", "example": "Our database is sad", "type": "string" }, "permalink": { "description": "A permanent link to the homepage for this incident", "example": "https://app.incident.io/incidents/123", "type": "string" }, "postmortem_document_ids": { "description": "An array of IDs of postmortem documents for this incident", "example": [ "01FCNDV6P870EA6S7TK1DSYD5H" ], "items": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "type": "array" }, "postmortem_document_url": { "description": "The URL of the incident post-mortem document", "example": "https://docs.google.com/my_doc_id", "type": "string" }, "reference": { "description": "Reference to this incident, as displayed across the product", "example": "INC-123", "type": "string" }, "related_incidents": { "description": "Incident IDs of incidents related to this incident", "example": [ "INC-237" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "severity": { "$ref": "#/components/schemas/SeverityV2" }, "slack_channel_id": { "description": "ID of the Slack channel in the organisation Slack workspace. Note that the channel is sometimes created asynchronously, so may not be present when the incident is just created.", "example": "C02AW36C1M5", "type": "string" }, "slack_channel_name": { "description": "Name of the slack channel", "example": "inc-165-green-parrot", "type": "string" }, "slack_team_id": { "description": "ID of the Slack team / workspace. This is only required if you are using a Slack Enterprise Grid with multiple teams.", "example": "T02A1FSLE8J", "type": "string" }, "summary": { "description": "Detailed description of the incident", "example": "Our database is really really sad, and we don't know why yet.", "type": "string" }, "updated_at": { "description": "When the incident was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "visibility": { "description": "Whether the incident should be open to anyone in your Slack workspace (public), or invite-only (private). For more information on Private Incidents see our [docs](https://docs.incident.io/incidents/sensitive-incidents).", "enum": [ "public", "private" ], "example": "public", "type": "string" }, "workload_minutes_late": { "description": "Amount of time spent on the incident in late hours", "example": 40.7, "format": "double", "type": "number" }, "workload_minutes_sleeping": { "description": "Amount of time spent on the incident in sleeping hours", "example": 0, "format": "double", "type": "number" }, "workload_minutes_total": { "description": "Amount of time spent on the incident in total", "example": 60.7, "format": "double", "type": "number" }, "workload_minutes_working": { "description": "Amount of time spent on the incident in working hours", "example": 20, "format": "double", "type": "number" } }, "required": [ "incident_status", "id", "reference", "name", "visibility", "mode", "creator", "incident_role_assignments", "custom_field_entries", "slack_team_id", "slack_channel_id", "created_at", "updated_at" ], "type": "object" }, "WebhookPrivateResourceV2": { "example": { "id": "abc123" }, "properties": { "id": { "description": "The ID of the resource", "example": "abc123", "type": "string" } }, "required": [ "id" ], "type": "object" }, "WebhooksPrivateAlertCreatedV1ResponseBody": { "example": { "event_type": "private_alert.alert_created_v1", "private_alert.alert_created_v1": { "id": "abc123" } }, "properties": { "event_type": { "description": "What type of event is this webhook for?", "enum": [ "public_incident.incident_created_v2", "private_incident.incident_created_v2", "public_incident.incident_updated_v2", "private_incident.incident_updated_v2", "public_incident.incident_status_updated_v2", "public_incident.follow_up_created_v1", "private_incident.follow_up_created_v1", "public_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1", "public_incident.follow_up_created_v2", "private_incident.follow_up_created_v2", "public_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2", "public_incident.action_created_v1", "private_incident.action_created_v1", "public_incident.action_updated_v1", "private_incident.action_updated_v1", "public_alert.alert_created_v1", "private_alert.alert_created_v1", "private_incident.membership_granted_v1", "private_incident.membership_revoked_v1", "public_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1" ], "example": "private_alert.alert_created_v1", "type": "string" }, "private_alert.alert_created_v1": { "$ref": "#/components/schemas/WebhookPrivateResourceV2" } }, "required": [ "event_type", "private_alert.alert_created_v1" ], "type": "object" }, "WebhooksPrivateIncidentActionCreatedV1ResponseBody": { "example": { "event_type": "private_incident.action_created_v1", "private_incident.action_created_v1": { "id": "abc123" } }, "properties": { "event_type": { "description": "What type of event is this webhook for?", "enum": [ "public_incident.incident_created_v2", "private_incident.incident_created_v2", "public_incident.incident_updated_v2", "private_incident.incident_updated_v2", "public_incident.incident_status_updated_v2", "public_incident.follow_up_created_v1", "private_incident.follow_up_created_v1", "public_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1", "public_incident.follow_up_created_v2", "private_incident.follow_up_created_v2", "public_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2", "public_incident.action_created_v1", "private_incident.action_created_v1", "public_incident.action_updated_v1", "private_incident.action_updated_v1", "public_alert.alert_created_v1", "private_alert.alert_created_v1", "private_incident.membership_granted_v1", "private_incident.membership_revoked_v1", "public_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1" ], "example": "private_incident.action_created_v1", "type": "string" }, "private_incident.action_created_v1": { "$ref": "#/components/schemas/WebhookPrivateResourceV2" } }, "required": [ "event_type", "private_incident.action_created_v1" ], "type": "object" }, "WebhooksPrivateIncidentActionUpdatedV1ResponseBody": { "example": { "event_type": "private_incident.action_updated_v1", "private_incident.action_updated_v1": { "id": "abc123" } }, "properties": { "event_type": { "description": "What type of event is this webhook for?", "enum": [ "public_incident.incident_created_v2", "private_incident.incident_created_v2", "public_incident.incident_updated_v2", "private_incident.incident_updated_v2", "public_incident.incident_status_updated_v2", "public_incident.follow_up_created_v1", "private_incident.follow_up_created_v1", "public_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1", "public_incident.follow_up_created_v2", "private_incident.follow_up_created_v2", "public_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2", "public_incident.action_created_v1", "private_incident.action_created_v1", "public_incident.action_updated_v1", "private_incident.action_updated_v1", "public_alert.alert_created_v1", "private_alert.alert_created_v1", "private_incident.membership_granted_v1", "private_incident.membership_revoked_v1", "public_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1" ], "example": "private_incident.action_updated_v1", "type": "string" }, "private_incident.action_updated_v1": { "$ref": "#/components/schemas/WebhookPrivateResourceV2" } }, "required": [ "event_type", "private_incident.action_updated_v1" ], "type": "object" }, "WebhooksPrivateIncidentFollowUpCreatedV1ResponseBody": { "example": { "event_type": "private_incident.follow_up_created_v1", "private_incident.follow_up_created_v1": { "id": "abc123" } }, "properties": { "event_type": { "description": "What type of event is this webhook for?", "enum": [ "public_incident.incident_created_v2", "private_incident.incident_created_v2", "public_incident.incident_updated_v2", "private_incident.incident_updated_v2", "public_incident.incident_status_updated_v2", "public_incident.follow_up_created_v1", "private_incident.follow_up_created_v1", "public_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1", "public_incident.follow_up_created_v2", "private_incident.follow_up_created_v2", "public_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2", "public_incident.action_created_v1", "private_incident.action_created_v1", "public_incident.action_updated_v1", "private_incident.action_updated_v1", "public_alert.alert_created_v1", "private_alert.alert_created_v1", "private_incident.membership_granted_v1", "private_incident.membership_revoked_v1", "public_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1" ], "example": "private_incident.follow_up_created_v1", "type": "string" }, "private_incident.follow_up_created_v1": { "$ref": "#/components/schemas/WebhookPrivateResourceV2" } }, "required": [ "event_type", "private_incident.follow_up_created_v1" ], "type": "object" }, "WebhooksPrivateIncidentFollowUpCreatedV2ResponseBody": { "example": { "event_type": "private_incident.follow_up_created_v2", "private_incident.follow_up_created_v2": { "id": "abc123" } }, "properties": { "event_type": { "description": "What type of event is this webhook for?", "enum": [ "public_incident.incident_created_v2", "private_incident.incident_created_v2", "public_incident.incident_updated_v2", "private_incident.incident_updated_v2", "public_incident.incident_status_updated_v2", "public_incident.follow_up_created_v1", "private_incident.follow_up_created_v1", "public_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1", "public_incident.follow_up_created_v2", "private_incident.follow_up_created_v2", "public_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2", "public_incident.action_created_v1", "private_incident.action_created_v1", "public_incident.action_updated_v1", "private_incident.action_updated_v1", "public_alert.alert_created_v1", "private_alert.alert_created_v1", "private_incident.membership_granted_v1", "private_incident.membership_revoked_v1", "public_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1" ], "example": "private_incident.follow_up_created_v2", "type": "string" }, "private_incident.follow_up_created_v2": { "$ref": "#/components/schemas/WebhookPrivateResourceV2" } }, "required": [ "event_type", "private_incident.follow_up_created_v2" ], "type": "object" }, "WebhooksPrivateIncidentFollowUpUpdatedV1ResponseBody": { "example": { "event_type": "private_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1": { "id": "abc123" } }, "properties": { "event_type": { "description": "What type of event is this webhook for?", "enum": [ "public_incident.incident_created_v2", "private_incident.incident_created_v2", "public_incident.incident_updated_v2", "private_incident.incident_updated_v2", "public_incident.incident_status_updated_v2", "public_incident.follow_up_created_v1", "private_incident.follow_up_created_v1", "public_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1", "public_incident.follow_up_created_v2", "private_incident.follow_up_created_v2", "public_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2", "public_incident.action_created_v1", "private_incident.action_created_v1", "public_incident.action_updated_v1", "private_incident.action_updated_v1", "public_alert.alert_created_v1", "private_alert.alert_created_v1", "private_incident.membership_granted_v1", "private_incident.membership_revoked_v1", "public_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1" ], "example": "private_incident.follow_up_updated_v1", "type": "string" }, "private_incident.follow_up_updated_v1": { "$ref": "#/components/schemas/WebhookPrivateResourceV2" } }, "required": [ "event_type", "private_incident.follow_up_updated_v1" ], "type": "object" }, "WebhooksPrivateIncidentFollowUpUpdatedV2ResponseBody": { "example": { "event_type": "private_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2": { "id": "abc123" } }, "properties": { "event_type": { "description": "What type of event is this webhook for?", "enum": [ "public_incident.incident_created_v2", "private_incident.incident_created_v2", "public_incident.incident_updated_v2", "private_incident.incident_updated_v2", "public_incident.incident_status_updated_v2", "public_incident.follow_up_created_v1", "private_incident.follow_up_created_v1", "public_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1", "public_incident.follow_up_created_v2", "private_incident.follow_up_created_v2", "public_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2", "public_incident.action_created_v1", "private_incident.action_created_v1", "public_incident.action_updated_v1", "private_incident.action_updated_v1", "public_alert.alert_created_v1", "private_alert.alert_created_v1", "private_incident.membership_granted_v1", "private_incident.membership_revoked_v1", "public_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1" ], "example": "private_incident.follow_up_updated_v2", "type": "string" }, "private_incident.follow_up_updated_v2": { "$ref": "#/components/schemas/WebhookPrivateResourceV2" } }, "required": [ "event_type", "private_incident.follow_up_updated_v2" ], "type": "object" }, "WebhooksPrivateIncidentIncidentCreatedV2ResponseBody": { "example": { "event_type": "private_incident.incident_created_v2", "private_incident.incident_created_v2": { "id": "abc123" } }, "properties": { "event_type": { "description": "What type of event is this webhook for?", "enum": [ "public_incident.incident_created_v2", "private_incident.incident_created_v2", "public_incident.incident_updated_v2", "private_incident.incident_updated_v2", "public_incident.incident_status_updated_v2", "public_incident.follow_up_created_v1", "private_incident.follow_up_created_v1", "public_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1", "public_incident.follow_up_created_v2", "private_incident.follow_up_created_v2", "public_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2", "public_incident.action_created_v1", "private_incident.action_created_v1", "public_incident.action_updated_v1", "private_incident.action_updated_v1", "public_alert.alert_created_v1", "private_alert.alert_created_v1", "private_incident.membership_granted_v1", "private_incident.membership_revoked_v1", "public_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1" ], "example": "private_incident.incident_created_v2", "type": "string" }, "private_incident.incident_created_v2": { "$ref": "#/components/schemas/WebhookPrivateResourceV2" } }, "required": [ "event_type", "private_incident.incident_created_v2" ], "type": "object" }, "WebhooksPrivateIncidentIncidentUpdatedV2ResponseBody": { "example": { "event_type": "private_incident.incident_updated_v2", "private_incident.incident_updated_v2": { "id": "abc123" } }, "properties": { "event_type": { "description": "What type of event is this webhook for?", "enum": [ "public_incident.incident_created_v2", "private_incident.incident_created_v2", "public_incident.incident_updated_v2", "private_incident.incident_updated_v2", "public_incident.incident_status_updated_v2", "public_incident.follow_up_created_v1", "private_incident.follow_up_created_v1", "public_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1", "public_incident.follow_up_created_v2", "private_incident.follow_up_created_v2", "public_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2", "public_incident.action_created_v1", "private_incident.action_created_v1", "public_incident.action_updated_v1", "private_incident.action_updated_v1", "public_alert.alert_created_v1", "private_alert.alert_created_v1", "private_incident.membership_granted_v1", "private_incident.membership_revoked_v1", "public_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1" ], "example": "private_incident.incident_updated_v2", "type": "string" }, "private_incident.incident_updated_v2": { "$ref": "#/components/schemas/WebhookPrivateResourceV2" } }, "required": [ "event_type", "private_incident.incident_updated_v2" ], "type": "object" }, "WebhooksPrivateIncidentMembershipGrantedV1ResponseBody": { "example": { "event_type": "private_incident.membership_granted_v1", "private_incident.membership_granted_v1": { "actor_user_id": "abc123", "incident_id": "abc123", "user_id": "abc123" } }, "properties": { "event_type": { "description": "What type of event is this webhook for?", "enum": [ "public_incident.incident_created_v2", "private_incident.incident_created_v2", "public_incident.incident_updated_v2", "private_incident.incident_updated_v2", "public_incident.incident_status_updated_v2", "public_incident.follow_up_created_v1", "private_incident.follow_up_created_v1", "public_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1", "public_incident.follow_up_created_v2", "private_incident.follow_up_created_v2", "public_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2", "public_incident.action_created_v1", "private_incident.action_created_v1", "public_incident.action_updated_v1", "private_incident.action_updated_v1", "public_alert.alert_created_v1", "private_alert.alert_created_v1", "private_incident.membership_granted_v1", "private_incident.membership_revoked_v1", "public_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1" ], "example": "private_incident.membership_granted_v1", "type": "string" }, "private_incident.membership_granted_v1": { "$ref": "#/components/schemas/WebhookIncidentUserV2" } }, "required": [ "event_type", "private_incident.membership_granted_v1" ], "type": "object" }, "WebhooksPrivateIncidentMembershipRevokedV1ResponseBody": { "example": { "event_type": "private_incident.membership_revoked_v1", "private_incident.membership_revoked_v1": { "actor_user_id": "abc123", "incident_id": "abc123", "user_id": "abc123" } }, "properties": { "event_type": { "description": "What type of event is this webhook for?", "enum": [ "public_incident.incident_created_v2", "private_incident.incident_created_v2", "public_incident.incident_updated_v2", "private_incident.incident_updated_v2", "public_incident.incident_status_updated_v2", "public_incident.follow_up_created_v1", "private_incident.follow_up_created_v1", "public_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1", "public_incident.follow_up_created_v2", "private_incident.follow_up_created_v2", "public_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2", "public_incident.action_created_v1", "private_incident.action_created_v1", "public_incident.action_updated_v1", "private_incident.action_updated_v1", "public_alert.alert_created_v1", "private_alert.alert_created_v1", "private_incident.membership_granted_v1", "private_incident.membership_revoked_v1", "public_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1" ], "example": "private_incident.membership_revoked_v1", "type": "string" }, "private_incident.membership_revoked_v1": { "$ref": "#/components/schemas/WebhookIncidentUserV2" } }, "required": [ "event_type", "private_incident.membership_revoked_v1" ], "type": "object" }, "WebhooksPrivateIncidentPostmortemDocumentStatusUpdatedV1ResponseBody": { "example": { "event_type": "private_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1": { "id": "abc123" } }, "properties": { "event_type": { "description": "What type of event is this webhook for?", "enum": [ "public_incident.incident_created_v2", "private_incident.incident_created_v2", "public_incident.incident_updated_v2", "private_incident.incident_updated_v2", "public_incident.incident_status_updated_v2", "public_incident.follow_up_created_v1", "private_incident.follow_up_created_v1", "public_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1", "public_incident.follow_up_created_v2", "private_incident.follow_up_created_v2", "public_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2", "public_incident.action_created_v1", "private_incident.action_created_v1", "public_incident.action_updated_v1", "private_incident.action_updated_v1", "public_alert.alert_created_v1", "private_alert.alert_created_v1", "private_incident.membership_granted_v1", "private_incident.membership_revoked_v1", "public_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1" ], "example": "private_incident.postmortem_document_status_updated_v1", "type": "string" }, "private_incident.postmortem_document_status_updated_v1": { "$ref": "#/components/schemas/WebhookPrivateResourceV2" } }, "required": [ "event_type", "private_incident.postmortem_document_status_updated_v1" ], "type": "object" }, "WebhooksPublicAlertCreatedV1ResponseBody": { "example": { "event_type": "public_alert.alert_created_v1", "public_alert.alert_created_v1": { "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "attributes": [ { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } } ], "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "event_type": { "description": "What type of event is this webhook for?", "enum": [ "public_incident.incident_created_v2", "private_incident.incident_created_v2", "public_incident.incident_updated_v2", "private_incident.incident_updated_v2", "public_incident.incident_status_updated_v2", "public_incident.follow_up_created_v1", "private_incident.follow_up_created_v1", "public_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1", "public_incident.follow_up_created_v2", "private_incident.follow_up_created_v2", "public_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2", "public_incident.action_created_v1", "private_incident.action_created_v1", "public_incident.action_updated_v1", "private_incident.action_updated_v1", "public_alert.alert_created_v1", "private_alert.alert_created_v1", "private_incident.membership_granted_v1", "private_incident.membership_revoked_v1", "public_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1" ], "example": "public_alert.alert_created_v1", "type": "string" }, "public_alert.alert_created_v1": { "$ref": "#/components/schemas/AlertV2" } }, "required": [ "event_type", "public_alert.alert_created_v1" ], "type": "object" }, "WebhooksPublicIncidentActionCreatedV1ResponseBody": { "example": { "event_type": "public_incident.action_created_v1", "public_incident.action_created_v1": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "follow_up": true, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "event_type": { "description": "What type of event is this webhook for?", "enum": [ "public_incident.incident_created_v2", "private_incident.incident_created_v2", "public_incident.incident_updated_v2", "private_incident.incident_updated_v2", "public_incident.incident_status_updated_v2", "public_incident.follow_up_created_v1", "private_incident.follow_up_created_v1", "public_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1", "public_incident.follow_up_created_v2", "private_incident.follow_up_created_v2", "public_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2", "public_incident.action_created_v1", "private_incident.action_created_v1", "public_incident.action_updated_v1", "private_incident.action_updated_v1", "public_alert.alert_created_v1", "private_alert.alert_created_v1", "private_incident.membership_granted_v1", "private_incident.membership_revoked_v1", "public_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1" ], "example": "public_incident.action_created_v1", "type": "string" }, "public_incident.action_created_v1": { "$ref": "#/components/schemas/ActionV1" } }, "required": [ "event_type", "public_incident.action_created_v1" ], "type": "object" }, "WebhooksPublicIncidentActionUpdatedV1ResponseBody": { "example": { "event_type": "public_incident.action_updated_v1", "public_incident.action_updated_v1": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "follow_up": true, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "event_type": { "description": "What type of event is this webhook for?", "enum": [ "public_incident.incident_created_v2", "private_incident.incident_created_v2", "public_incident.incident_updated_v2", "private_incident.incident_updated_v2", "public_incident.incident_status_updated_v2", "public_incident.follow_up_created_v1", "private_incident.follow_up_created_v1", "public_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1", "public_incident.follow_up_created_v2", "private_incident.follow_up_created_v2", "public_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2", "public_incident.action_created_v1", "private_incident.action_created_v1", "public_incident.action_updated_v1", "private_incident.action_updated_v1", "public_alert.alert_created_v1", "private_alert.alert_created_v1", "private_incident.membership_granted_v1", "private_incident.membership_revoked_v1", "public_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1" ], "example": "public_incident.action_updated_v1", "type": "string" }, "public_incident.action_updated_v1": { "$ref": "#/components/schemas/ActionV1" } }, "required": [ "event_type", "public_incident.action_updated_v1" ], "type": "object" }, "WebhooksPublicIncidentFollowUpCreatedV1ResponseBody": { "example": { "event_type": "public_incident.follow_up_created_v1", "public_incident.follow_up_created_v1": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "follow_up": true, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "event_type": { "description": "What type of event is this webhook for?", "enum": [ "public_incident.incident_created_v2", "private_incident.incident_created_v2", "public_incident.incident_updated_v2", "private_incident.incident_updated_v2", "public_incident.incident_status_updated_v2", "public_incident.follow_up_created_v1", "private_incident.follow_up_created_v1", "public_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1", "public_incident.follow_up_created_v2", "private_incident.follow_up_created_v2", "public_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2", "public_incident.action_created_v1", "private_incident.action_created_v1", "public_incident.action_updated_v1", "private_incident.action_updated_v1", "public_alert.alert_created_v1", "private_alert.alert_created_v1", "private_incident.membership_granted_v1", "private_incident.membership_revoked_v1", "public_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1" ], "example": "public_incident.follow_up_created_v1", "type": "string" }, "public_incident.follow_up_created_v1": { "$ref": "#/components/schemas/ActionV1" } }, "required": [ "event_type", "public_incident.follow_up_created_v1" ], "type": "object" }, "WebhooksPublicIncidentFollowUpCreatedV2ResponseBody": { "example": { "event_type": "public_incident.follow_up_created_v2", "public_incident.follow_up_created_v2": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "event_type": { "description": "What type of event is this webhook for?", "enum": [ "public_incident.incident_created_v2", "private_incident.incident_created_v2", "public_incident.incident_updated_v2", "private_incident.incident_updated_v2", "public_incident.incident_status_updated_v2", "public_incident.follow_up_created_v1", "private_incident.follow_up_created_v1", "public_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1", "public_incident.follow_up_created_v2", "private_incident.follow_up_created_v2", "public_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2", "public_incident.action_created_v1", "private_incident.action_created_v1", "public_incident.action_updated_v1", "private_incident.action_updated_v1", "public_alert.alert_created_v1", "private_alert.alert_created_v1", "private_incident.membership_granted_v1", "private_incident.membership_revoked_v1", "public_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1" ], "example": "public_incident.follow_up_created_v2", "type": "string" }, "public_incident.follow_up_created_v2": { "$ref": "#/components/schemas/FollowUpV2" } }, "required": [ "event_type", "public_incident.follow_up_created_v2" ], "type": "object" }, "WebhooksPublicIncidentFollowUpUpdatedV1ResponseBody": { "example": { "event_type": "public_incident.follow_up_updated_v1", "public_incident.follow_up_updated_v1": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "follow_up": true, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "event_type": { "description": "What type of event is this webhook for?", "enum": [ "public_incident.incident_created_v2", "private_incident.incident_created_v2", "public_incident.incident_updated_v2", "private_incident.incident_updated_v2", "public_incident.incident_status_updated_v2", "public_incident.follow_up_created_v1", "private_incident.follow_up_created_v1", "public_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1", "public_incident.follow_up_created_v2", "private_incident.follow_up_created_v2", "public_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2", "public_incident.action_created_v1", "private_incident.action_created_v1", "public_incident.action_updated_v1", "private_incident.action_updated_v1", "public_alert.alert_created_v1", "private_alert.alert_created_v1", "private_incident.membership_granted_v1", "private_incident.membership_revoked_v1", "public_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1" ], "example": "public_incident.follow_up_updated_v1", "type": "string" }, "public_incident.follow_up_updated_v1": { "$ref": "#/components/schemas/ActionV1" } }, "required": [ "event_type", "public_incident.follow_up_updated_v1" ], "type": "object" }, "WebhooksPublicIncidentFollowUpUpdatedV2ResponseBody": { "example": { "event_type": "public_incident.follow_up_updated_v2", "public_incident.follow_up_updated_v2": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "event_type": { "description": "What type of event is this webhook for?", "enum": [ "public_incident.incident_created_v2", "private_incident.incident_created_v2", "public_incident.incident_updated_v2", "private_incident.incident_updated_v2", "public_incident.incident_status_updated_v2", "public_incident.follow_up_created_v1", "private_incident.follow_up_created_v1", "public_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1", "public_incident.follow_up_created_v2", "private_incident.follow_up_created_v2", "public_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2", "public_incident.action_created_v1", "private_incident.action_created_v1", "public_incident.action_updated_v1", "private_incident.action_updated_v1", "public_alert.alert_created_v1", "private_alert.alert_created_v1", "private_incident.membership_granted_v1", "private_incident.membership_revoked_v1", "public_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1" ], "example": "public_incident.follow_up_updated_v2", "type": "string" }, "public_incident.follow_up_updated_v2": { "$ref": "#/components/schemas/FollowUpV2" } }, "required": [ "event_type", "public_incident.follow_up_updated_v2" ], "type": "object" }, "WebhooksPublicIncidentIncidentCreatedV2ResponseBody": { "example": { "event_type": "public_incident.incident_created_v2", "public_incident.incident_created_v2": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "value_seconds": 10800 } ], "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "has_debrief": false, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "incident_timestamp_values": [ { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "value": { "value": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "standard", "most_recent_update_message": "We're working on a fix, hoping to ship in the next 30 minutes", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_ids": [ "01FCNDV6P870EA6S7TK1DSYD5H" ], "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "related_incidents": [ "INC-237" ], "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 } }, "properties": { "event_type": { "description": "What type of event is this webhook for?", "enum": [ "public_incident.incident_created_v2", "private_incident.incident_created_v2", "public_incident.incident_updated_v2", "private_incident.incident_updated_v2", "public_incident.incident_status_updated_v2", "public_incident.follow_up_created_v1", "private_incident.follow_up_created_v1", "public_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1", "public_incident.follow_up_created_v2", "private_incident.follow_up_created_v2", "public_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2", "public_incident.action_created_v1", "private_incident.action_created_v1", "public_incident.action_updated_v1", "private_incident.action_updated_v1", "public_alert.alert_created_v1", "private_alert.alert_created_v1", "private_incident.membership_granted_v1", "private_incident.membership_revoked_v1", "public_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1" ], "example": "public_incident.incident_created_v2", "type": "string" }, "public_incident.incident_created_v2": { "$ref": "#/components/schemas/WebhookIncidentV2" } }, "required": [ "event_type", "public_incident.incident_created_v2" ], "type": "object" }, "WebhooksPublicIncidentIncidentStatusUpdatedV2ResponseBody": { "example": { "event_type": "public_incident.incident_status_updated_v2", "public_incident.incident_status_updated_v2": { "incident": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "value_seconds": 10800 } ], "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "has_debrief": false, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "incident_timestamp_values": [ { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "value": { "value": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "standard", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_ids": [ "01FCNDV6P870EA6S7TK1DSYD5H" ], "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 }, "message": "We're working on a fix, hoping to ship in the next 30 minutes", "new_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "previous_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" } } }, "properties": { "event_type": { "description": "What type of event is this webhook for?", "enum": [ "public_incident.incident_created_v2", "private_incident.incident_created_v2", "public_incident.incident_updated_v2", "private_incident.incident_updated_v2", "public_incident.incident_status_updated_v2", "public_incident.follow_up_created_v1", "private_incident.follow_up_created_v1", "public_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1", "public_incident.follow_up_created_v2", "private_incident.follow_up_created_v2", "public_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2", "public_incident.action_created_v1", "private_incident.action_created_v1", "public_incident.action_updated_v1", "private_incident.action_updated_v1", "public_alert.alert_created_v1", "private_alert.alert_created_v1", "private_incident.membership_granted_v1", "private_incident.membership_revoked_v1", "public_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1" ], "example": "public_incident.incident_status_updated_v2", "type": "string" }, "public_incident.incident_status_updated_v2": { "$ref": "#/components/schemas/IncidentWithStatusChangeV2" } }, "required": [ "event_type", "public_incident.incident_status_updated_v2" ], "type": "object" }, "WebhooksPublicIncidentIncidentUpdatedV2ResponseBody": { "example": { "event_type": "public_incident.incident_updated_v2", "public_incident.incident_updated_v2": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "value_seconds": 10800 } ], "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "has_debrief": false, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "incident_timestamp_values": [ { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "value": { "value": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "standard", "most_recent_update_message": "We're working on a fix, hoping to ship in the next 30 minutes", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_ids": [ "01FCNDV6P870EA6S7TK1DSYD5H" ], "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "related_incidents": [ "INC-237" ], "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 } }, "properties": { "event_type": { "description": "What type of event is this webhook for?", "enum": [ "public_incident.incident_created_v2", "private_incident.incident_created_v2", "public_incident.incident_updated_v2", "private_incident.incident_updated_v2", "public_incident.incident_status_updated_v2", "public_incident.follow_up_created_v1", "private_incident.follow_up_created_v1", "public_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1", "public_incident.follow_up_created_v2", "private_incident.follow_up_created_v2", "public_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2", "public_incident.action_created_v1", "private_incident.action_created_v1", "public_incident.action_updated_v1", "private_incident.action_updated_v1", "public_alert.alert_created_v1", "private_alert.alert_created_v1", "private_incident.membership_granted_v1", "private_incident.membership_revoked_v1", "public_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1" ], "example": "public_incident.incident_updated_v2", "type": "string" }, "public_incident.incident_updated_v2": { "$ref": "#/components/schemas/WebhookIncidentV2" } }, "required": [ "event_type", "public_incident.incident_updated_v2" ], "type": "object" }, "WebhooksPublicIncidentPostmortemDocumentStatusUpdatedV1ResponseBody": { "example": { "event_type": "public_incident.postmortem_document_status_updated_v1", "public_incident.postmortem_document_status_updated_v1": { "new_status": "complete", "postmortem_document": { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" }, "previous_status": "review" } }, "properties": { "event_type": { "description": "What type of event is this webhook for?", "enum": [ "public_incident.incident_created_v2", "private_incident.incident_created_v2", "public_incident.incident_updated_v2", "private_incident.incident_updated_v2", "public_incident.incident_status_updated_v2", "public_incident.follow_up_created_v1", "private_incident.follow_up_created_v1", "public_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1", "public_incident.follow_up_created_v2", "private_incident.follow_up_created_v2", "public_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2", "public_incident.action_created_v1", "private_incident.action_created_v1", "public_incident.action_updated_v1", "private_incident.action_updated_v1", "public_alert.alert_created_v1", "private_alert.alert_created_v1", "private_incident.membership_granted_v1", "private_incident.membership_revoked_v1", "public_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1" ], "example": "public_incident.postmortem_document_status_updated_v1", "type": "string" }, "public_incident.postmortem_document_status_updated_v1": { "$ref": "#/components/schemas/PostmortemDocumentWithStatusChangeV1" } }, "required": [ "event_type", "public_incident.postmortem_document_status_updated_v1" ], "type": "object" }, "WeekdayIntervalConfigV2": { "example": { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] }, "properties": { "id": { "description": "The unique identifier for this set of working intervals", "example": "abc123", "type": "string" }, "name": { "description": "A human readable label for this set of working intervals", "example": "abc123", "type": "string" }, "timezone": { "description": "How to interpret all the intervals", "example": "abc123", "type": "string" }, "weekday_intervals": { "example": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "items": { "$ref": "#/components/schemas/WeekdayIntervalV2" }, "type": "array" } }, "required": [ "id", "name", "timezone", "weekday_intervals" ], "type": "object" }, "WeekdayIntervalV2": { "example": { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" }, "properties": { "end_time": { "description": "End time of the interval, in 24hr format", "example": "17:00", "type": "string" }, "start_time": { "description": "Start time of the interval, in 24hr format", "example": "09:00", "type": "string" }, "weekday": { "description": "Weekdays for use within a schedule or escalation path", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "example": "monday", "type": "string", "x-public-api-version": "v2" } }, "required": [ "weekday", "start_time", "end_time" ], "type": "object" }, "WorkflowActorV2": { "example": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" }, "properties": { "id": { "description": "Unique identifier for the workflow", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Name provided by the user when creating the workflow", "example": "My little workflow", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "WorkflowDelayV2": { "example": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "properties": { "conditions_apply_over_delay": { "description": "If this workflow is delayed, whether the conditions should be rechecked between trigger firing and execution", "example": false, "type": "boolean" }, "for_seconds": { "description": "Delay in seconds between trigger firing and running the workflow", "example": 60, "format": "int64", "minimum": 0, "type": "integer" } }, "required": [ "for_seconds", "conditions_apply_over_delay" ], "type": "object" }, "WorkflowSlimV2": { "example": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "folder": "My folder 01", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -\u003e Affected Team", "type": "IncidentSeverity" } ], "runs_from": "2021-08-17T13:28:57.801578Z", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "label": "PagerDuty Escalate", "name": "pagerduty.escalate" } ], "trigger": { "label": "Incident Updated", "name": "incident.updated" }, "version": 3 }, "properties": { "condition_groups": { "description": "Conditions that apply to the workflow trigger", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV2" }, "type": "array" }, "continue_on_step_error": { "description": "Whether to continue executing the workflow if a step fails", "example": true, "type": "boolean" }, "delay": { "$ref": "#/components/schemas/WorkflowDelayV2" }, "expressions": { "description": "Expressions that make variables available in the scope", "example": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionV2" }, "type": "array" }, "folder": { "description": "Folder to display the workflow in", "example": "My folder 01", "type": "string" }, "id": { "description": "Unique identifier for the workflow", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "include_private_escalations": { "description": "Whether to include private escalations", "example": true, "type": "boolean" }, "include_private_incidents": { "description": "Whether to include private incidents", "example": true, "type": "boolean" }, "name": { "description": "Name provided by the user when creating the workflow", "example": "My little workflow", "type": "string" }, "once_for": { "description": "This workflow will run 'once for' a list of references", "example": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -\u003e Affected Team", "type": "IncidentSeverity" } ], "items": { "$ref": "#/components/schemas/EngineReferenceV2" }, "type": "array" }, "runs_from": { "description": "The time from which this workflow will run on incidents", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "runs_on_incident_modes": { "description": "Which incident modes should this workflow run on? By default, workflows only run on standard incidents, but can also be configured to run on test and retrospective incidents.", "example": [ "standard", "test", "retrospective" ], "items": { "description": "Incident mode that workflows can run on", "enum": [ "standard", "test", "retrospective" ], "example": "standard", "type": "string", "x-public-api-version": "v2" }, "type": "array" }, "runs_on_incidents": { "description": "Which incidents should the workflow be applied to?", "enum": [ "newly_created", "newly_created_and_active" ], "example": "newly_created", "type": "string" }, "shortform": { "description": "The shortform used to trigger this workflow (only applicable for manual triggers)", "example": "page-the-ceo", "type": "string" }, "state": { "description": "What state this workflow is in", "enum": [ "active", "disabled", "draft", "error" ], "example": "active", "type": "string" }, "steps": { "description": "Steps that are executed as part of the workflow", "example": [ { "label": "PagerDuty Escalate", "name": "pagerduty.escalate" } ], "items": { "$ref": "#/components/schemas/StepConfigSlimV2" }, "type": "array" }, "trigger": { "$ref": "#/components/schemas/TriggerSlimV2" }, "version": { "description": "Revision of the workflow, uniquely identifying it's version", "example": 3, "format": "int64", "type": "integer" } }, "required": [ "id", "name", "trigger", "once_for", "version", "expressions", "condition_groups", "steps", "include_private_incidents", "include_private_escalations", "runs_on_incident_modes", "continue_on_step_error", "runs_on_incidents", "state" ], "type": "object" }, "WorkflowV2": { "example": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "folder": "My folder 01", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -\u003e Affected Team", "type": "IncidentSeverity" } ], "runs_from": "2021-08-17T13:28:57.801578Z", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "for_each": "abc123", "id": "abc123", "label": "PagerDuty Escalate", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ] } ], "trigger": { "label": "Incident Updated", "name": "incident.updated" }, "version": 3 }, "properties": { "condition_groups": { "description": "Conditions that apply to the workflow trigger", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV2" }, "type": "array" }, "continue_on_step_error": { "description": "Whether to continue executing the workflow if a step fails", "example": true, "type": "boolean" }, "delay": { "$ref": "#/components/schemas/WorkflowDelayV2" }, "expressions": { "description": "Expressions that make variables available in the scope", "example": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionV2" }, "type": "array" }, "folder": { "description": "Folder to display the workflow in", "example": "My folder 01", "type": "string" }, "id": { "description": "Unique identifier for the workflow", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "include_private_escalations": { "description": "Whether to include private escalations", "example": true, "type": "boolean" }, "include_private_incidents": { "description": "Whether to include private incidents", "example": true, "type": "boolean" }, "name": { "description": "Name provided by the user when creating the workflow", "example": "My little workflow", "type": "string" }, "once_for": { "description": "This workflow will run 'once for' a list of references", "example": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -\u003e Affected Team", "type": "IncidentSeverity" } ], "items": { "$ref": "#/components/schemas/EngineReferenceV2" }, "type": "array" }, "runs_from": { "description": "The time from which this workflow will run on incidents", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "runs_on_incident_modes": { "description": "Which incident modes should this workflow run on? By default, workflows only run on standard incidents, but can also be configured to run on test and retrospective incidents.", "example": [ "standard", "test", "retrospective" ], "items": { "description": "Incident mode that workflows can run on", "enum": [ "standard", "test", "retrospective" ], "example": "standard", "type": "string", "x-public-api-version": "v2" }, "type": "array" }, "runs_on_incidents": { "description": "Which incidents should the workflow be applied to?", "enum": [ "newly_created", "newly_created_and_active" ], "example": "newly_created", "type": "string" }, "shortform": { "description": "The shortform used to trigger this workflow (only applicable for manual triggers)", "example": "page-the-ceo", "type": "string" }, "state": { "description": "What state this workflow is in", "enum": [ "active", "disabled", "draft", "error" ], "example": "active", "type": "string" }, "steps": { "description": "Steps that are executed as part of the workflow", "example": [ { "for_each": "abc123", "id": "abc123", "label": "PagerDuty Escalate", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/StepConfigV2" }, "type": "array" }, "trigger": { "$ref": "#/components/schemas/TriggerSlimV2" }, "version": { "description": "Revision of the workflow, uniquely identifying it's version", "example": 3, "format": "int64", "type": "integer" } }, "required": [ "id", "name", "trigger", "once_for", "version", "expressions", "condition_groups", "steps", "include_private_incidents", "include_private_escalations", "runs_on_incident_modes", "continue_on_step_error", "runs_on_incidents", "state" ], "type": "object" }, "WorkflowsCreateWorkflowPayloadV2": { "example": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "folder": "My folder 01", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ "incident.url" ], "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "for_each": "abc123", "id": "abc123", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ] } ], "trigger": "incident.updated" }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that track metadata about this resource", "example": { "incident.io/terraform/version": "3.0.0" }, "type": "object" }, "condition_groups": { "description": "Conditions that apply to the workflow trigger", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" }, "continue_on_step_error": { "description": "Whether to continue executing the workflow if a step fails", "example": true, "type": "boolean" }, "delay": { "$ref": "#/components/schemas/WorkflowDelayV2" }, "expressions": { "description": "The expressions to use in the workflow", "example": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionPayloadV2" }, "type": "array" }, "folder": { "description": "Folder to display the workflow in", "example": "My folder 01", "type": "string" }, "include_private_escalations": { "description": "Whether to include private escalations", "example": true, "type": "boolean" }, "include_private_incidents": { "description": "Whether to include private incidents", "example": true, "type": "boolean" }, "name": { "description": "Name provided by the user when creating the workflow", "example": "My little workflow", "type": "string" }, "once_for": { "description": "This workflow will run 'once for' a list of references", "example": [ "incident.url" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "runs_on_incident_modes": { "description": "Which incident modes should this workflow run on? By default, workflows only run on standard incidents, but can also be configured to run on test and retrospective incidents.", "example": [ "standard", "test", "retrospective" ], "items": { "enum": [ "standard", "test", "retrospective" ], "example": "standard", "type": "string" }, "type": "array" }, "runs_on_incidents": { "description": "Which incidents should the workflow be applied to?", "enum": [ "newly_created", "newly_created_and_active" ], "example": "newly_created", "type": "string" }, "shortform": { "description": "The shortform used to trigger this workflow (only applicable for manual triggers)", "example": "page-the-ceo", "type": "string" }, "state": { "description": "What state this workflow is in", "enum": [ "active", "disabled", "draft", "error" ], "example": "active", "type": "string" }, "steps": { "description": "Steps that are executed as part of the workflow", "example": [ { "for_each": "abc123", "id": "abc123", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/StepConfigPayloadV2" }, "type": "array" }, "trigger": { "description": "Trigger to set on the workflow", "example": "incident.updated", "type": "string" } }, "required": [ "name", "trigger", "once_for", "condition_groups", "steps", "expressions", "include_private_incidents", "runs_on_incident_modes", "continue_on_step_error", "runs_on_incidents" ], "type": "object" }, "WorkflowsCreateWorkflowResultV2": { "example": { "management_meta": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "managed_by": "dashboard", "source_url": "https://github.com/my-company/infrastructure" }, "workflow": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "folder": "My folder 01", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -\u003e Affected Team", "type": "IncidentSeverity" } ], "runs_from": "2021-08-17T13:28:57.801578Z", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "for_each": "abc123", "id": "abc123", "label": "PagerDuty Escalate", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ] } ], "trigger": { "label": "Incident Updated", "name": "incident.updated" }, "version": 3 } }, "properties": { "management_meta": { "$ref": "#/components/schemas/ManagementMetaV2" }, "workflow": { "$ref": "#/components/schemas/WorkflowV2" } }, "required": [ "workflow", "management_meta" ], "type": "object" }, "WorkflowsListWorkflowsResultV2": { "example": { "workflows": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "folder": "My folder 01", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -\u003e Affected Team", "type": "IncidentSeverity" } ], "runs_from": "2021-08-17T13:28:57.801578Z", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "label": "PagerDuty Escalate", "name": "pagerduty.escalate" } ], "trigger": { "label": "Incident Updated", "name": "incident.updated" }, "version": 3 } ] }, "properties": { "workflows": { "example": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "folder": "My folder 01", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -\u003e Affected Team", "type": "IncidentSeverity" } ], "runs_from": "2021-08-17T13:28:57.801578Z", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "label": "PagerDuty Escalate", "name": "pagerduty.escalate" } ], "trigger": { "label": "Incident Updated", "name": "incident.updated" }, "version": 3 } ], "items": { "$ref": "#/components/schemas/WorkflowSlimV2" }, "type": "array" } }, "required": [ "workflows" ], "type": "object" }, "WorkflowsShowWorkflowResultV2": { "example": { "management_meta": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "managed_by": "dashboard", "source_url": "https://github.com/my-company/infrastructure" }, "workflow": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "folder": "My folder 01", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -\u003e Affected Team", "type": "IncidentSeverity" } ], "runs_from": "2021-08-17T13:28:57.801578Z", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "for_each": "abc123", "id": "abc123", "label": "PagerDuty Escalate", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ] } ], "trigger": { "label": "Incident Updated", "name": "incident.updated" }, "version": 3 } }, "properties": { "management_meta": { "$ref": "#/components/schemas/ManagementMetaV2" }, "workflow": { "$ref": "#/components/schemas/WorkflowV2" } }, "required": [ "workflow", "management_meta" ], "type": "object" }, "WorkflowsUpdateWorkflowPayloadV2": { "example": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "folder": "My folder 01", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ "incident.url" ], "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "skip_step_upgrades": false, "state": "active", "steps": [ { "for_each": "abc123", "id": "abc123", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ] } ] }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that track metadata about this resource", "example": { "incident.io/terraform/version": "3.0.0" }, "type": "object" }, "condition_groups": { "description": "Conditions that apply to the workflow trigger", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" }, "continue_on_step_error": { "description": "Whether to continue executing the workflow if a step fails", "example": true, "type": "boolean" }, "delay": { "$ref": "#/components/schemas/WorkflowDelayV2" }, "expressions": { "description": "The expressions to use in the workflow", "example": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionPayloadV2" }, "type": "array" }, "folder": { "description": "Folder to display the workflow in", "example": "My folder 01", "type": "string" }, "include_private_escalations": { "description": "Whether to include private escalations", "example": true, "type": "boolean" }, "include_private_incidents": { "description": "Whether to include private incidents", "example": true, "type": "boolean" }, "name": { "description": "Name provided by the user when creating the workflow", "example": "My little workflow", "type": "string" }, "once_for": { "description": "This workflow will run 'once for' a list of references", "example": [ "incident.url" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "runs_on_incident_modes": { "description": "Which incident modes should this workflow run on? By default, workflows only run on standard incidents, but can also be configured to run on test and retrospective incidents.", "example": [ "standard", "test", "retrospective" ], "items": { "enum": [ "standard", "test", "retrospective" ], "example": "standard", "type": "string" }, "type": "array" }, "runs_on_incidents": { "description": "Which incidents should the workflow be applied to?", "enum": [ "newly_created", "newly_created_and_active" ], "example": "newly_created", "type": "string" }, "shortform": { "description": "The shortform used to trigger this workflow (only applicable for manual triggers)", "example": "page-the-ceo", "type": "string" }, "skip_step_upgrades": { "description": "Skips workflow step upgrades, when the parameters for an existing workflow step change", "example": false, "type": "boolean" }, "state": { "description": "What state this workflow is in", "enum": [ "active", "disabled", "draft", "error" ], "example": "active", "type": "string" }, "steps": { "description": "Steps that are executed as part of the workflow", "example": [ { "for_each": "abc123", "id": "abc123", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/StepConfigPayloadV2" }, "type": "array" } }, "required": [ "name", "once_for", "condition_groups", "steps", "expressions", "include_private_incidents", "runs_on_incident_modes", "continue_on_step_error", "runs_on_incidents" ], "type": "object" }, "WorkflowsUpdateWorkflowResultV2": { "example": { "management_meta": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "managed_by": "dashboard", "source_url": "https://github.com/my-company/infrastructure" }, "workflow": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "folder": "My folder 01", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -\u003e Affected Team", "type": "IncidentSeverity" } ], "runs_from": "2021-08-17T13:28:57.801578Z", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "for_each": "abc123", "id": "abc123", "label": "PagerDuty Escalate", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ] } ], "trigger": { "label": "Incident Updated", "name": "incident.updated" }, "version": 3 } }, "properties": { "management_meta": { "$ref": "#/components/schemas/ManagementMetaV2" }, "workflow": { "$ref": "#/components/schemas/WorkflowV2" } }, "required": [ "workflow", "management_meta" ], "type": "object" } } }, "externalDocs": { "description": "View our API docs at api-docs.incident.io", "url": "https://api-docs.incident.io/" }, "info": { "description": "This is the API reference for incident.io.\n\nIt documents available API endpoints, provides examples of how to use it, and\ninstructions around things like authentication and error handling.\n\nThe API is hosted at:\n\n- https://api.incident.io/\n\nAnd you will need to create an API key via your [incident.io\ndashboard](https://app.incident.io/settings/api-keys) to make requests.\n\n# Making requests\n\nHere are the key concepts required to make requests to the incident.io API.\n\n## Authentication\n\nFor all requests made to the incident.io API, you'll need an API key.\n\nTo create an API key, head to the incident dashboard and visit [API\nkeys](https://app.incident.io/settings/api-keys). When you create the key, you'll be able to choose what actions it\ncan take for your account: choose carefully, as those roles can only be set\nwhen you first create the key. We'll only show you the token once, so make sure\nyou store it somewhere safe.\n\nAPI keys are global to your incident.io account, and can be managed by anyone\nwho has the right permissions. We display the user that created the API key,\nand the API key will remain valid if that user becomes deactivated.\n\nOnce you have the key, you should make requests to the API that set the\n`Authorization` request header using a \"Bearer\" authentication scheme:\n\n```\nAuthorization: Bearer \u003cYOUR_API_KEY\u003e\n```\n\n## Rate Limits\n\nThe incident.io API enforces rate limits to ensure consistent performance for all users.\n\nThe default rate limit is 1200 requests/minute per API key. This limit applies to most endpoints across the API.\n\nSome endpoints have lower rate limits, particularly those that interact with external third-party systems that impose\ntheir own limitations. These specific limits vary by endpoint, and we recommend relying on the rate-limit error\nresponses to understand usage patterns and implement appropriate retry strategies.\n\nWhen you exceed a rate limit, the API will respond with a `429 Too Many Requests` status code, along with a JSON\nresponse that includes information about the limit and when you can retry:\n\n```json\n{\n \"type\": \"too_many_requests\",\n \"status\": 429,\n \"request_id\": \"b839a403-7704-41c1-bf6a-39a2d68caefa\",\n \"rate_limit\": {\n \"name\": \"api_key_name\",\n \"limit\": 1200,\n \"remaining\": 0,\n \"retry_after\": \"Thu, 17 Apr 2025 11:17:18 UTC\"\n },\n \"errors\": [\n {\n \"code\": \"too_many_requests\",\n \"message\": \"Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\"\n }\n ]\n}\n```\n\nThe response includes:\n* The name of the API key (`name`)\n* The bucket limit (`limit`)\n* The number of requests remaining (`remaining`)\n* When you can retry requests (`retry_after`)\n\n## Errors\n\nWe use standard HTTP response codes to indicate the status or failure of API\nrequests.\n\nThe API response body will be JSON, and contain more detailed information on the\nnature of the error.\n\nAn example error when a request is made without an API key:\n\n```json\n{\n \"type\": \"authentication_error\",\n \"status\": 401,\n \"request_id\": \"8e3cc412-b49d-4957-9073-2c19d2c61804\",\n \"errors\": [\n {\n \"code\": \"missing_authorization_material\",\n \"message\": \"No authorization material provided in request\"\n }\n ]\n}\n```\n\nNote that the error:\n\n- Contains the HTTP status (`401`)\n- References the type of error (`authentication_error`)\n- Includes a `request_id` that can be provided to incident.io support to help\n\tdebug questions with your API request\n- Provides a list of individual errors, which go into detail about why the error\n\toccurred\n\nThe most common error will be a 422 Validation Error, which is returned when the\nrequest was rejected due to failing validations.\n\nThese errors look like this:\n\n```json\n{\n \"type\": \"validation_error\",\n \"status\": 422,\n \"request_id\": \"631766c4-4afd-4803-997c-cd700928fa4b\",\n \"errors\": [\n {\n \"code\": \"is_required\",\n \"message\": \"A severity is required to open an incident\",\n \"source\": {\n \"field\": \"severity_id\"\n }\n }\n ]\n}\n```\n\nThis error is caused by not providing a severity identifier, which should be at\nthe `severity_id` field of the request payload. Errors like these can be mapped to\nforms, should you be integrating with the API from a user-interface.\n\n## Compatibility\n\nWe won't make breaking changes to existing API services or endpoints, but will\nexpect integrators to upgrade themselves to the latest API endpoints within 3\nmonths of us deprecating the old service.\n\nWe will make changes that are considered backwards compatible, which include:\n\n- Adding new API endpoints and services\n- Adding new properties to responses from existing API endpoints\n- Reordering properties returned from existing API endpoints\n- Adding optional request parameters to existing API endpoints\n- Altering the format or length of IDs\n- Adding new values to enums\n\nIt is important that clients are robust to these changes, to ensure reliable\nintegrations.\n\nAs an example, if you are generating a client using an openapi-generator, ensure\nthe generated client is configured to support unknown enum values, often\nconfigured via the `enumUnknownDefaultCase` parameter.\n\nWhen breaking changes are unavoidable, we'll create a new service version on a\nseparate path, and run them in parallel.\n\nFor example:\n\n- https://api.incident.io/v1/incidents\n- https://api.incident.io/v2/incidents\n\nFor any questions, email support@incident.io.\n", "title": "incident.io", "version": "1.0.0" }, "openapi": "3.0.3", "paths": { "/v1/actions": { "get": { "deprecated": true, "description": "List all actions for an organisation.", "operationId": "Actions V1#List", "parameters": [ { "allowEmptyValue": true, "description": "Find actions related to this incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "incident_id", "schema": { "description": "Find actions related to this incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter to actions marked as being follow up actions", "example": true, "in": "query", "name": "is_follow_up", "schema": { "description": "Filter to actions marked as being follow up actions", "example": true, "type": "boolean" } }, { "allowEmptyValue": true, "description": "Filter to actions from incidents of the given mode. If not set, only actions from `real` incidents are returned", "examples": { "default": { "summary": "default", "value": "real" } }, "in": "query", "name": "incident_mode", "schema": { "description": "Filter to actions from incidents of the given mode. If not set, only actions from `real` incidents are returned", "enum": [ "real", "test", "tutorial" ], "example": "real", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "actions": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "follow_up": true, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/ActionsListResultV1" } } }, "description": "OK response." } }, "summary": "List Actions V1", "tags": [ "Actions V1" ], "x-docs-display-name": "List", "x-docs-group-name": "Actions V1", "x-docs-resource-type": "ActionV1" } }, "/v1/actions/{id}": { "get": { "deprecated": true, "description": "Get a single incident action.", "operationId": "Actions V1#Show", "parameters": [ { "description": "Unique identifier for the action", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the action", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "action": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "follow_up": true, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/ActionsShowResultV1" } } }, "description": "OK response." } }, "summary": "Show Actions V1", "tags": [ "Actions V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "Actions V1", "x-docs-resource-type": "ActionV1" } }, "/v1/api_keys": { "get": { "description": "List API keys visible to the calling API key, with pagination. An API key with account-level `api_keys_manage` access will see all keys, while a key with the `api_keys_manage` role scoped to specific teams will only see keys belonging to those teams.\n\nThis endpoint requires a valid API key with the `api_keys_manage` role at either the account level or team level.", "operationId": "API Keys V1#List", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "api_keys": [ { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_used_at": "2021-08-17T13:28:57.801578Z", "name": "My test API key", "roles": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "team_ids": [ "abc123" ], "team_roles": [ { "description": "can view data, like public incidents and organization settings", "name": "schedules_editor" } ], "token_last_issued_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/APIKeysListResultV1" } } }, "description": "OK response." } }, "summary": "List API Keys V1", "tags": [ "API Keys V1" ], "x-docs-display-name": "List", "x-docs-group-name": "API Keys V1", "x-docs-resource-type": "APIKeyV1" }, "post": { "description": "Create a new API key. The calling API key can only assign roles whose scopes are a subset of its own. The `api_keys_manage` role cannot be assigned via the API. An organization can have a maximum of 5000 active API keys.\n\nThis endpoint requires a valid API key with the `api_keys_manage` role at either the account level or team level.", "operationId": "API Keys V1#Create", "requestBody": { "content": { "application/json": { "example": { "name": "My test API key", "role_names": [ "viewer", "incident_creator" ], "team_ids": [ "01FCNDV6P870EA6S7TK1DSYDG0" ], "team_role_names": [ "schedules_editor" ] }, "schema": { "$ref": "#/components/schemas/APIKeysCreatePayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "api_key": { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_used_at": "2021-08-17T13:28:57.801578Z", "name": "My test API key", "roles": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "team_ids": [ "abc123" ], "team_roles": [ { "description": "can view data, like public incidents and organization settings", "name": "schedules_editor" } ], "token_last_issued_at": "2021-08-17T13:28:57.801578Z" }, "token": "inc_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef" }, "schema": { "$ref": "#/components/schemas/APIKeysCreateResultV1" } } }, "description": "Created response." } }, "summary": "Create API Keys V1", "tags": [ "API Keys V1" ], "x-docs-display-name": "Create", "x-docs-group-name": "API Keys V1", "x-docs-resource-type": "APIKeyV1" } }, "/v1/api_keys/{id}": { "delete": { "description": "Delete an existing API key. The calling API key does not need to hold the scopes of the key being deleted, but a team-scoped key can only delete keys belonging to its teams.\n\nThis endpoint requires a valid API key with the `api_keys_manage` role at either the account level or team level.", "operationId": "API Keys V1#Delete", "parameters": [ { "description": "Unique identifier of the API key to delete", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the API key to delete", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." } }, "summary": "Delete API Keys V1", "tags": [ "API Keys V1" ], "x-docs-display-name": "Delete", "x-docs-group-name": "API Keys V1", "x-docs-resource-type": "APIKeyV1" }, "get": { "description": "Show details of a specific API key, including its roles, team assignments and when its token was last issued.\n\nThis endpoint requires a valid API key with the `api_keys_manage` role at either the account level or team level.", "operationId": "API Keys V1#Show", "parameters": [ { "description": "Unique identifier of the API key to retrieve", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the API key to retrieve", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "api_key": { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_used_at": "2021-08-17T13:28:57.801578Z", "name": "My test API key", "roles": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "team_ids": [ "abc123" ], "team_roles": [ { "description": "can view data, like public incidents and organization settings", "name": "schedules_editor" } ], "token_last_issued_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/APIKeysShowResultV1" } } }, "description": "OK response." } }, "summary": "Show API Keys V1", "tags": [ "API Keys V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "API Keys V1", "x-docs-resource-type": "APIKeyV1" }, "put": { "description": "Update an existing API key's name, roles, or team assignments. All fields must be provided (PUT semantics). The calling API key can only assign roles whose scopes are a subset of its own. An API key cannot edit itself, and the `api_keys_manage` role cannot be assigned via the API.\n\nThis endpoint requires a valid API key with the `api_keys_manage` role at either the account level or team level.", "operationId": "API Keys V1#Update", "parameters": [ { "description": "Unique identifier of the API key to update", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the API key to update", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "name": "My test API key", "role_names": [ "viewer", "incident_creator" ], "team_ids": [ "01FCNDV6P870EA6S7TK1DSYDG0" ], "team_role_names": [ "schedules_editor" ] }, "schema": { "$ref": "#/components/schemas/APIKeysUpdatePayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "api_key": { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_used_at": "2021-08-17T13:28:57.801578Z", "name": "My test API key", "roles": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "team_ids": [ "abc123" ], "team_roles": [ { "description": "can view data, like public incidents and organization settings", "name": "schedules_editor" } ], "token_last_issued_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/APIKeysUpdateResultV1" } } }, "description": "OK response." } }, "summary": "Update API Keys V1", "tags": [ "API Keys V1" ], "x-docs-display-name": "Update", "x-docs-group-name": "API Keys V1", "x-docs-resource-type": "APIKeyV1" } }, "/v1/api_keys/{id}/actions/rotate": { "post": { "description": "Rotate the access token for an API key. This generates a new bearer token and optionally keeps the old token valid for a configurable grace period (up to 60 minutes), allowing a seamless rollover without downtime. The calling API key must have all the scopes of the key being rotated.\n\nThis endpoint requires a valid API key with the `api_keys_manage` role at either the account level or team level.", "operationId": "API Keys V1#Rotate", "parameters": [ { "description": "Unique identifier of the API key to rotate", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the API key to rotate", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "grace_period_minutes": 30 }, "schema": { "$ref": "#/components/schemas/APIKeysRotatePayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "api_key": { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_used_at": "2021-08-17T13:28:57.801578Z", "name": "My test API key", "roles": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "team_ids": [ "abc123" ], "team_roles": [ { "description": "can view data, like public incidents and organization settings", "name": "schedules_editor" } ], "token_last_issued_at": "2021-08-17T13:28:57.801578Z" }, "token": "inc_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef" }, "schema": { "$ref": "#/components/schemas/APIKeysRotateResultV1" } } }, "description": "Created response." } }, "summary": "Rotate API Keys V1", "tags": [ "API Keys V1" ], "x-docs-display-name": "Rotate", "x-docs-group-name": "API Keys V1", "x-docs-resource-type": "APIKeyV1" } }, "/v1/custom_field_options": { "get": { "description": "Show custom field options for a custom field", "operationId": "Custom Field Options V1#List", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "type": "integer" } }, { "allowEmptyValue": true, "description": "A custom field option's ID. This endpoint will return a list of custom field options created after this option.", "examples": { "default": { "summary": "default", "value": "01G0J1EXE7AXZ2C93K61WBPYEH" } }, "in": "query", "name": "after", "schema": { "description": "A custom field option's ID. This endpoint will return a list of custom field options created after this option.", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } }, { "allowEmptyValue": true, "description": "The custom field to list options for.", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "in": "query", "name": "custom_field_id", "required": true, "schema": { "description": "The custom field to list options for.", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "custom_field_options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/CustomFieldOptionsListResultV1" } } }, "description": "OK response." } }, "summary": "List Custom Field Options V1", "tags": [ "Custom Field Options V1" ], "x-docs-display-name": "List", "x-docs-group-name": "Custom Field Options V1", "x-docs-resource-type": "CustomFieldOptionV1" }, "post": { "description": "Create a custom field option. If the sort key is not supplied, it'll default to 1000, so the option appears near the end of the list.", "operationId": "Custom Field Options V1#Create", "requestBody": { "content": { "application/json": { "example": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "schema": { "$ref": "#/components/schemas/CustomFieldOptionsCreatePayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "custom_field_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } }, "schema": { "$ref": "#/components/schemas/CustomFieldOptionsCreateResultV1" } } }, "description": "Created response." } }, "summary": "Create Custom Field Options V1", "tags": [ "Custom Field Options V1" ], "x-docs-display-name": "Create", "x-docs-group-name": "Custom Field Options V1", "x-docs-resource-type": "CustomFieldOptionV1" } }, "/v1/custom_field_options/{id}": { "delete": { "description": "Delete a custom field option", "operationId": "Custom Field Options V1#Delete", "parameters": [ { "description": "Unique identifier for the custom field option", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the custom field option", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." } }, "summary": "Delete Custom Field Options V1", "tags": [ "Custom Field Options V1" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Custom Field Options V1", "x-docs-resource-type": "CustomFieldOptionV1" }, "get": { "description": "Get a single custom field option", "operationId": "Custom Field Options V1#Show", "parameters": [ { "description": "Unique identifier for the custom field option", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the custom field option", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "custom_field_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } }, "schema": { "$ref": "#/components/schemas/CustomFieldOptionsShowResultV1" } } }, "description": "OK response." } }, "summary": "Show Custom Field Options V1", "tags": [ "Custom Field Options V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "Custom Field Options V1", "x-docs-resource-type": "CustomFieldOptionV1" }, "put": { "description": "Update a custom field option", "operationId": "Custom Field Options V1#Update", "parameters": [ { "description": "Unique identifier for the custom field option", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the custom field option", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "sort_key": 10, "value": "Product" }, "schema": { "$ref": "#/components/schemas/CustomFieldOptionsUpdatePayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "custom_field_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } }, "schema": { "$ref": "#/components/schemas/CustomFieldOptionsUpdateResultV1" } } }, "description": "OK response." } }, "summary": "Update Custom Field Options V1", "tags": [ "Custom Field Options V1" ], "x-docs-display-name": "Update", "x-docs-group-name": "Custom Field Options V1", "x-docs-resource-type": "CustomFieldOptionV1" } }, "/v1/custom_fields": { "get": { "deprecated": true, "description": "List all custom fields for an organisation.", "operationId": "Custom Fields V1#List", "responses": { "200": { "content": { "application/json": { "example": { "custom_fields": [ { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true, "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/CustomFieldsListResultV1" } } }, "description": "OK response." } }, "summary": "List Custom Fields V1", "tags": [ "Custom Fields V1" ], "x-docs-display-name": "List", "x-docs-group-name": "Custom Fields V1", "x-docs-resource-type": "CustomFieldV1" }, "post": { "deprecated": true, "description": "Create a new custom field", "operationId": "Custom Fields V1#Create", "requestBody": { "content": { "application/json": { "example": { "description": "Which team is impacted by this issue", "field_type": "single_select", "name": "Affected Team", "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true }, "schema": { "$ref": "#/components/schemas/CustomFieldsCreatePayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CustomFieldsCreateResultV1" } } }, "description": "Created response." } }, "summary": "Create Custom Fields V1", "tags": [ "Custom Fields V1" ], "x-docs-display-name": "Create", "x-docs-group-name": "Custom Fields V1", "x-docs-resource-type": "CustomFieldV1" } }, "/v1/custom_fields/{id}": { "delete": { "deprecated": true, "description": "Delete a custom field", "operationId": "Custom Fields V1#Delete", "parameters": [ { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." } }, "summary": "Delete Custom Fields V1", "tags": [ "Custom Fields V1" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Custom Fields V1", "x-docs-resource-type": "CustomFieldV1" }, "get": { "deprecated": true, "description": "Get a single custom field.", "operationId": "Custom Fields V1#Show", "parameters": [ { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CustomFieldsShowResultV1" } } }, "description": "OK response." } }, "summary": "Show Custom Fields V1", "tags": [ "Custom Fields V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "Custom Fields V1", "x-docs-resource-type": "CustomFieldV1" }, "put": { "deprecated": true, "description": "Update the details of a custom field", "operationId": "Custom Fields V1#Update", "parameters": [ { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "Which team is impacted by this issue", "name": "Affected Team", "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true }, "schema": { "$ref": "#/components/schemas/CustomFieldsUpdatePayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "required": "never", "required_v2": "never", "show_before_closure": true, "show_before_creation": true, "show_before_update": true, "show_in_announcement_post": true, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CustomFieldsUpdateResultV1" } } }, "description": "OK response." } }, "summary": "Update Custom Fields V1", "tags": [ "Custom Fields V1" ], "x-docs-display-name": "Update", "x-docs-group-name": "Custom Fields V1", "x-docs-resource-type": "CustomFieldV1" } }, "/v1/identity": { "get": { "description": "Test if your API key is valid, and which roles it has.", "operationId": "Utilities V1#Identity", "responses": { "200": { "content": { "application/json": { "example": { "identity": { "dashboard_url": "https://app.incident.io/my-org", "name": "Alertmanager token", "roles": [ "viewer" ], "team_roles": [ "schedules_editor" ], "teams": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Platform" } ] } }, "schema": { "$ref": "#/components/schemas/UtilitiesIdentityResultV1" } } }, "description": "OK response." } }, "summary": "Identity Utilities V1", "tags": [ "Utilities V1" ], "x-docs-display-name": "Show Identity", "x-docs-group-name": "Utilities V1" } }, "/v1/incident_attachments": { "get": { "description": "List all incident attachments for a given external resource or incident. You must provide either a specific incident ID or a specific external resource type and external ID.", "operationId": "Incident Attachments V1#List", "parameters": [ { "allowEmptyValue": true, "description": "Incident that this attachment is against", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "in": "query", "name": "incident_id", "schema": { "description": "Incident that this attachment is against", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } }, { "allowEmptyValue": true, "description": "ID of the resource in the external system", "example": "123", "in": "query", "name": "external_id", "schema": { "description": "ID of the resource in the external system", "example": "123", "type": "string" } }, { "allowEmptyValue": true, "description": "E.g. PagerDuty: the external system that holds the resource", "examples": { "default": { "summary": "default", "value": "pager_duty_incident" } }, "in": "query", "name": "resource_type", "schema": { "description": "E.g. PagerDuty: the external system that holds the resource", "enum": [ "pager_duty_incident", "opsgenie_alert", "datadog_monitor_alert", "github_pull_request", "gitlab_merge_request", "sentry_issue", "jira_issue", "jsm_alert", "atlassian_statuspage_incident", "zendesk_ticket", "google_calendar_event", "outlook_calendar_event", "slack_file", "salesforce_case", "scrubbed", "statuspage_incident" ], "example": "pager_duty_incident", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_attachments": [ { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "resource": { "external_id": "123", "permalink": "https://my.pagerduty.com/incidents/ABC", "resource_type": "pager_duty_incident", "title": "The database has gone down" } } ] }, "schema": { "$ref": "#/components/schemas/IncidentAttachmentsListResultV1" } } }, "description": "OK response." } }, "summary": "List Incident Attachments V1", "tags": [ "Incident Attachments V1" ], "x-docs-display-name": "List", "x-docs-group-name": "Incident Attachments V1", "x-docs-resource-type": "IncidentAttachmentV1" }, "post": { "description": "Attaches an external resource to an incident", "operationId": "Incident Attachments V1#Create", "requestBody": { "content": { "application/json": { "example": { "incident_id": "01FDAG4SAP5TYPT98WGR2N7W91", "resource": { "external_id": "123", "resource_type": "pager_duty_incident" } }, "schema": { "$ref": "#/components/schemas/IncidentAttachmentsCreatePayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "incident_attachment": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "resource": { "external_id": "123", "permalink": "https://my.pagerduty.com/incidents/ABC", "resource_type": "pager_duty_incident", "title": "The database has gone down" } } }, "schema": { "$ref": "#/components/schemas/IncidentAttachmentsCreateResultV1" } } }, "description": "Created response." } }, "summary": "Create Incident Attachments V1", "tags": [ "Incident Attachments V1" ], "x-docs-display-name": "Create", "x-docs-group-name": "Incident Attachments V1", "x-docs-resource-type": "IncidentAttachmentV1" } }, "/v1/incident_attachments/{id}": { "delete": { "description": "Unattaches an external resource from an incident", "operationId": "Incident Attachments V1#Delete", "parameters": [ { "description": "Unique identifier of this incident membership", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of this incident membership", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "responses": { "204": { "description": "No Content response." } }, "summary": "Delete Incident Attachments V1", "tags": [ "Incident Attachments V1" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Incident Attachments V1", "x-docs-resource-type": "IncidentAttachmentV1" } }, "/v1/incident_memberships": { "post": { "description": "Makes a user a member of a private incident", "operationId": "Incident Memberships V1#Create", "requestBody": { "content": { "application/json": { "example": { "incident_id": "01ET65M7ZADYFCKD4K1AE2QNMC", "user_id": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "schema": { "$ref": "#/components/schemas/IncidentMembershipsCreatePayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "incident_membership": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "updated_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } } }, "schema": { "$ref": "#/components/schemas/IncidentMembershipsCreateResultV1" } } }, "description": "Created response." } }, "summary": "Create Incident Memberships V1", "tags": [ "Incident Memberships V1" ], "x-docs-display-name": "Create", "x-docs-group-name": "Incident Memberships V1", "x-docs-resource-type": "IncidentMembershipV1" } }, "/v1/incident_memberships/actions/revoke": { "post": { "description": "Revoke a user's membership of a private incident", "operationId": "Incident Memberships V1#Revoke", "requestBody": { "content": { "application/json": { "example": { "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "user_id": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "schema": { "$ref": "#/components/schemas/IncidentMembershipsRevokePayloadV1" } } }, "required": true }, "responses": { "204": { "description": "No Content response." } }, "summary": "Revoke Incident Memberships V1", "tags": [ "Incident Memberships V1" ], "x-docs-display-name": "Revoke", "x-docs-group-name": "Incident Memberships V1", "x-docs-resource-type": "IncidentMembershipV1" } }, "/v1/incident_relationships": { "get": { "description": "List related incidents for a specific incident.", "operationId": "Incident Relationships V1#List", "parameters": [ { "allowEmptyValue": true, "description": "ID of the incident to find relationships for", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "in": "query", "name": "incident_id", "required": true, "schema": { "description": "ID of the incident to find relationships for", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } }, { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_relationships": [ { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "incident": { "external_id": 123, "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "The database is down" } } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/IncidentRelationshipsListResultV1" } } }, "description": "OK response." } }, "summary": "List Incident Relationships V1", "tags": [ "Incident Relationships V1" ], "x-docs-display-name": "List", "x-docs-group-name": "Incident Relationships V1", "x-docs-resource-type": "IncidentRelationshipV1" } }, "/v1/incident_roles": { "get": { "deprecated": true, "description": "List all incident roles for an organisation.", "operationId": "Incident Roles V1#List", "responses": { "200": { "content": { "application/json": { "example": { "incident_roles": [ { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/IncidentRolesListResultV1" } } }, "description": "OK response." } }, "summary": "List Incident Roles V1", "tags": [ "Incident Roles V1" ], "x-docs-display-name": "List", "x-docs-group-name": "Incident Roles V1", "x-docs-resource-type": "IncidentRoleV1" }, "post": { "deprecated": true, "description": "Create a new incident role", "operationId": "Incident Roles V1#Create", "requestBody": { "content": { "application/json": { "example": { "description": "The person currently coordinating the incident", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "shortform": "lead" }, "schema": { "$ref": "#/components/schemas/IncidentRolesCreatePayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/IncidentRolesCreateResultV1" } } }, "description": "Created response." } }, "summary": "Create Incident Roles V1", "tags": [ "Incident Roles V1" ], "x-docs-display-name": "Create", "x-docs-group-name": "Incident Roles V1", "x-docs-resource-type": "IncidentRoleV1" } }, "/v1/incident_roles/{id}": { "delete": { "deprecated": true, "description": "Removes an existing role", "operationId": "Incident Roles V1#Delete", "parameters": [ { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." } }, "summary": "Delete Incident Roles V1", "tags": [ "Incident Roles V1" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Incident Roles V1", "x-docs-resource-type": "IncidentRoleV1" }, "get": { "deprecated": true, "description": "Get a single incident role.", "operationId": "Incident Roles V1#Show", "parameters": [ { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/IncidentRolesShowResultV1" } } }, "description": "OK response." } }, "summary": "Show Incident Roles V1", "tags": [ "Incident Roles V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "Incident Roles V1", "x-docs-resource-type": "IncidentRoleV1" }, "put": { "deprecated": true, "description": "Update an existing incident role", "operationId": "Incident Roles V1#Update", "parameters": [ { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "The person currently coordinating the incident", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "shortform": "lead" }, "schema": { "$ref": "#/components/schemas/IncidentRolesUpdatePayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/IncidentRolesUpdateResultV1" } } }, "description": "OK response." } }, "summary": "Update Incident Roles V1", "tags": [ "Incident Roles V1" ], "x-docs-display-name": "Update", "x-docs-group-name": "Incident Roles V1", "x-docs-resource-type": "IncidentRoleV1" } }, "/v1/incident_statuses": { "get": { "description": "List all incident statuses for an organisation.", "operationId": "Incident Statuses V1#List", "responses": { "200": { "content": { "application/json": { "example": { "incident_statuses": [ { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/IncidentStatusesListResultV1" } } }, "description": "OK response." } }, "summary": "List Incident Statuses V1", "tags": [ "Incident Statuses V1" ], "x-docs-display-name": "List", "x-docs-group-name": "Incident Statuses V1", "x-docs-resource-type": "IncidentStatusV1" }, "post": { "description": "Create a new incident status", "operationId": "Incident Statuses V1#Create", "requestBody": { "content": { "application/json": { "example": { "category": "live", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "name": "Closed" }, "schema": { "$ref": "#/components/schemas/IncidentStatusesCreatePayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/IncidentStatusesCreateResultV1" } } }, "description": "Created response." } }, "summary": "Create Incident Statuses V1", "tags": [ "Incident Statuses V1" ], "x-docs-display-name": "Create", "x-docs-group-name": "Incident Statuses V1", "x-docs-resource-type": "IncidentStatusV1" } }, "/v1/incident_statuses/{id}": { "delete": { "description": "Delete an incident status", "operationId": "Incident Statuses V1#Delete", "parameters": [ { "description": "Unique ID of this incident status", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique ID of this incident status", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "responses": { "202": { "description": "Accepted response." } }, "summary": "Delete Incident Statuses V1", "tags": [ "Incident Statuses V1" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Incident Statuses V1", "x-docs-resource-type": "IncidentStatusV1" }, "get": { "description": "Get a single incident status.", "operationId": "Incident Statuses V1#Show", "parameters": [ { "description": "Unique ID of this incident status", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique ID of this incident status", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/IncidentStatusesShowResultV1" } } }, "description": "OK response." } }, "summary": "Show Incident Statuses V1", "tags": [ "Incident Statuses V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "Incident Statuses V1", "x-docs-resource-type": "IncidentStatusV1" }, "put": { "description": "Update an existing incident status", "operationId": "Incident Statuses V1#Update", "parameters": [ { "description": "Unique ID of this incident status", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique ID of this incident status", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "name": "Closed" }, "schema": { "$ref": "#/components/schemas/IncidentStatusesUpdatePayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/IncidentStatusesUpdateResultV1" } } }, "description": "OK response." } }, "summary": "Update Incident Statuses V1", "tags": [ "Incident Statuses V1" ], "x-docs-display-name": "Update", "x-docs-group-name": "Incident Statuses V1", "x-docs-resource-type": "IncidentStatusV1" } }, "/v1/incident_types": { "get": { "description": "List all incident types for an organisation.", "operationId": "Incident Types V1#List", "responses": { "200": { "content": { "application/json": { "example": { "incident_types": [ { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/IncidentTypesListResultV1" } } }, "description": "OK response." } }, "summary": "List Incident Types V1", "tags": [ "Incident Types V1" ], "x-docs-display-name": "List", "x-docs-group-name": "Incident Types V1", "x-docs-resource-type": "IncidentTypeV1" } }, "/v1/incident_types/{id}": { "get": { "description": "Get a single incident type.", "operationId": "Incident Types V1#Show", "parameters": [ { "description": "Unique identifier for this Incident Type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for this Incident Type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/IncidentTypesShowResultV1" } } }, "description": "OK response." } }, "summary": "Show Incident Types V1", "tags": [ "Incident Types V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "Incident Types V1", "x-docs-resource-type": "IncidentTypeV1" } }, "/v1/incidents": { "get": { "deprecated": true, "description": "List all incidents for an organisation.", "operationId": "Incidents V1#List", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 500, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter for incidents in these statuses", "examples": { "default": { "summary": "default", "value": [ "declined" ] } }, "in": "query", "name": "status", "schema": { "description": "Filter for incidents in these statuses", "example": [ "declined" ], "items": { "example": "declined", "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incidents": [ { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "real", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "status": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "timestamps": [ { "last_occurred_at": "2021-08-17T13:28:57.801578Z", "name": "last_activity" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 } }, "schema": { "$ref": "#/components/schemas/IncidentsListResultV1" } } }, "description": "OK response." } }, "summary": "List Incidents V1", "tags": [ "Incidents V1" ], "x-docs-display-name": "List", "x-docs-group-name": "Incidents V1", "x-docs-resource-type": "IncidentV1" }, "post": { "deprecated": true, "description": "Create a new incident.", "operationId": "Incidents V1#Create", "requestBody": { "content": { "application/json": { "example": { "custom_field_entries": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] } ], "idempotency_key": "alert-uuid", "incident_role_assignments": [ { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" } ], "incident_type_id": "01FH5TZRWMNAFB0DZ23FD1TV96", "mode": "real", "name": "Our database is sad", "severity_id": "01FH5TZRWMNAFB0DZ23FD1TV96", "slack_team_id": "T02A1FSLE8J", "source_message_channel_id": "C02AW36C1M5", "source_message_timestamp": "1653650280.526509", "status": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" }, "schema": { "$ref": "#/components/schemas/IncidentsCreatePayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "incident": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "real", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "status": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "timestamps": [ { "last_occurred_at": "2021-08-17T13:28:57.801578Z", "name": "last_activity" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public" } }, "schema": { "$ref": "#/components/schemas/IncidentsCreateResultV1" } } }, "description": "OK response." } }, "summary": "Create Incidents V1", "tags": [ "Incidents V1" ], "x-docs-display-name": "Create", "x-docs-group-name": "Incidents V1", "x-docs-resource-type": "IncidentV1" } }, "/v1/incidents/{id}": { "get": { "deprecated": true, "description": "Get a single incident.", "operationId": "Incidents V1#Show", "parameters": [ { "description": "Unique identifier for the incident", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the incident", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "real", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "status": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "timestamps": [ { "last_occurred_at": "2021-08-17T13:28:57.801578Z", "name": "last_activity" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public" } }, "schema": { "$ref": "#/components/schemas/IncidentsShowResultV1" } } }, "description": "OK response." } }, "summary": "Show Incidents V1", "tags": [ "Incidents V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "Incidents V1", "x-docs-resource-type": "IncidentV1" } }, "/v1/ip_allowlists": { "get": { "description": "Show the IP allowlist for your organisation", "operationId": "IPAllowlists V1#ShowIPAllowlist", "responses": { "200": { "content": { "application/json": { "example": { "ip_allowlist": { "allowlist": [ { "label": "London HQ", "value": "192.0.2.0" } ], "enabled": true, "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "schema": { "$ref": "#/components/schemas/IPAllowlistsShowIPAllowlistResultV1" } } }, "description": "OK response." } }, "summary": "ShowIPAllowlist IPAllowlists V1", "tags": [ "IPAllowlists V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "IPAllowlists V1", "x-docs-resource-type": "IPAllowlistV1" }, "put": { "description": "Update the IP allowlist for your organisation", "operationId": "IPAllowlists V1#UpdateIPAllowlist", "requestBody": { "content": { "application/json": { "example": { "allowlist": [ { "label": "London HQ", "value": "192.0.2.0" } ], "enabled": true, "version": 1 }, "schema": { "$ref": "#/components/schemas/IPAllowlistsUpdateIPAllowlistPayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "ip_allowlist": { "allowlist": [ { "label": "London HQ", "value": "192.0.2.0" } ], "enabled": true, "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "schema": { "$ref": "#/components/schemas/IPAllowlistsUpdateIPAllowlistResultV1" } } }, "description": "OK response." } }, "summary": "UpdateIPAllowlist IPAllowlists V1", "tags": [ "IPAllowlists V1" ], "x-docs-display-name": "Update", "x-docs-group-name": "IPAllowlists V1", "x-docs-resource-type": "IPAllowlistV1" } }, "/v1/maintenance_windows": { "get": { "description": "List maintenance windows for your organisation.", "operationId": "MaintenanceWindows V1#List", "parameters": [ { "allowEmptyValue": true, "description": "Number of maintenance windows to return per page", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Number of maintenance windows to return per page", "example": 25, "format": "int64", "maximum": 50, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "The ID of the last maintenance window on the previous page", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "query", "name": "after", "schema": { "description": "The ID of the last maintenance window on the previous page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter by window status: active (start_at \u003c= now \u003c end_at), upcoming (now \u003c start_at), or past (end_at \u003c= now)", "example": "active", "in": "query", "name": "status", "schema": { "description": "Filter by window status: active (start_at \u003c= now \u003c end_at), upcoming (now \u003c start_at), or past (end_at \u003c= now)", "enum": [ "active", "upcoming", "past" ], "example": "active", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "maintenance_windows": [ { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/MaintenanceWindowsListResultV1" } } }, "description": "OK response." } }, "summary": "List MaintenanceWindows V1", "tags": [ "MaintenanceWindows V1" ], "x-docs-display-name": "List", "x-docs-group-name": "MaintenanceWindows V1", "x-docs-resource-type": "MaintenanceWindowV1" }, "post": { "description": "Create a new maintenance window.", "operationId": "MaintenanceWindows V1#Create", "requestBody": { "content": { "application/json": { "example": { "alert_condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public" } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z" }, "schema": { "$ref": "#/components/schemas/MaintenanceWindowsCreatePayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "maintenance_window": { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/MaintenanceWindowsCreateResultV1" } } }, "description": "Created response." } }, "summary": "Create MaintenanceWindows V1", "tags": [ "MaintenanceWindows V1" ], "x-docs-display-name": "Create", "x-docs-group-name": "MaintenanceWindows V1", "x-docs-resource-type": "MaintenanceWindowV1" } }, "/v1/maintenance_windows/{id}": { "delete": { "description": "Archives a maintenance window. Cannot archive active windows.", "operationId": "MaintenanceWindows V1#Delete", "parameters": [ { "description": "Unique identifier of the maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." } }, "summary": "Delete MaintenanceWindows V1", "tags": [ "MaintenanceWindows V1" ], "x-docs-display-name": "Delete", "x-docs-group-name": "MaintenanceWindows V1", "x-docs-resource-type": "MaintenanceWindowV1" }, "get": { "description": "Show a particular maintenance window.", "operationId": "MaintenanceWindows V1#Show", "parameters": [ { "description": "Unique identifier of the maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "maintenance_window": { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/MaintenanceWindowsShowResultV1" } } }, "description": "OK response." } }, "summary": "Show MaintenanceWindows V1", "tags": [ "MaintenanceWindows V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "MaintenanceWindows V1", "x-docs-resource-type": "MaintenanceWindowV1" }, "put": { "description": "Update an existing maintenance window.", "operationId": "MaintenanceWindows V1#Update", "parameters": [ { "description": "Unique identifier of the maintenance window", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "alert_condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public" } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z" }, "schema": { "$ref": "#/components/schemas/MaintenanceWindowsUpdatePayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "maintenance_window": { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/MaintenanceWindowsUpdateResultV1" } } }, "description": "OK response." } }, "summary": "Update MaintenanceWindows V1", "tags": [ "MaintenanceWindows V1" ], "x-docs-display-name": "Update", "x-docs-group-name": "MaintenanceWindows V1", "x-docs-resource-type": "MaintenanceWindowV1" } }, "/v1/openapi.json": { "get": { "deprecated": true, "description": "Get the OpenAPI (v2) definition.\n\n**DEPRECATED**: Please use the OpenAPIV3 endpoint instead. The schema returned from this endpoint does not contain new options and endpoints added in 2025 and later.", "operationId": "Utilities V1#OpenAPI", "responses": { "200": { "content": { "application/json": { "schema": { "format": "binary", "type": "string" } } }, "description": "OK response." } }, "summary": "OpenAPI Utilities V1", "tags": [ "Utilities V1" ], "x-docs-display-name": "Show OpenAPI V2 Spec", "x-docs-group-name": "Utilities V1" } }, "/v1/openapiV3.json": { "get": { "description": "Get the OpenAPI (v3) definition.", "operationId": "Utilities V1#OpenAPIV3", "responses": { "200": { "content": { "application/json": { "schema": { "format": "binary", "type": "string" } } }, "description": "OK response." } }, "summary": "OpenAPIV3 Utilities V1", "tags": [ "Utilities V1" ], "x-docs-display-name": "Show OpenAPI V3 Spec", "x-docs-group-name": "Utilities V1" } }, "/v1/postmortem_documents": { "get": { "description": "List post-mortem documents for the organisation.\n\nResults can be filtered by incident and sorted by creation date. This endpoint returns document\nmetadata only. If you want to fetch the content of the post-mortem, use the ShowContent endpoint.\n", "operationId": "PostmortemDocuments V1#List", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "type": "integer" } }, { "allowEmptyValue": true, "description": "A post-mortem document's ID. This endpoint will return a list of post-mortem documents after this ID.", "examples": { "default": { "summary": "default", "value": "01G0J1EXE7AXZ2C93K61WBPYEH" } }, "in": "query", "name": "after", "schema": { "description": "A post-mortem document's ID. This endpoint will return a list of post-mortem documents after this ID.", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter to only return post-mortem documents for the given incident", "example": "01GBA8J19SMXQWPJMX3P2ESCVG", "in": "query", "name": "incident_id", "schema": { "description": "Filter to only return post-mortem documents for the given incident", "example": "01GBA8J19SMXQWPJMX3P2ESCVG", "type": "string" } }, { "allowEmptyValue": true, "description": "Controls the order that results are returned in", "example": "created_at_oldest_first", "in": "query", "name": "sort_by", "schema": { "default": "created_at_newest_first", "description": "Controls the order that results are returned in", "enum": [ "created_at_newest_first", "created_at_oldest_first" ], "example": "created_at_oldest_first", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "postmortem_documents": [ { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" } ] }, "schema": { "$ref": "#/components/schemas/PostmortemDocumentsListResultV1" } } }, "description": "OK response." } }, "summary": "List PostmortemDocuments V1", "tags": [ "PostmortemDocuments V1" ], "x-docs-display-name": "List", "x-docs-group-name": "PostmortemDocuments V1", "x-docs-resource-type": "PostmortemDocumentV1" } }, "/v1/postmortem_documents/{id}": { "get": { "description": "Get a single post-mortem document by ID.\n\nThis returns the document's metadata. To retrieve the content of the post-mortem, use the ShowContent endpoint.\n", "operationId": "PostmortemDocuments V1#Show", "parameters": [ { "description": "Unique identifier for the post-mortem document", "example": "01GDZEW57FDA1K4S63MGMQ5DS9", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the post-mortem document", "example": "01GDZEW57FDA1K4S63MGMQ5DS9", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "postmortem_document": { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" } }, "schema": { "$ref": "#/components/schemas/PostmortemDocumentsShowResultV1" } } }, "description": "OK response." } }, "summary": "Show PostmortemDocuments V1", "tags": [ "PostmortemDocuments V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "PostmortemDocuments V1", "x-docs-resource-type": "PostmortemDocumentV1" }, "put": { "description": "Update the status of a post-mortem document.", "operationId": "PostmortemDocuments V1#UpdateStatus", "parameters": [ { "description": "Unique identifier for the post-mortem document", "example": "01GDZEW57FDA1K4S63MGMQ5DS9", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the post-mortem document", "example": "01GDZEW57FDA1K4S63MGMQ5DS9", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "status": "completed" }, "schema": { "$ref": "#/components/schemas/PostmortemDocumentsUpdateStatusPayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "postmortem_document": { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" } }, "schema": { "$ref": "#/components/schemas/PostmortemDocumentsUpdateStatusResultV1" } } }, "description": "OK response." } }, "summary": "UpdateStatus PostmortemDocuments V1", "tags": [ "PostmortemDocuments V1" ], "x-docs-display-name": "Update", "x-docs-group-name": "PostmortemDocuments V1", "x-docs-resource-type": "PostmortemDocumentV1" } }, "/v1/postmortem_documents/{id}/content": { "get": { "description": "Fetch the content of a post-mortem document, rendered as markdown.\n\nThe response contains the full document content as a single markdown string. The markdown\nfollows standard formatting and is structured to mirror the post-mortem as it appears in\nthe incident.io dashboard:\n\n- **Headings** (`#`, `##`, `###`) for document title and sections\n- **Bold** and *italic* text formatting\n- Bullet lists and numbered lists\n- [Links](url) to external resources, Slack threads, and pull requests\n- Mentions of users, incidents, and catalog entries resolved to their display names\n- Custom field values rendered as labelled bullet lists\n- Timeline entries grouped by date with timestamps\n- Follow-ups with assignees and descriptions\n\nTo preview what this markdown will look like for a given post-mortem, open the document\nin the incident.io dashboard and use the \"Copy to clipboard\" button. The copied content\nuses the same rendering pipeline as this endpoint.\n\nIf you only need document metadata, use the Show or List endpoints instead.\n", "operationId": "PostmortemDocuments V1#ShowContent", "parameters": [ { "description": "Unique identifier for the post-mortem document", "example": "01GDZEW57FDA1K4S63MGMQ5DS9", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the post-mortem document", "example": "01GDZEW57FDA1K4S63MGMQ5DS9", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "markdown": "# Incident Postmortem\n\n## Summary\n\nThis incident was investigated by Alice Smith and affected the API Gateway service.\n\n## Timeline\n\n### 2024-06-15 (UTC)\n\n* [10:30] **Alert fired**\n\n* [10:35] **Incident declared**\n\n## Follow-ups\n\n* **Add monitoring** - Assignee: Alice Smith\n" }, "schema": { "$ref": "#/components/schemas/PostmortemDocumentsShowContentResultV1" } } }, "description": "OK response." } }, "summary": "ShowContent PostmortemDocuments V1", "tags": [ "PostmortemDocuments V1" ], "x-docs-display-name": "Show Content", "x-docs-group-name": "PostmortemDocuments V1", "x-docs-resource-type": "PostmortemDocumentV1" } }, "/v1/severities": { "get": { "description": "List all incident severities for an organisation.", "operationId": "Severities V1#List", "responses": { "200": { "content": { "application/json": { "example": { "severities": [ { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/SeveritiesListResultV1" } } }, "description": "OK response." } }, "summary": "List Severities V1", "tags": [ "Severities V1" ], "x-docs-display-name": "List", "x-docs-group-name": "Severities V1", "x-docs-resource-type": "SeverityV1" }, "post": { "description": "Create a new severity", "operationId": "Severities V1#Create", "requestBody": { "content": { "application/json": { "example": { "description": "Issues with **low impact**.", "name": "Minor", "rank": 1 }, "schema": { "$ref": "#/components/schemas/SeveritiesCreatePayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/SeveritiesCreateResultV1" } } }, "description": "Created response." } }, "summary": "Create Severities V1", "tags": [ "Severities V1" ], "x-docs-display-name": "Create", "x-docs-group-name": "Severities V1", "x-docs-resource-type": "SeverityV1" } }, "/v1/severities/{id}": { "delete": { "description": "Delete a severity", "operationId": "Severities V1#Delete", "parameters": [ { "description": "Unique identifier of the severity", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the severity", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "202": { "description": "Accepted response." } }, "summary": "Delete Severities V1", "tags": [ "Severities V1" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Severities V1", "x-docs-resource-type": "SeverityV1" }, "get": { "description": "Get a single incident severity.", "operationId": "Severities V1#Show", "parameters": [ { "description": "Unique identifier of the severity", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the severity", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/SeveritiesShowResultV1" } } }, "description": "OK response." } }, "summary": "Show Severities V1", "tags": [ "Severities V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "Severities V1", "x-docs-resource-type": "SeverityV1" }, "put": { "description": "Update an existing severity", "operationId": "Severities V1#Update", "parameters": [ { "description": "Unique identifier of the severity", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the severity", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "Issues with **low impact**.", "name": "Minor", "rank": 1 }, "schema": { "$ref": "#/components/schemas/SeveritiesUpdatePayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/SeveritiesUpdateResultV1" } } }, "description": "OK response." } }, "summary": "Update Severities V1", "tags": [ "Severities V1" ], "x-docs-display-name": "Update", "x-docs-group-name": "Severities V1", "x-docs-resource-type": "SeverityV1" } }, "/v1/status-pages/{id}/incidents/{incident_id}/response-incidents": { "get": { "description": "List the linked Response incidents for a status page incident.", "operationId": "Status Pages V1#ListResponseIncidents", "parameters": [ { "description": "ID of the status page", "example": "abc123", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of the status page", "example": "abc123", "type": "string" } }, { "description": "ID of the status page incident", "example": "abc123", "in": "path", "name": "incident_id", "required": true, "schema": { "description": "ID of the status page incident", "example": "abc123", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incidents": [ { "id": "01FDAG4SAH3GYPT98WGR2N7W91", "linked_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/StatusPagesListResponseIncidentsResultV1" } } }, "description": "OK response." } }, "summary": "ListResponseIncidents Status Pages V1", "tags": [ "Status Pages V1" ], "x-display-name": "List", "x-docs-display-name": "List", "x-docs-group-name": "Status Page Response Incidents V1", "x-docs-resource-type": "StatusPageLinkedResponseIncidentV1" } }, "/v2/actions": { "get": { "description": "List all actions for an organisation.", "operationId": "Actions V2#List", "parameters": [ { "allowEmptyValue": true, "description": "Find actions related to this incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "incident_id", "schema": { "description": "Find actions related to this incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter to actions from incidents of the given mode. If not set, only actions from `standard` and `retrospective` incidents are returned", "examples": { "default": { "summary": "default", "value": "standard" } }, "in": "query", "name": "incident_mode", "schema": { "description": "Filter to actions from incidents of the given mode. If not set, only actions from `standard` and `retrospective` incidents are returned", "enum": [ "standard", "retrospective", "test", "tutorial", "stream" ], "example": "standard", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "actions": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/ActionsListResultV2" } } }, "description": "OK response." } }, "summary": "List Actions V2", "tags": [ "Actions V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Actions V2", "x-docs-resource-type": "ActionV2" } }, "/v2/actions/{id}": { "get": { "description": "Get a single incident action.", "operationId": "Actions V2#Show", "parameters": [ { "description": "Unique identifier for the action", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the action", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "action": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/ActionsShowResultV2" } } }, "description": "OK response." } }, "summary": "Show Actions V2", "tags": [ "Actions V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Actions V2", "x-docs-resource-type": "ActionV2" } }, "/v2/alert_attributes": { "get": { "description": "List alert attributes.", "operationId": "Alert Attributes V2#List", "responses": { "200": { "content": { "application/json": { "example": { "alert_attributes": [ { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" } ] }, "schema": { "$ref": "#/components/schemas/AlertAttributesListResultV2" } } }, "description": "OK response." } }, "summary": "List Alert Attributes V2", "tags": [ "Alert Attributes V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Alert Attributes V2", "x-docs-resource-type": "AlertAttributeV2" }, "post": { "description": "Create a new alert attribute.", "operationId": "Alert Attributes V2#Create", "requestBody": { "content": { "application/json": { "example": { "array": false, "emoji": "fire", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "schema": { "$ref": "#/components/schemas/AlertAttributesCreatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "alert_attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" } }, "schema": { "$ref": "#/components/schemas/AlertAttributesCreateResultV2" } } }, "description": "Created response." } }, "summary": "Create Alert Attributes V2", "tags": [ "Alert Attributes V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Alert Attributes V2", "x-docs-resource-type": "AlertAttributeV2" } }, "/v2/alert_attributes/{id}": { "delete": { "description": "Destroy an alert attribute.", "operationId": "Alert Attributes V2#Destroy", "parameters": [ { "description": "The ID of this attribute", "example": "01GW2G3V0S59R238FAHPDS1R66", "in": "path", "name": "id", "required": true, "schema": { "description": "The ID of this attribute", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" } } ], "responses": { "204": { "description": "No Content response." } }, "summary": "Destroy Alert Attributes V2", "tags": [ "Alert Attributes V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Alert Attributes V2", "x-docs-resource-type": "AlertAttributeV2" }, "get": { "description": "Show an alert attribute.", "operationId": "Alert Attributes V2#Show", "parameters": [ { "description": "The ID of this attribute", "example": "01GW2G3V0S59R238FAHPDS1R66", "in": "path", "name": "id", "required": true, "schema": { "description": "The ID of this attribute", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "alert_attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" } }, "schema": { "$ref": "#/components/schemas/AlertAttributesShowResultV2" } } }, "description": "OK response." } }, "summary": "Show Alert Attributes V2", "tags": [ "Alert Attributes V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Alert Attributes V2", "x-docs-resource-type": "AlertAttributeV2" }, "put": { "description": "Update an alert attribute.", "operationId": "Alert Attributes V2#Update", "parameters": [ { "description": "The ID of this attribute", "example": "01GW2G3V0S59R238FAHPDS1R66", "in": "path", "name": "id", "required": true, "schema": { "description": "The ID of this attribute", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "array": false, "emoji": "fire", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "schema": { "$ref": "#/components/schemas/AlertAttributesUpdatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "alert_attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" } }, "schema": { "$ref": "#/components/schemas/AlertAttributesUpdateResultV2" } } }, "description": "OK response." } }, "summary": "Update Alert Attributes V2", "tags": [ "Alert Attributes V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Alert Attributes V2", "x-docs-resource-type": "AlertAttributeV2" } }, "/v2/alert_events/http/{alert_source_config_id}": { "post": { "description": "Create an alert event using an HTTP source.", "operationId": "Alert Events V2#CreateHTTP", "parameters": [ { "allowEmptyValue": true, "description": "Token used to authenticate the request, generated when configuring the alert source. Will be consumed via a URL query string parameter", "example": "some-random-string", "in": "query", "name": "token", "schema": { "description": "Token used to authenticate the request, generated when configuring the alert source. Will be consumed via a URL query string parameter", "example": "some-random-string", "type": "string" } }, { "description": "Which alert source config produced this alert", "examples": { "default": { "summary": "default", "value": "01GW2G3V0S59R238FAHPDS1R66" } }, "in": "path", "name": "alert_source_config_id", "required": true, "schema": { "description": "Which alert source config produced this alert", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "deduplication_key": "4293868629", "description": "We've detected a number of timeouts on hello.world.com, the service may be down. To fix...", "metadata": { "service": "hello.world.com", "team": [ "my-team" ] }, "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect" }, "schema": { "$ref": "#/components/schemas/AlertEventsCreateHTTPPayloadV2" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "example": { "deduplication_key": "unique-key", "message": "Event accepted for processing", "status": "success" }, "schema": { "$ref": "#/components/schemas/AlertEventsCreateHTTPResultV2" } } }, "description": "Accepted response." } }, "summary": "CreateHTTP Alert Events V2", "tags": [ "Alert Events V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Alert Events V2", "x-docs-resource-type": "AlertResultV2" } }, "/v2/alert_routes": { "get": { "description": "List all alert routes in your account.", "operationId": "Alert Routes V2#List", "parameters": [ { "allowEmptyValue": true, "description": "Number of alert routes to return per page", "example": 25, "in": "query", "name": "page_size", "required": true, "schema": { "default": 25, "description": "Number of alert routes to return per page", "example": 25, "format": "int64", "maximum": 50, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "The ID of the last alert route on the previous page", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "query", "name": "after", "schema": { "description": "The ID of the last alert route on the previous page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "alert_routes": [ { "enabled": false, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Production incidents" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/AlertRoutesListResultV2" } } }, "description": "OK response." } }, "summary": "List Alert Routes V2", "tags": [ "Alert Routes V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Alert Routes V2", "x-docs-resource-type": "AlertRouteV2" }, "post": { "description": "Create a new alert route in your account.", "operationId": "Alert Routes V2#Create", "requestBody": { "content": { "application/json": { "example": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] } ], "channel_config": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ] }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "incident_config": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "incident_template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "is_private": false, "message_template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 }, "schema": { "$ref": "#/components/schemas/AlertRoutesCreatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "alert_route": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] } ], "channel_config": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ] }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_config": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "incident_template": { "custom_fields": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } }, "is_private": false, "message_template": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "schema": { "$ref": "#/components/schemas/AlertRoutesCreateResultV2" } } }, "description": "Created response." } }, "summary": "Create Alert Routes V2", "tags": [ "Alert Routes V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Alert Routes V2", "x-docs-resource-type": "AlertRouteV2" } }, "/v2/alert_routes/{id}": { "delete": { "description": "Delete an existing alert route in your account.", "operationId": "Alert Routes V2#Delete", "parameters": [ { "description": "Unique identifier of the alert route", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the alert route", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." } }, "summary": "Delete Alert Routes V2", "tags": [ "Alert Routes V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Alert Routes V2", "x-docs-resource-type": "AlertRouteV2" }, "get": { "description": "Load details about a specific alert route in your account.", "operationId": "Alert Routes V2#Show", "parameters": [ { "description": "Unique identifier of the alert route", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the alert route", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "alert_route": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] } ], "channel_config": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ] }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_config": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "incident_template": { "custom_fields": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } }, "is_private": false, "message_template": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "schema": { "$ref": "#/components/schemas/AlertRoutesShowResultV2" } } }, "description": "OK response." } }, "summary": "Show Alert Routes V2", "tags": [ "Alert Routes V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Alert Routes V2", "x-docs-resource-type": "AlertRouteV2" }, "put": { "description": "Update an existing alert route in your account.", "operationId": "Alert Routes V2#Update", "parameters": [ { "description": "Unique identifier of the alert route", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the alert route", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] } ], "channel_config": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ] }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "incident_config": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "incident_template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "is_private": false, "message_template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 }, "schema": { "$ref": "#/components/schemas/AlertRoutesUpdatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "alert_route": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] } ], "channel_config": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" }, "slack_targets": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123" } } ], "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ] }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_config": { "auto_decline_enabled": false, "auto_relate_grouped_alerts": false, "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "defer_time_seconds": 1, "enabled": false, "grouping_keys": [ { "reference": "alert.title" } ], "grouping_window_seconds": 1 }, "incident_template": { "custom_fields": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } }, "is_private": false, "message_template": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "schema": { "$ref": "#/components/schemas/AlertRoutesUpdateResultV2" } } }, "description": "OK response." } }, "summary": "Update Alert Routes V2", "tags": [ "Alert Routes V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Alert Routes V2", "x-docs-resource-type": "AlertRouteV2" } }, "/v2/alert_sources": { "get": { "description": "List all alert sources in your account.", "operationId": "Alert Sources V2#List", "responses": { "200": { "content": { "application/json": { "example": { "alert_sources": [ { "alert_events_url": "https://api.incident.io/v2/alert_events/http/01GW2G3V0S59R238FAHPDS1R66", "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "email_options": { "email_address": "lawrence@example.com", "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60, "ping_url": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping" }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "id": "01GW2G3V0S59R238FAHPDS1R66", "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "secret_token": "some-secret-token", "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "is_private": false, "title": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } } ] }, "schema": { "$ref": "#/components/schemas/AlertSourcesListResultV2" } } }, "description": "OK response." } }, "summary": "List Alert Sources V2", "tags": [ "Alert Sources V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Alert Sources V2", "x-docs-resource-type": "AlertSourceV2" }, "post": { "description": "Create a new alert source in your account.", "operationId": "Alert Sources V2#Create", "requestBody": { "content": { "application/json": { "example": { "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "email_options": { "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60 }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "is_private": false, "title": { "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "schema": { "$ref": "#/components/schemas/AlertSourcesCreatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "alert_source": { "alert_events_url": "https://api.incident.io/v2/alert_events/http/01GW2G3V0S59R238FAHPDS1R66", "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "email_options": { "email_address": "lawrence@example.com", "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60, "ping_url": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping" }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "id": "01GW2G3V0S59R238FAHPDS1R66", "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "secret_token": "some-secret-token", "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "is_private": false, "title": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } } }, "schema": { "$ref": "#/components/schemas/AlertSourcesCreateResultV2" } } }, "description": "OK response." } }, "summary": "Create Alert Sources V2", "tags": [ "Alert Sources V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Alert Sources V2", "x-docs-resource-type": "AlertSourceV2" } }, "/v2/alert_sources/{id}": { "delete": { "description": "Delete an existing alert source in your account.", "operationId": "Alert Sources V2#Delete", "parameters": [ { "description": "The ID of this alert source", "example": "01GW2G3V0S59R238FAHPDS1R66", "in": "path", "name": "id", "required": true, "schema": { "description": "The ID of this alert source", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" } } ], "responses": { "204": { "description": "No Content response." } }, "summary": "Delete Alert Sources V2", "tags": [ "Alert Sources V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Alert Sources V2", "x-docs-resource-type": "AlertSourceV2" }, "get": { "description": "Load details about a specific alert source in your account.", "operationId": "Alert Sources V2#Show", "parameters": [ { "description": "The ID of this alert source", "example": "01GW2G3V0S59R238FAHPDS1R66", "in": "path", "name": "id", "required": true, "schema": { "description": "The ID of this alert source", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "alert_source": { "alert_events_url": "https://api.incident.io/v2/alert_events/http/01GW2G3V0S59R238FAHPDS1R66", "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "email_options": { "email_address": "lawrence@example.com", "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60, "ping_url": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping" }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "id": "01GW2G3V0S59R238FAHPDS1R66", "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "secret_token": "some-secret-token", "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "is_private": false, "title": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } } }, "schema": { "$ref": "#/components/schemas/AlertSourcesShowResultV2" } } }, "description": "OK response." } }, "summary": "Show Alert Sources V2", "tags": [ "Alert Sources V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Alert Sources V2", "x-docs-resource-type": "AlertSourceV2" }, "put": { "description": "Update an existing alert source in your account.", "operationId": "Alert Sources V2#Update", "parameters": [ { "description": "The ID of this alert source", "example": "01GW2G3V0S59R238FAHPDS1R66", "in": "path", "name": "id", "required": true, "schema": { "description": "The ID of this alert source", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "disabled": false, "email_options": { "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60 }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "is_private": false, "title": { "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "schema": { "$ref": "#/components/schemas/AlertSourcesUpdatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "alert_source": { "alert_events_url": "https://api.incident.io/v2/alert_events/http/01GW2G3V0S59R238FAHPDS1R66", "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "email_options": { "email_address": "lawrence@example.com", "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60, "ping_url": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping" }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "id": "01GW2G3V0S59R238FAHPDS1R66", "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "secret_token": "some-secret-token", "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "is_private": false, "title": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } } }, "schema": { "$ref": "#/components/schemas/AlertSourcesUpdateResultV2" } } }, "description": "OK response." } }, "summary": "Update Alert Sources V2", "tags": [ "Alert Sources V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Alert Sources V2", "x-docs-resource-type": "AlertSourceV2" } }, "/v2/alerts": { "get": { "description": "List all alerts for your account.\n\t\t\nThis endpoint supports a number of filters, which can help find alerts matching certain\ncriteria. These filters work similarly to the filters on the incidents endpoint, where \na field is specified alongside a comparison operator in the query string.\n\nNote that:\n- Filters may be used together, and the result will be alerts that match all filters.\n- All query parameters must be URI encoded.\n\n### By deduplication_key\n\nFind all alerts with deduplication_key ABC:\n\n\t\tcurl --get 'https://api.incident.io/v2/alerts' \\\n\t\t\t--data 'deduplication_key[is]=ABC'\n\n### By status\n\nFind all alerts in a firing state:\n\n\t\tcurl --get 'https://api.incident.io/v2/alerts' \\\n\t\t\t--data 'status[one_of]=firing'\n\n### By alert_source\n\nFind all alerts from a specific alert source (by alert source ID):\n\n\t\tcurl --get 'https://api.incident.io/v2/alerts' \\\n\t\t\t--data 'alert_source[one_of]=01GBSQF3FHF7FWZQNWGHAVQ804'\n\nFind all alerts not from a specific alert source:\n\n\t\tcurl --get 'https://api.incident.io/v2/alerts' \\\n\t\t\t--data 'alert_source[not_in]=01GBSQF3FHF7FWZQNWGHAVQ804'\n\n### By created_at\nFind all alerts that follow specified date parameters for created_at field.\nPossible values are \"gte\" (greater than or equal to), \"lte\" (less than or equal to), and \n\"date_range\" (between two dates). The following example finds all alerts created after \n2025-01-01:\n\n\t\tcurl --get 'https://api.incident.io/v2/alerts' \\\n\t\t\t--data 'created_at[gte]=2025-01-01'\n\nTo find alerts created within a specific date range, use the date_range option with \ntilde-separated dates:\n\n\t\tcurl --get 'https://api.incident.io/v2/alerts' \\\n\t\t\t--data 'created_at[date_range]=2024-12-02~2024-12-08'\n\n### Maintenance windows\nBy default, all alerts are returned including those held by a maintenance window.\nTo exclude alerts that are held by a maintenance window:\n\n\t\tcurl --get 'https://api.incident.io/v2/alerts' \\\n\t\t\t--data 'include_maintenance_window[is]=false'\n\t\t", "operationId": "Alerts V2#List", "parameters": [ { "allowEmptyValue": true, "description": "Number of alerts to return per page", "example": 25, "in": "query", "name": "page_size", "required": true, "schema": { "default": 25, "description": "Number of alerts to return per page", "example": 25, "format": "int64", "maximum": 50, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "If provided, pass this as the 'after' param to load the next page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "after", "schema": { "description": "If provided, pass this as the 'after' param to load the next page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter on alert deduplication key. The accepted operator is 'is'.", "example": { "is": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "in": "query", "name": "deduplication_key", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on alert deduplication key. The accepted operator is 'is'.", "example": { "is": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on alert status. The accepted operators are 'one_of', or 'not_in'.", "example": { "one_of": [ "firing" ] }, "in": "query", "name": "status", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on alert status. The accepted operators are 'one_of', or 'not_in'.", "example": { "one_of": [ "firing" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on alert source by ID. The accepted operators are 'one_of', or 'not_in'.", "example": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "in": "query", "name": "alert_source", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on alert source by ID. The accepted operators are 'one_of', or 'not_in'.", "example": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on alert created at timestamp. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2025-01-01" ] }, "in": "query", "name": "created_at", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on alert created at timestamp. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2025-01-01" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on whether to include maintenance window alerts. The accepted operator is 'is'.", "example": { "is": [ "true" ] }, "in": "query", "name": "include_maintenance_window", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on whether to include maintenance window alerts. The accepted operator is 'is'.", "example": { "is": [ "true" ] }, "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "example": { "alerts": [ { "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "attributes": [ { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } } ], "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/AlertsListResultV2" } } }, "description": "OK response." } }, "summary": "List Alerts V2", "tags": [ "Alerts V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Alerts V2", "x-docs-resource-type": "AlertV2" } }, "/v2/alerts/{id}": { "get": { "description": "Show a single alert for your account", "operationId": "Alerts V2#Show", "parameters": [ { "description": "Unique identifier for the alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "alert": { "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "attributes": [ { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } } ], "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/AlertsShowResultV2" } } }, "description": "OK response." } }, "summary": "Show Alerts V2", "tags": [ "Alerts V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Alerts V2", "x-docs-resource-type": "AlertV2" } }, "/v2/catalog_entries": { "get": { "deprecated": true, "description": "List entries for a catalog type.", "operationId": "Catalog V2#ListEntries", "parameters": [ { "allowEmptyValue": true, "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "catalog_type_id", "required": true, "schema": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "catalog_entries": [ { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" } ], "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" }, "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/CatalogListEntriesResultV2" } } }, "description": "OK response." } }, "summary": "ListEntries Catalog V2", "tags": [ "Catalog V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Catalog Entries V2", "x-docs-resource-type": "CatalogEntryV2" }, "post": { "deprecated": true, "description": "Create an entry within the catalog. We support a maximum of 50,000 entries per type.\n\nIf you call this API with a payload where the external_id and catalog_type_id match an existing entry, the existing entry will be updated.", "operationId": "Catalog V2#CreateEntry", "requestBody": { "content": { "application/json": { "example": { "aliases": [ "lawrence@incident.io", "lawrence" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "name": "Primary On-call", "rank": 3 }, "schema": { "$ref": "#/components/schemas/CatalogCreateEntryPayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CatalogCreateEntryResultV2" } } }, "description": "Created response." } }, "summary": "CreateEntry Catalog V2", "tags": [ "Catalog V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Catalog Entries V2", "x-docs-resource-type": "CatalogEntryV2" } }, "/v2/catalog_entries/{id}": { "delete": { "deprecated": true, "description": "Archives a catalog entry.", "operationId": "Catalog V2#DestroyEntry", "parameters": [ { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." } }, "summary": "DestroyEntry Catalog V2", "tags": [ "Catalog V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Catalog Entries V2", "x-docs-resource-type": "CatalogEntryV2" }, "get": { "deprecated": true, "description": "Show a single catalog entry.", "operationId": "Catalog V2#ShowEntry", "parameters": [ { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" }, "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CatalogShowEntryResultV2" } } }, "description": "OK response." } }, "summary": "ShowEntry Catalog V2", "tags": [ "Catalog V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Catalog Entries V2", "x-docs-resource-type": "CatalogEntryV2" }, "put": { "deprecated": true, "description": "Updates an existing catalog entry.", "operationId": "Catalog V2#UpdateEntry", "parameters": [ { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "aliases": [ "lawrence@incident.io", "lawrence" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "name": "Primary On-call", "rank": 3 }, "schema": { "$ref": "#/components/schemas/CatalogUpdateEntryPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } ], "value": { "catalog_entry": { "archived_at": "2021-08-17T14:28:57.801578Z", "catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "catalog_entry_name": "Primary escalation", "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "helptext": "abc123", "image_url": "abc123", "is_image_slack_icon": false, "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity", "sort_key": "abc123", "unavailable": false, "value": "abc123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" }, "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CatalogUpdateEntryResultV2" } } }, "description": "OK response." } }, "summary": "UpdateEntry Catalog V2", "tags": [ "Catalog V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Catalog Entries V2", "x-docs-resource-type": "CatalogEntryV2" } }, "/v2/catalog_resources": { "get": { "deprecated": true, "description": "List available engine resources for the catalog.\n\nA resource represents a type of data that can be held within the catalog, so this\nendpoint can be used to see what attribute types can be used when updating the\nschema of a catalog type.\n", "operationId": "Catalog V2#ListResources", "responses": { "200": { "content": { "application/json": { "example": { "resources": [ { "category": "custom", "description": "Boolean true or false value", "label": "GitHub Repository", "type": "CatalogEntry[\"01GVGYJSD39FRKVDWACK9NDS4E\"]", "value_docstring": "Either the GraphQL node ID of the repository or a string of \u003cowner\u003e/\u003crepo\u003e, e.g. incident-io/website" } ] }, "schema": { "$ref": "#/components/schemas/CatalogListResourcesResultV2" } } }, "description": "OK response." } }, "summary": "ListResources Catalog V2", "tags": [ "Catalog V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Catalog Resources V2", "x-docs-resource-type": "CatalogResourceV2" } }, "/v2/catalog_types": { "get": { "deprecated": true, "description": "List all catalog types for an organisation, including those synced from external resources.", "operationId": "Catalog V2#ListTypes", "responses": { "200": { "content": { "application/json": { "example": { "catalog_types": [ { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/CatalogListTypesResultV2" } } }, "description": "OK response." } }, "summary": "ListTypes Catalog V2", "tags": [ "Catalog V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Catalog Types V2", "x-docs-resource-type": "CatalogTypeV2" }, "post": { "deprecated": true, "description": "Create a catalog type. The schema must be updated using the UpdateTypeSchema endpoint.", "operationId": "Catalog V2#CreateType", "requestBody": { "content": { "application/json": { "example": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "description": "Represents Kubernetes clusters that we run inside of GKE.", "icon": "alert", "name": "Kubernetes Cluster", "ranked": true, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]" }, "schema": { "$ref": "#/components/schemas/CatalogCreateTypePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CatalogCreateTypeResultV2" } } }, "description": "Created response." } }, "summary": "CreateType Catalog V2", "tags": [ "Catalog V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Catalog Types V2", "x-docs-resource-type": "CatalogTypeV2" } }, "/v2/catalog_types/{id}": { "delete": { "deprecated": true, "description": "Archives a catalog type and associated entries.", "operationId": "Catalog V2#DestroyType", "parameters": [ { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." } }, "summary": "DestroyType Catalog V2", "tags": [ "Catalog V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Catalog Types V2", "x-docs-resource-type": "CatalogTypeV2" }, "get": { "deprecated": true, "description": "Show a single catalog type.", "operationId": "Catalog V2#ShowType", "parameters": [ { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CatalogShowTypeResultV2" } } }, "description": "OK response." } }, "summary": "ShowType Catalog V2", "tags": [ "Catalog V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Catalog Types V2", "x-docs-resource-type": "CatalogTypeV2" }, "put": { "deprecated": true, "description": "Updates an existing catalog type. The schema must be updated using the UpdateTypeSchema endpoint.", "operationId": "Catalog V2#UpdateType", "parameters": [ { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "description": "Represents Kubernetes clusters that we run inside of GKE.", "icon": "alert", "name": "Kubernetes Cluster", "ranked": true, "source_repo_url": "https://github.com/my-company/incident-io-catalog" }, "schema": { "$ref": "#/components/schemas/CatalogUpdateTypePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CatalogUpdateTypeResultV2" } } }, "description": "OK response." } }, "summary": "UpdateType Catalog V2", "tags": [ "Catalog V2" ], "x-docs-display-name": "Update Type", "x-docs-group-name": "Catalog Types V2", "x-docs-resource-type": "CatalogTypeV2" } }, "/v2/catalog_types/{id}/actions/update_schema": { "post": { "deprecated": true, "description": "Update an existing catalog types schema, adding or removing attributes.\n\nUpdating the schema is handled separately from creating and updating types, so that you don't\nhave to worry about dependencies between types. For example, if type A has an attribute that\nrelies on type B, you would have to create type B first.\n\nBy allowing the creation of types without a schema, they can be created in any order, but it\nmeans that you need to make a separate call to this endpoint to update the schema.", "operationId": "Catalog V2#UpdateTypeSchema", "parameters": [ { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/CatalogUpdateTypeSchemaPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "semantic_type": "abc123", "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CatalogUpdateTypeSchemaResultV2" } } }, "description": "OK response." } }, "summary": "UpdateTypeSchema Catalog V2", "tags": [ "Catalog V2" ], "x-docs-display-name": "Update Type Schema", "x-docs-group-name": "Catalog Types V2", "x-docs-resource-type": "CatalogTypeV2" } }, "/v2/custom_fields": { "get": { "description": "List all custom fields for an organisation.", "operationId": "Custom Fields V2#List", "responses": { "200": { "content": { "application/json": { "example": { "custom_fields": [ { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/CustomFieldsListResultV2" } } }, "description": "OK response." } }, "summary": "List Custom Fields V2", "tags": [ "Custom Fields V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Custom Fields V2", "x-docs-resource-type": "CustomFieldV2" }, "post": { "description": "Create a new custom field", "operationId": "Custom Fields V2#Create", "requestBody": { "content": { "application/json": { "example": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "description": "Which team is impacted by this issue", "field_type": "single_select", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "name": "Affected Team" }, "schema": { "$ref": "#/components/schemas/CustomFieldsCreatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CustomFieldsCreateResultV2" } } }, "description": "Created response." } }, "summary": "Create Custom Fields V2", "tags": [ "Custom Fields V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Custom Fields V2", "x-docs-resource-type": "CustomFieldV2" } }, "/v2/custom_fields/{id}": { "delete": { "description": "Delete a custom field", "operationId": "Custom Fields V2#Delete", "parameters": [ { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." } }, "summary": "Delete Custom Fields V2", "tags": [ "Custom Fields V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Custom Fields V2", "x-docs-resource-type": "CustomFieldV2" }, "get": { "description": "Get a single custom field.", "operationId": "Custom Fields V2#Show", "parameters": [ { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CustomFieldsShowResultV2" } } }, "description": "OK response." } }, "summary": "Show Custom Fields V2", "tags": [ "Custom Fields V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Custom Fields V2", "x-docs-resource-type": "CustomFieldV2" }, "put": { "description": "Update the details of a custom field", "operationId": "Custom Fields V2#Update", "parameters": [ { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "Which team is impacted by this issue", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "name": "Affected Team" }, "schema": { "$ref": "#/components/schemas/CustomFieldsUpdatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CustomFieldsUpdateResultV2" } } }, "description": "OK response." } }, "summary": "Update Custom Fields V2", "tags": [ "Custom Fields V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Custom Fields V2", "x-docs-resource-type": "CustomFieldV2" } }, "/v2/escalation_paths": { "get": { "description": "List all escalation paths in your account.\n\nAn escalation path is a series of steps that describe how a page should be escalated,\nrepresented as a graph, supporting conditional branches based on alert priority and\nworking intervals.\n", "operationId": "Escalations V2#ListPaths", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 25, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "escalation_paths": [ { "current_responders": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Urgent Support", "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/EscalationsListPathsResultV2" } } }, "description": "OK response." } }, "summary": "ListPaths Escalations V2", "tags": [ "Escalations V2" ], "x-display-name": "List", "x-docs-display-name": "List", "x-docs-group-name": "Escalation Paths V2", "x-docs-resource-type": "EscalationPathV2" }, "post": { "description": "Create an escalation path.\n\nAn escalation path is a series of steps that describe how a page should be escalated,\nrepresented as graph, supporting conditional branches based on alert priority and working\nintervals.\n\nWe recommend you create escalation paths in the incident.io dashboard where our path\nbuilder makes it easy to use conditions and visualise the path.\n", "operationId": "Escalations V2#CreatePath", "requestBody": { "content": { "application/json": { "example": { "name": "Urgent Support", "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "schema": { "$ref": "#/components/schemas/EscalationsCreatePathPayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "escalation_path": { "current_responders": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Urgent Support", "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } }, "schema": { "$ref": "#/components/schemas/EscalationsCreatePathResultV2" } } }, "description": "Created response." } }, "summary": "CreatePath Escalations V2", "tags": [ "Escalations V2" ], "x-display-name": "Create", "x-docs-display-name": "Create", "x-docs-group-name": "Escalation Paths V2", "x-docs-resource-type": "EscalationPathV2" } }, "/v2/escalation_paths/{id}": { "delete": { "description": "Archives an escalation path.\n\nWe recommend you create escalation paths in the incident.io dashboard where our path\nbuilder makes it easy to use conditions and visualise the path.\n", "operationId": "Escalations V2#DestroyPath", "parameters": [ { "description": "Unique identifier for this escalation path.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for this escalation path.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." } }, "summary": "DestroyPath Escalations V2", "tags": [ "Escalations V2" ], "x-display-name": "Destroy", "x-docs-display-name": "Delete", "x-docs-group-name": "Escalation Paths V2", "x-docs-resource-type": "EscalationPathV2" }, "get": { "description": "Show an escalation path.\n\nWe recommend you create escalation paths in the incident.io dashboard where our path\nbuilder makes it easy to use conditions and visualise the path.\n", "operationId": "Escalations V2#ShowPath", "parameters": [ { "description": "Unique identifier for this escalation path.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for this escalation path.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "escalation_path": { "current_responders": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Urgent Support", "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } }, "schema": { "$ref": "#/components/schemas/EscalationsShowPathResultV2" } } }, "description": "OK response." } }, "summary": "ShowPath Escalations V2", "tags": [ "Escalations V2" ], "x-display-name": "Show", "x-docs-display-name": "Show", "x-docs-group-name": "Escalation Paths V2", "x-docs-resource-type": "EscalationPathV2" }, "put": { "description": "Updates an escalation path.\n\nWe recommend you create escalation paths in the incident.io dashboard where our path\nbuilder makes it easy to use conditions and visualise the path.\n", "operationId": "Escalations V2#UpdatePath", "parameters": [ { "description": "Unique identifier for this escalation path.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for this escalation path.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "name": "Urgent Support", "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "schema": { "$ref": "#/components/schemas/EscalationsUpdatePathPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "escalation_path": { "current_responders": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Urgent Support", "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } }, "schema": { "$ref": "#/components/schemas/EscalationsUpdatePathResultV2" } } }, "description": "OK response." } }, "summary": "UpdatePath Escalations V2", "tags": [ "Escalations V2" ], "x-display-name": "Update", "x-docs-display-name": "Update", "x-docs-group-name": "Escalation Paths V2", "x-docs-resource-type": "EscalationPathV2" } }, "/v2/escalations": { "get": { "description": "List all escalations for your account.\n\nThis endpoint supports a number of filters, which can help find escalations matching certain\ncriteria.\n\nNote that:\n- Filters may be used together, and the result will be escalations that match all filters.\n- All query parameters must be URI encoded.\n\nTo use this API, you will need an API key with the \"View data\" or \"Create and manage on-call resources\" permission.\n\n### By escalation_path\n\nFind all escalations that escalated to escalation path with id=ABC:\n\n\t\tcurl --get 'https://api.incident.io/v2/escalations' \\\n\t\t\t--data 'escalation_path[one_of]=ABC'\n\n### By status\n\nFind all escalations with a current status of \"triggered\":\n\n\t\tcurl --get 'https://api.incident.io/v2/escalations' \\\n\t\t\t--data 'status[one_of]=triggered'\n\nPossible values are \"pending\", \"triggered\", \"acked\", \"resolved\", \"expired\" and \"cancelled\".\nEscalations are in \"pending\" when they are in a grace period when the related alert has\nbeen grouped in an incident.\n\n### By alert\n\nFind all escalations that were created by alert with id=ABC:\n\n\t\tcurl --get 'https://api.incident.io/v2/escalations' \\\n\t\t\t--data 'alert[one_of]=ABC'\n\n### By created_at and updated_at\nFind all escalations that follow specified date parameters for created_at and updated_at fields.\nPossible values are \"gte\" (greater than or equal to), \"lte\" (less than or equal to), and\n\"date_range\" (between two dates).\nFor example, to find all escalations updated after 2025-01-01:\n\n\t\tcurl --get 'https://api.incident.io/v2/escalations' \\\n\t\t\t--data 'updated_at[gte]=2025-01-01'\n\nTo find all escalations created between 2025-01-01 and 2025-01-31:\n\n\t\tcurl --get 'https://api.incident.io/v2/escalations' \\\n --data 'created_at[date_range]=2025-01-01~2025-01-31'\n", "operationId": "Escalations V2#List", "parameters": [ { "allowEmptyValue": true, "description": "Number of escalations to return per page", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Number of escalations to return per page", "example": 25, "format": "int64", "maximum": 50, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "An escalation's ID. This endpoint will return a list of escalations after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An escalation's ID. This endpoint will return a list of escalations after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter on the escalation path for which the escalation was triggered. Accepted operators are 'one_of' and 'not_in'.", "example": { "one_of": [ "01J479052SSQAA4531ASFPR3BF" ] }, "in": "query", "name": "escalation_path", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on the escalation path for which the escalation was triggered. Accepted operators are 'one_of' and 'not_in'.", "example": { "one_of": [ "01J479052SSQAA4531ASFPR3BF" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on the status of the escalation. Accepted operators are 'one_of' and 'not_in'.", "example": { "one_of": [ "triggered" ] }, "in": "query", "name": "status", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on the status of the escalation. Accepted operators are 'one_of' and 'not_in'.", "example": { "one_of": [ "triggered" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on the alert that created an escalation. Accepted operators are 'one_of' and 'not_in'.", "example": { "one_of": [ "01J479052SSQAA4531ASFPR3BF" ] }, "in": "query", "name": "alert", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on the alert that created an escalation. Accepted operators are 'one_of' and 'not_in'.", "example": { "one_of": [ "01J479052SSQAA4531ASFPR3BF" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on the created_at timestamp of the escalation. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2021-08-17" ] }, "in": "query", "name": "created_at", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on the created_at timestamp of the escalation. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2021-08-17" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on the updated_at timestamp of the escalation. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2021-08-17" ] }, "in": "query", "name": "updated_at", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on the updated_at timestamp of the escalation. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2021-08-17" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on the idempotency key of the escalation. This is the key set when creating escalations via the API, and is distinct from alert deduplication keys. Accepted operators are 'is' for exact matches and 'starts_with' for prefix matching.", "example": { "starts_with": [ "team-a:" ] }, "in": "query", "name": "idempotency_key", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on the idempotency key of the escalation. This is the key set when creating escalations via the API, and is distinct from alert deduplication keys. Accepted operators are 'is' for exact matches and 'starts_with' for prefix matching.", "example": { "starts_with": [ "team-a:" ] }, "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "example": { "escalations": [ { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "escalation_path_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "events": [ { "channels": [ { "microsoft_teams_channel_id": "abc123", "microsoft_teams_team_id": "abc123", "slack_channel_id": "abc123", "slack_team_id": "abc123" } ], "event": "entered_grace_period", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "occurred_at": "2021-08-17T13:28:57.801578Z", "urgency": "high", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ] } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "priority": { "name": "P1" }, "related_alerts": [ { "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "related_incidents": [ { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } ], "status": "pending", "title": "Database CPU is high", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/EscalationsListResultV2" } } }, "description": "OK response." } }, "summary": "List Escalations V2", "tags": [ "Escalations V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Escalations V2", "x-docs-resource-type": "EscalationV2" }, "post": { "description": "Create an escalation.\n\nAn escalation pages people, either according to an escalation path, or directly to\nspecific users. You must provide either an escalation_path_id OR user_ids, but not both.\n\nWhen escalating via an escalation path, the escalation will follow the configured path\nwith its levels and timeouts, using your default [alert\npriority](https://app.incident.io/~/settings/alerts/configuration/priorities).\n\nWhen escalating directly to users, they will receive a high-urgency\nnotification, based on their notification rules.\n\nThis endpoint is rate-limited to 60 requests per minute, since it is intended for\ninteractive use cases (for example someone clicking a \"escalate to team\" button\nin your internal developer platform). To escalate based on automated alerts, we\nrecommend sending events to an alert source instead.\n", "operationId": "Escalations V2#Create", "requestBody": { "content": { "application/json": { "example": { "description": "Database CPU has been above 90% for 5 minutes", "escalation_path_id": "01H0J1EXE7AXZ2C93K61WBPYEH", "idempotency_key": "2024-01-15-abc123", "title": "Production database experiencing high CPU", "user_ids": [ "01H0J1EXE7AXZ2C93K61WBPYEH", "01H0J1EXE7AXZ2C93K61WBPYEI" ] }, "schema": { "$ref": "#/components/schemas/EscalationsCreatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "escalation": { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "escalation_path_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "events": [ { "channels": [ { "microsoft_teams_channel_id": "abc123", "microsoft_teams_team_id": "abc123", "slack_channel_id": "abc123", "slack_team_id": "abc123" } ], "event": "entered_grace_period", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "occurred_at": "2021-08-17T13:28:57.801578Z", "urgency": "high", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ] } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "priority": { "name": "P1" }, "related_alerts": [ { "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "related_incidents": [ { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } ], "status": "pending", "title": "Database CPU is high", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/EscalationsCreateResultV2" } } }, "description": "Created response." } }, "summary": "Create Escalations V2", "tags": [ "Escalations V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Escalations V2", "x-docs-resource-type": "EscalationV2" } }, "/v2/escalations/{id}": { "get": { "description": "Show a specific escalation.", "operationId": "Escalations V2#Show", "parameters": [ { "description": "Unique ID of the escalation", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique ID of the escalation", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "escalation": { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "escalation_path_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "events": [ { "channels": [ { "microsoft_teams_channel_id": "abc123", "microsoft_teams_team_id": "abc123", "slack_channel_id": "abc123", "slack_team_id": "abc123" } ], "event": "entered_grace_period", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "occurred_at": "2021-08-17T13:28:57.801578Z", "urgency": "high", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ] } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "priority": { "name": "P1" }, "related_alerts": [ { "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "related_incidents": [ { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } ], "status": "pending", "title": "Database CPU is high", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/EscalationsShowResultV2" } } }, "description": "OK response." } }, "summary": "Show Escalations V2", "tags": [ "Escalations V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Escalations V2", "x-docs-resource-type": "EscalationV2" } }, "/v2/follow_ups": { "get": { "description": "List all follow-ups for an organisation.", "operationId": "Follow-ups V2#List", "parameters": [ { "allowEmptyValue": true, "description": "Find follow-ups related to this incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "incident_id", "schema": { "description": "Find follow-ups related to this incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter to follow-ups from incidents of the given mode. If not set, only follow-ups from `standard` and `retrospective` incidents are returned", "example": "standard", "in": "query", "name": "incident_mode", "schema": { "description": "Filter to follow-ups from incidents of the given mode. If not set, only follow-ups from `standard` and `retrospective` incidents are returned", "enum": [ "standard", "retrospective", "test", "tutorial", "stream" ], "example": "standard", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "follow_ups": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/FollowUpsListResultV2" } } }, "description": "OK response." } }, "summary": "List Follow-ups V2", "tags": [ "Follow-ups V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Follow-ups V2", "x-docs-resource-type": "FollowUpV2" } }, "/v2/follow_ups/{id}": { "get": { "description": "Get a single incident follow-up.", "operationId": "Follow-ups V2#Show", "parameters": [ { "description": "Unique identifier for the follow-up", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the follow-up", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "follow_up": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/FollowUpsShowResultV2" } } }, "description": "OK response." } }, "summary": "Show Follow-ups V2", "tags": [ "Follow-ups V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Follow-ups V2", "x-docs-resource-type": "FollowUpV2" } }, "/v2/heartbeat/{alert_source_config_id}/ping": { "get": { "description": "Send a heartbeat ping for the specified alert source.\n\nRecords a ping, indicating that the monitored job or service is healthy. The\nheartbeat monitor uses these pings to detect missed heartbeats and fire alerts.\nBoth GET and POST are accepted\n", "operationId": "Heartbeat V2#Ping#1", "parameters": [ { "allowEmptyValue": true, "description": "Token provided via the token query parameter", "example": "some-random-string", "in": "query", "name": "token", "schema": { "description": "Token provided via the token query parameter", "example": "some-random-string", "type": "string" } }, { "description": "The alert source config this heartbeat ping is for", "example": "01GW2G3V0S59R238FAHPDS1R66", "in": "path", "name": "alert_source_config_id", "required": true, "schema": { "description": "The alert source config this heartbeat ping is for", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" } } ], "responses": { "204": { "description": "No Content response." } }, "summary": "Ping Heartbeat V2", "tags": [ "Heartbeat V2" ] }, "post": { "description": "Send a heartbeat ping for the specified alert source.\n\nRecords a ping, indicating that the monitored job or service is healthy. The\nheartbeat monitor uses these pings to detect missed heartbeats and fire alerts.\nBoth GET and POST are accepted\n", "operationId": "Heartbeat V2#Ping", "parameters": [ { "allowEmptyValue": true, "description": "Token provided via the token query parameter", "example": "some-random-string", "in": "query", "name": "token", "schema": { "description": "Token provided via the token query parameter", "example": "some-random-string", "type": "string" } }, { "description": "The alert source config this heartbeat ping is for", "example": "01GW2G3V0S59R238FAHPDS1R66", "in": "path", "name": "alert_source_config_id", "required": true, "schema": { "description": "The alert source config this heartbeat ping is for", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" } } ], "responses": { "204": { "description": "No Content response." } }, "summary": "Ping Heartbeat V2", "tags": [ "Heartbeat V2" ] } }, "/v2/incident_alerts": { "get": { "description": "List the connections between incidents and alerts", "operationId": "Alerts V2#ListIncidentAlerts", "parameters": [ { "allowEmptyValue": true, "description": "Number of incident alerts to return per page", "example": 25, "in": "query", "name": "page_size", "required": true, "schema": { "default": 25, "description": "Number of incident alerts to return per page", "example": 25, "format": "int64", "maximum": 50, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "If provided, pass this as the 'after' param to load the next page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "after", "schema": { "description": "If provided, pass this as the 'after' param to load the next page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Alert that this incident alert refers to", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "in": "query", "name": "alert_id", "schema": { "description": "Alert that this incident alert refers to", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } }, { "allowEmptyValue": true, "description": "Incident that this incident alert is attached to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "incident_id", "schema": { "description": "Incident that this incident alert is attached to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_alerts": [ { "alert": { "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" }, "alert_route_id": "01GW2G3V0S59R238FAHPDS1R67", "id": "01GW2G3V0S59R238FAHPDS1R66", "incident": { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/AlertsListIncidentAlertsResultV2" } } }, "description": "OK response." } }, "summary": "ListIncidentAlerts Alerts V2", "tags": [ "Alerts V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Incident Alerts V2", "x-docs-resource-type": "IncidentAlertV2" } }, "/v2/incident_roles": { "get": { "description": "List all incident roles for an organisation.", "operationId": "Incident Roles V2#List", "responses": { "200": { "content": { "application/json": { "example": { "incident_roles": [ { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/IncidentRolesListResultV2" } } }, "description": "OK response." } }, "summary": "List Incident Roles V2", "tags": [ "Incident Roles V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Incident Roles V2", "x-docs-resource-type": "IncidentRoleV2" }, "post": { "description": "Create a new incident role", "operationId": "Incident Roles V2#Create", "requestBody": { "content": { "application/json": { "example": { "description": "The person currently coordinating the incident", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "shortform": "lead" }, "schema": { "$ref": "#/components/schemas/IncidentRolesCreatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/IncidentRolesCreateResultV2" } } }, "description": "Created response." } }, "summary": "Create Incident Roles V2", "tags": [ "Incident Roles V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Incident Roles V2", "x-docs-resource-type": "IncidentRoleV2" } }, "/v2/incident_roles/{id}": { "delete": { "description": "Removes an existing role", "operationId": "Incident Roles V2#Delete", "parameters": [ { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." } }, "summary": "Delete Incident Roles V2", "tags": [ "Incident Roles V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Incident Roles V2", "x-docs-resource-type": "IncidentRoleV2" }, "get": { "description": "Get a single incident role.", "operationId": "Incident Roles V2#Show", "parameters": [ { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/IncidentRolesShowResultV2" } } }, "description": "OK response." } }, "summary": "Show Incident Roles V2", "tags": [ "Incident Roles V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Incident Roles V2", "x-docs-resource-type": "IncidentRoleV2" }, "put": { "description": "Update an existing incident role", "operationId": "Incident Roles V2#Update", "parameters": [ { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "The person currently coordinating the incident", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "shortform": "lead" }, "schema": { "$ref": "#/components/schemas/IncidentRolesUpdatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/IncidentRolesUpdateResultV2" } } }, "description": "OK response." } }, "summary": "Update Incident Roles V2", "tags": [ "Incident Roles V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Incident Roles V2", "x-docs-resource-type": "IncidentRoleV2" } }, "/v2/incident_timestamps": { "get": { "description": "List all incident timestamps for an organisation.", "operationId": "Incident Timestamps V2#List", "responses": { "200": { "content": { "application/json": { "example": { "incident_timestamps": [ { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 } ] }, "schema": { "$ref": "#/components/schemas/IncidentTimestampsListResultV2" } } }, "description": "OK response." } }, "summary": "List Incident Timestamps V2", "tags": [ "Incident Timestamps V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Incident Timestamps V2", "x-docs-resource-type": "IncidentTimestampV2" } }, "/v2/incident_timestamps/{id}": { "get": { "description": "Get a single incident timestamp.", "operationId": "Incident Timestamps V2#Show", "parameters": [ { "description": "Unique ID of this incident timestamp", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique ID of this incident timestamp", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 } }, "schema": { "$ref": "#/components/schemas/IncidentTimestampsShowResultV2" } } }, "description": "OK response." } }, "summary": "Show Incident Timestamps V2", "tags": [ "Incident Timestamps V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Incident Timestamps V2", "x-docs-resource-type": "IncidentTimestampV2" } }, "/v2/incident_updates": { "get": { "description": "List all incident updates for an organisation, or for a specific incident.", "operationId": "Incident Updates V2#List", "parameters": [ { "allowEmptyValue": true, "description": "Incident whose updates you want to list", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "in": "query", "name": "incident_id", "schema": { "description": "Incident whose updates you want to list", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } }, { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_updates": [ { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merged_into_incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "message": "We're working on a fix, hoping to ship in the next 30 minutes", "new_incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "new_severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/IncidentUpdatesListResultV2" } } }, "description": "OK response." } }, "summary": "List Incident Updates V2", "tags": [ "Incident Updates V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Incident Updates V2", "x-docs-resource-type": "IncidentUpdateV2" } }, "/v2/incidents": { "get": { "description": "List all incidents for an organisation.\n\nThis endpoint supports a number of filters, which can help find incidents matching certain\ncriteria.\n\nFilters are provided as query parameters, but due to the dynamic nature of what you can\nquery by (different accounts have different custom fields, statuses, etc) they are more\ncomplex than most.\n\nThe maximum page size that can be requested is 250.\n\nTo help, here are some exemplar curl requests with a human description of what they search\nfor.\n\nNote that:\n- Filters may be combined using the filter_mode parameter: 'all' (default) requires all filters\nto match (AND logic), while 'any' requires at least one filter to match (OR logic).\n- IDs are normally in UUID format, but have been replaced with shorter strings to improve\nreadability.\n- All query parameters must be URI encoded.\n\n### By status\n\nWith status of id=ABC, find all incidents that are set to that status:\n\n\t\tcurl --get 'https://api.incident.io/v2/incidents' \\\n\t\t\t--data 'status[one_of]=ABC'\n\nOr all incidents that are not set to status with id=ABC:\n\n\t\tcurl --get 'https://api.incident.io/v2/incidents' \\\n\t\t\t--data 'status[not_in]=ABC'\n\n### By created_at or updated_at\n\nFind all incidents that follow specified date parameters for created_at and updated_at fields.\nPossible values are \"gte\" (greater than or equal to), \"lte\" (less than or equal to), and\n\"date_range\" (between two dates). The following example finds all incidents created before\nor on 2021-01-02T00:00:00Z:\n\n\t\tcurl --get 'https://api.incident.io/v2/incidents' \\\n\t\t\t--data 'created_at[lte]=2021-01-02'\n\nTo find incidents created within a specific date range, use the date_range option with\ntilde-separated dates:\n\n\t\tcurl --get 'https://api.incident.io/v2/incidents' \\\n\t\t\t--data 'created_at[date_range]=2024-12-02~2024-12-08'\n\n### By status category\n\nFind all incidents that are in a status category. Possible values are \"triage\",\n\"declined\", \"merged\", \"canceled\", \"live\", \"learning\" and \"closed\":\n\n\t\tcurl --get 'https://api.incident.io/v2/incidents' \\\n\t\t\t--data 'status_category[one_of]=live'\n\nOr all incidents that are not in a status category:\n\n\t\tcurl --get 'https://api.incident.io/v2/incidents' \\\n\t\t\t--data 'status_category[not_in]=live'\n\n\n### By severity\n\nWith severity of id=ABC, find all incidents that are set to that severity:\n\n\t\tcurl --get 'https://api.incident.io/v2/incidents' \\\n\t\t\t--data 'severity[one_of]=ABC'\n\nOr all incidents where severity rank is greater-than-or-equal-to the rank of severity\nid=ABC:\n\n\t\tcurl --get 'https://api.incident.io/v2/incidents' \\\n\t\t\t--data 'severity[gte]=ABC'\n\nOr all incidents where severity rank is less-than-or-equal-to the rank of severity id=ABC:\n\n\t\tcurl --get 'https://api.incident.io/v2/incidents' \\\n\t\t\t--data 'severity[lte]=ABC'\n\n### By incident type\n\nWith incident type of id=ABC, find all incidents that are of that type:\n\n\t\tcurl --get 'https://api.incident.io/v2/incidents' \\\n\t\t\t--data 'incident_type[one_of]=ABC'\n\nOr all incidents not of that type:\n\n\t\tcurl --get 'https://api.incident.io/v2/incidents' \\\n\t\t\t--data 'incident_type[not_in]=ABC'\n\n### By incident mode\n\nBy default, we return standard and retrospective incidents. This means that test and\ntutorial incidents are filtered out. To override this behaviour, you can use the\nmode filter to specify which modes you want to get.\n\nTo find incidents of all modes:\n\n\t\tcurl --get 'https://api.incident.io/v2/incidents' \\\n\t\t\t--data 'mode[one_of]=standard\u0026mode[one_of]=retrospective\u0026mode[one_of]=test\u0026mode[one_of]=tutorial'\n\nTo find just test incidents:\n\n\t\tcurl --get 'https://api.incident.io/v2/incidents' \\\n\t\t\t--data 'mode[one_of]=test'\n\n\n### By incident role\n\nRoles and custom fields have another nested layer in the query parameter, to account for\noperations against any of the roles or custom fields created in the account.\n\nWith incident role id=ABC, find all incidents where that role is unset:\n\n\t\tcurl --get 'https://api.incident.io/v2/incidents' \\\n\t\t\t--data 'incident_role[ABC][is_set]=true'\n\nOr where the role has been set:\n\n\t\tcurl --get 'https://api.incident.io/v2/incidents' \\\n\t\t\t--data 'incident_role[ABC][is_set]=false'\n\n### By option custom fields\n\nWith an option custom field id=ABC, all incidents that have field ABC set to the custom\nfield option of id=XYZ:\n\n\t\tcurl \\\n\t\t\t--get 'https://api.incident.io/v2/incidents' \\\n\t\t\t--data 'custom_field[ABC][one_of]=XYZ'\n\nOr all incidents that do not have custom field id=ABC set to option id=XYZ:\n\n\t\tcurl \\\n\t\t\t--get 'https://api.incident.io/v2/incidents' \\\n\t\t\t--data 'custom_field[ABC][not_in]=XYZ'\n\n### Sorting\n\nBy default, results are ordered by their creation date. You can use the sort_by parameter\nto reverse this order:\n\n\t\tcurl \\\n\t\t\t--get 'https://api.incident.io/v2/incidents' \\\n\t\t\t--data 'sort_by=created_at_oldest_first'\n", "operationId": "Incidents V2#List", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 500, "type": "integer" } }, { "allowEmptyValue": true, "description": "An incident's ID. This endpoint will return a list of incidents after this ID in relation to the API response order.", "examples": { "default": { "summary": "default", "value": "01FDAG4SAP5TYPT98WGR2N7W91" } }, "in": "query", "name": "after", "schema": { "description": "An incident's ID. This endpoint will return a list of incidents after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "allowEmptyValue": true, "description": "What order to return results in.", "example": "created_at_newest_first", "in": "query", "name": "sort_by", "schema": { "default": "created_at_newest_first", "description": "What order to return results in.", "enum": [ "created_at_newest_first", "created_at_oldest_first" ], "example": "created_at_newest_first", "type": "string" } }, { "allowEmptyValue": true, "description": "How to combine the filters: 'all' combines them with AND logic (all must match), 'any' combines them with OR logic (any can match). Defaults to 'all'.", "example": "all", "in": "query", "name": "filter_mode", "schema": { "description": "How to combine the filters: 'all' combines them with AND logic (all must match), 'any' combines them with OR logic (any can match). Defaults to 'all'.", "enum": [ "all", "any" ], "example": "all", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter on incident status. The accepted operators are 'one_of', or 'not_in'.", "example": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "in": "query", "name": "status", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on incident status. The accepted operators are 'one_of', or 'not_in'.", "example": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on the category of the incidents status. The accepted operators are 'one_of', or 'not_in'.", "example": { "one_of": [ "active" ] }, "in": "query", "name": "status_category", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on the category of the incidents status. The accepted operators are 'one_of', or 'not_in'.", "example": { "one_of": [ "active" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on incident created at timestamp. The accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "created_at[gte]": [ "2024-05-01" ] }, "in": "query", "name": "created_at", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on incident created at timestamp. The accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "created_at[gte]": [ "2024-05-01" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on incident updated at timestamp. The accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "updated_at[gte]": [ "2024-05-01" ] }, "in": "query", "name": "updated_at", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on incident updated at timestamp. The accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "updated_at[gte]": [ "2024-05-01" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on incident severity. The accepted operators are 'one_of', 'not_in', 'gte', 'lte'.", "example": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "in": "query", "name": "severity", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on incident severity. The accepted operators are 'one_of', 'not_in', 'gte', 'lte'.", "example": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on incident type. The accepted operators are 'one_of, or 'not_in'.", "example": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "in": "query", "name": "incident_type", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on incident type. The accepted operators are 'one_of, or 'not_in'.", "example": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on an incident role. Role ID should be sent, along with backlink attribute ID (if needed) followed by the operator and values. The accepted operators are 'one_of', 'is_blank'.", "example": { "01GBSQF3FHF7FWZQNWGHAVQ804": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "01ET65M7ZARSFZ6TFDFVQDN9AA" ] } }, "in": "query", "name": "incident_role", "schema": { "additionalProperties": { "additionalProperties": { "example": [ "value" ], "items": { "example": "value", "type": "string" }, "type": "array" }, "example": { "abc123": [ "value" ] }, "type": "object" }, "description": "Filter on an incident role. Role ID should be sent, along with backlink attribute ID (if needed) followed by the operator and values. The accepted operators are 'one_of', 'is_blank'.", "example": { "01GBSQF3FHF7FWZQNWGHAVQ804": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "01ET65M7ZARSFZ6TFDFVQDN9AA" ] } }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on an incident custom field. Custom field ID should be sent, followed by the operator and values. Accepted operator will depend on the custom field type.", "example": { "01GBSQF3FHF7FWZQNWGHAVQ804": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "01ET65M7ZARSFZ6TFDFVQDN9AA" ] } }, "in": "query", "name": "custom_field", "schema": { "additionalProperties": { "additionalProperties": { "example": [ "value" ], "items": { "example": "value", "type": "string" }, "type": "array" }, "example": { "abc123": [ "value" ] }, "type": "object" }, "description": "Filter on an incident custom field. Custom field ID should be sent, followed by the operator and values. Accepted operator will depend on the custom field type.", "example": { "01GBSQF3FHF7FWZQNWGHAVQ804": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "01ET65M7ZARSFZ6TFDFVQDN9AA" ] } }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on incident mode. The accepted operator is 'one_of'. If this is not provided, this value defaults to `{\"one_of\": [\"standard\", \"retrospective\"] }`, meaning that test and tutorial incidents are not included.", "example": { "one_of": [ "retrospective" ] }, "in": "query", "name": "mode", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on incident mode. The accepted operator is 'one_of'. If this is not provided, this value defaults to `{\"one_of\": [\"standard\", \"retrospective\"] }`, meaning that test and tutorial incidents are not included.", "example": { "one_of": [ "retrospective" ] }, "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incidents": [ { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "value_seconds": 10800 } ], "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "has_debrief": false, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "incident_timestamp_values": [ { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "value": { "value": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "standard", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_ids": [ "01FCNDV6P870EA6S7TK1DSYD5H" ], "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 } }, "schema": { "$ref": "#/components/schemas/IncidentsListResultV2" } } }, "description": "OK response." } }, "summary": "List Incidents V2", "tags": [ "Incidents V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Incidents V2", "x-docs-resource-type": "IncidentV2" }, "post": { "description": "Create a new incident.\n\nNote that if the incident mode is set to \"retrospective\" then the new incident\nwill not be announced in Slack.\n", "operationId": "Incidents V2#Create", "requestBody": { "content": { "application/json": { "example": { "custom_field_entries": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] } ], "idempotency_key": "alert-uuid", "incident_role_assignments": [ { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" } ], "incident_status_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "incident_timestamp_values": [ { "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYD5H", "value": "2021-08-17T13:28:57.801578Z" } ], "incident_type_id": "01FH5TZRWMNAFB0DZ23FD1TV96", "mode": "standard", "name": "Our database is sad", "retrospective_incident_options": { "external_id": 123, "postmortem_document_url": "https://docs.google.com/my_doc_id", "slack_channel_id": "abc123" }, "severity_id": "01FH5TZRWMNAFB0DZ23FD1TV96", "slack_channel_name_override": "inc-123-database-down", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" }, "schema": { "$ref": "#/components/schemas/IncidentsCreatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "incident": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "value_seconds": 10800 } ], "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "has_debrief": false, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "incident_timestamp_values": [ { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "value": { "value": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "standard", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_ids": [ "01FCNDV6P870EA6S7TK1DSYD5H" ], "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 } }, "schema": { "$ref": "#/components/schemas/IncidentsCreateResultV2" } } }, "description": "OK response." } }, "summary": "Create Incidents V2", "tags": [ "Incidents V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Incidents V2", "x-docs-resource-type": "IncidentV2" } }, "/v2/incidents/{id}": { "get": { "description": "Get a single incident.\n\nThe ID supplied can be either the incident's full ID, or the numeric part of its\nreference. For example, to get INC-123, you could use either its full ID or:\n\n\t\tcurl \\\n\t\t\t--get 'https://api.incident.io/v2/incidents/123\n", "operationId": "Incidents V2#Show", "parameters": [ { "description": "Unique identifier for the incident", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the incident", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "value_seconds": 10800 } ], "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "has_debrief": false, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "incident_timestamp_values": [ { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "value": { "value": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "standard", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_ids": [ "01FCNDV6P870EA6S7TK1DSYD5H" ], "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 } }, "schema": { "$ref": "#/components/schemas/IncidentsShowResultV2" } } }, "description": "OK response." } }, "summary": "Show Incidents V2", "tags": [ "Incidents V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Incidents V2", "x-docs-resource-type": "IncidentV2" } }, "/v2/incidents/{id}/actions/edit": { "post": { "description": "Edit an existing incident.\n\nThis endpoint allows you to edit the properties of an existing incident: e.g. set the severity or update custom fields.\n\nWhen using this endpoint, only fields that are provided will be edited (omitted fields\nwill be ignored).\n", "operationId": "Incidents V2#Edit", "parameters": [ { "description": "The unique identifier of the incident that you want to edit", "example": "01G18REBY9AYH6CMWCJ2CVCYCH", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the incident that you want to edit", "example": "01G18REBY9AYH6CMWCJ2CVCYCH", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "incident": { "call_url": "https://zoom.us/foo", "custom_field_entries": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] } ], "incident_role_assignments": [ { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" } ], "incident_status_id": "abc123", "incident_timestamp_values": [ { "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYD5H", "value": "2021-08-17T13:28:57.801578Z" } ], "name": "Our database is sad", "severity_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_channel_name_override": "inc-123-database-down", "summary": "Our database is really really sad, and we don't know why yet." }, "notify_incident_channel": true }, "schema": { "$ref": "#/components/schemas/IncidentsEditPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "incident": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "value_seconds": 10800 } ], "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "has_debrief": false, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "incident_timestamp_values": [ { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "value": { "value": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "standard", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_ids": [ "01FCNDV6P870EA6S7TK1DSYD5H" ], "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 } }, "schema": { "$ref": "#/components/schemas/IncidentsEditResultV2" } } }, "description": "OK response." } }, "summary": "Edit Incidents V2", "tags": [ "Incidents V2" ], "x-docs-display-name": "Edit", "x-docs-group-name": "Incidents V2", "x-docs-resource-type": "IncidentV2" } }, "/v2/incidents/{id}/actions/import_postmortem_document": { "post": { "description": "Import a postmortem document from markdown into an incident.\n\nThe document content should be provided as GitHub-Flavored Markdown. It will be\nparsed and converted into the collaborative editor format, and a new postmortem\ndocument will be created for the incident.\n\nIf no main postmortem document exists for the incident, the imported document\nwill become the main document.", "operationId": "Incidents V2#ImportPostmortemDocument", "parameters": [ { "description": "The unique identifier of the incident", "example": "01GBA8J19SMXQWPJMX3P2ESCVG", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the incident", "example": "01GBA8J19SMXQWPJMX3P2ESCVG", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "content": "## Summary\n\nA database migration caused increased latency...", "title": "INC-123: Post-incident review" }, "schema": { "$ref": "#/components/schemas/IncidentsImportPostmortemDocumentPayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "postmortem_document": { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" } }, "schema": { "$ref": "#/components/schemas/IncidentsImportPostmortemDocumentResultV2" } } }, "description": "Created response.", "headers": { "Location": { "description": "URL of the created postmortem document resource", "example": "abc123", "schema": { "description": "URL of the created postmortem document resource", "example": "abc123", "type": "string" } } } } }, "summary": "ImportPostmortemDocument Incidents V2", "tags": [ "Incidents V2" ], "x-docs-display-name": "Import postmortem document", "x-docs-group-name": "Incidents V2", "x-docs-resource-type": "IncidentV2" } }, "/v2/schedule_entries": { "get": { "description": "Get a list of schedule entries. The endpoint will return all entries that overlap with the given window, if one is provided.", "operationId": "Schedules V2#ListScheduleEntries", "parameters": [ { "allowEmptyValue": true, "description": "The ID of the schedule to get entries for.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "schedule_id", "required": true, "schema": { "description": "The ID of the schedule to get entries for.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "allowEmptyValue": true, "description": "The start of the window to get entries for.", "example": "2021-01-01T00:00:00Z", "in": "query", "name": "entry_window_start", "schema": { "description": "The start of the window to get entries for.", "example": "2021-01-01T00:00:00Z", "format": "date-time", "type": "string" } }, { "allowEmptyValue": true, "description": "The end of the window to get entries for.", "example": "2021-01-01T00:00:00Z", "in": "query", "name": "entry_window_end", "schema": { "description": "The end of the window to get entries for.", "example": "2021-01-01T00:00:00Z", "format": "date-time", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "abc123", "after_url": "abc123" }, "schedule_entries": { "final": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "overrides": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "scheduled": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ] } }, "schema": { "$ref": "#/components/schemas/SchedulesListScheduleEntriesResultV2" } } }, "description": "OK response." } }, "summary": "ListScheduleEntries Schedules V2", "tags": [ "Schedules V2" ], "x-display-name": "List", "x-docs-display-name": "List", "x-docs-group-name": "Schedule Entries V2", "x-docs-resource-type": "ScheduleEntryV2" } }, "/v2/schedule_overrides": { "post": { "description": "Create a new schedule override.", "operationId": "Schedules V2#CreateOverride", "requestBody": { "content": { "application/json": { "example": { "end_at": "2021-08-17T14:00:00.000000Z", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "schedule_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:00:00.000000Z", "user": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } }, "schema": { "$ref": "#/components/schemas/SchedulesCreateOverridePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "override": { "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "schedule_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } }, "schema": { "$ref": "#/components/schemas/SchedulesCreateOverrideResultV2" } } }, "description": "Created response." } }, "summary": "CreateOverride Schedules V2", "tags": [ "Schedules V2" ], "x-display-name": "Create", "x-docs-display-name": "Create", "x-docs-group-name": "Schedule Overrides V2", "x-docs-resource-type": "ScheduleOverrideV2" } }, "/v2/schedules": { "get": { "description": "List configured schedules.", "operationId": "Schedules V2#List", "parameters": [ { "allowEmptyValue": true, "description": "Note that next_shifts will only be returned when the page size is 25 or lower.", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Note that next_shifts will only be returned when the page size is 25 or lower.", "example": 25, "format": "int64", "maximum": 10000, "type": "integer" } }, { "allowEmptyValue": true, "description": "A schedule's ID. This endpoint will return a list of schedules after this ID in relation to the API response order.", "examples": { "default": { "summary": "default", "value": "01FDAG4SAP5TYPT98WGR2N7W91" } }, "in": "query", "name": "after", "schema": { "description": "A schedule's ID. This endpoint will return a list of schedules after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 }, "schedules": [ { "annotations": { "incident.io/terraform/version": "3.0.0" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "created_at": "2021-08-17T13:28:57.801578Z", "current_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "holidays_public_config": { "country_codes": [ "GB", "FR" ] }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "next_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/SchedulesListResultV2" } } }, "description": "OK response." } }, "summary": "List Schedules V2", "tags": [ "Schedules V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Schedules V2", "x-docs-resource-type": "ScheduleV2" }, "post": { "description": "Create a new schedule.", "operationId": "Schedules V2#Create", "requestBody": { "content": { "application/json": { "example": { "schedule": { "annotations": { "incident.io/terraform/version": "version-of-terraform" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "holidays_public_config": { "country_codes": [ "abc123" ] }, "name": "Primary On-call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "America/Los_Angeles" } }, "schema": { "$ref": "#/components/schemas/SchedulesCreatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "schedule": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "created_at": "2021-08-17T13:28:57.801578Z", "current_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "holidays_public_config": { "country_codes": [ "GB", "FR" ] }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "next_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/SchedulesCreateResultV2" } } }, "description": "Created response." } }, "summary": "Create Schedules V2", "tags": [ "Schedules V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Schedules V2", "x-docs-resource-type": "ScheduleV2" } }, "/v2/schedules/{id}": { "delete": { "description": "Archives a single schedule. Will fail if the schedule has active replicas — remove all replicas before deleting.", "operationId": "Schedules V2#Destroy", "parameters": [ { "description": "Unique internal ID of the schedule", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique internal ID of the schedule", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } } ], "responses": { "202": { "description": "Accepted response." } }, "summary": "Destroy Schedules V2", "tags": [ "Schedules V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Schedules V2", "x-docs-resource-type": "ScheduleV2" }, "get": { "description": "Get a single schedule.", "operationId": "Schedules V2#Show", "parameters": [ { "description": "Unique internal ID of the schedule", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique internal ID of the schedule", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "schedule": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "created_at": "2021-08-17T13:28:57.801578Z", "current_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "holidays_public_config": { "country_codes": [ "GB", "FR" ] }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "next_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/SchedulesShowResultV2" } } }, "description": "OK response." } }, "summary": "Show Schedules V2", "tags": [ "Schedules V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Schedules V2", "x-docs-resource-type": "ScheduleV2" }, "put": { "description": "Update a schedule.", "operationId": "Schedules V2#Update", "parameters": [ { "description": "The schedule ID to update.", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "in": "path", "name": "id", "required": true, "schema": { "description": "The schedule ID to update.", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "schedule": { "annotations": { "incident.io/terraform/version": "version-of-terraform" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "holidays_public_config": { "country_codes": [ "abc123" ] }, "name": "Primary On-call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "America/Los_Angeles" } }, "schema": { "$ref": "#/components/schemas/SchedulesUpdatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "schedule": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "created_at": "2021-08-17T13:28:57.801578Z", "current_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "holidays_public_config": { "country_codes": [ "GB", "FR" ] }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "next_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/SchedulesUpdateResultV2" } } }, "description": "OK response." } }, "summary": "Update Schedules V2", "tags": [ "Schedules V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Schedules V2", "x-docs-resource-type": "ScheduleV2" } }, "/v2/schedules/{schedule_id}/replicas": { "get": { "description": "List all replicas for a schedule.", "operationId": "Schedules V2#ListScheduleReplicas", "parameters": [ { "description": "The schedule to list replicas for", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "schedule_id", "required": true, "schema": { "description": "The schedule to list replicas for", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "schedule_replicas": [ { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_sync_error": "Failed to find external user for Milly", "last_synced_at": "2023-11-07T13:33:30Z", "mirror_window_days": 14, "replica_fallback_user_id": "PA7AXXN", "replica_provider": "pagerduty", "replica_provider_id": "PO8107X", "schedule_id": "01FDAG4SAP5TYPT98WGR2N7W91", "sources": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "user_statuses": [ { "external_user_id": "PJYTRGS", "user_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ] } ] }, "schema": { "$ref": "#/components/schemas/SchedulesListScheduleReplicasResultV2" } } }, "description": "OK response." } }, "summary": "ListScheduleReplicas Schedules V2", "tags": [ "Schedules V2" ], "x-display-name": "List", "x-docs-display-name": "List", "x-docs-group-name": "Schedule Replicas V2", "x-docs-resource-type": "ScheduleReplicaV2" }, "post": { "description": "Create a new schedule replica.", "operationId": "Schedules V2#CreateScheduleReplica", "parameters": [ { "description": "The schedule to create a replica for", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "schedule_id", "required": true, "schema": { "description": "The schedule to create a replica for", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "schedule_replica": { "mirror_window_days": 14, "replica_fallback_user_id": "PA7AXXN", "replica_provider": "pagerduty", "replica_provider_id": "PO8107X", "sources": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ] } }, "schema": { "$ref": "#/components/schemas/SchedulesCreateScheduleReplicaPayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "schedule_replica": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_sync_error": "Failed to find external user for Milly", "last_synced_at": "2023-11-07T13:33:30Z", "mirror_window_days": 14, "replica_fallback_user_id": "PA7AXXN", "replica_provider": "pagerduty", "replica_provider_id": "PO8107X", "schedule_id": "01FDAG4SAP5TYPT98WGR2N7W91", "sources": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "user_statuses": [ { "external_user_id": "PJYTRGS", "user_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ] } }, "schema": { "$ref": "#/components/schemas/SchedulesCreateScheduleReplicaResultV2" } } }, "description": "Created response." } }, "summary": "CreateScheduleReplica Schedules V2", "tags": [ "Schedules V2" ], "x-display-name": "Create", "x-docs-display-name": "Create", "x-docs-group-name": "Schedule Replicas V2", "x-docs-resource-type": "ScheduleReplicaV2" } }, "/v2/schedules/{schedule_id}/replicas/{id}": { "delete": { "description": "Archives a single schedule replica, stopping incident.io from syncing on-call shifts to the external provider.\n\nAs with disabling mirroring via the UI, this will remove any upcoming overrides that incident.io has created in the external schedule, restoring it to its original state. If multiple replicas target the same external schedule, overrides are only removed when the last replica pointing to that schedule is deleted.\n\nNote: override cleanup is supported for PagerDuty and Jira Service Management. Opsgenie does not support programmatic override deletion, so overrides must be removed manually.", "operationId": "Schedules V2#DestroyScheduleReplica", "parameters": [ { "description": "The parent schedule ID", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "schedule_id", "required": true, "schema": { "description": "The parent schedule ID", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "description": "The replica ID to archive", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "The replica ID to archive", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "204": { "description": "No Content response." } }, "summary": "DestroyScheduleReplica Schedules V2", "tags": [ "Schedules V2" ], "x-display-name": "Destroy", "x-docs-display-name": "Delete", "x-docs-group-name": "Schedule Replicas V2", "x-docs-resource-type": "ScheduleReplicaV2" }, "get": { "description": "Get a single schedule replica.", "operationId": "Schedules V2#ShowScheduleReplica", "parameters": [ { "description": "The parent schedule ID", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "schedule_id", "required": true, "schema": { "description": "The parent schedule ID", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "description": "The replica ID to show", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "The replica ID to show", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "schedule_replica": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_sync_error": "Failed to find external user for Milly", "last_synced_at": "2023-11-07T13:33:30Z", "mirror_window_days": 14, "replica_fallback_user_id": "PA7AXXN", "replica_provider": "pagerduty", "replica_provider_id": "PO8107X", "schedule_id": "01FDAG4SAP5TYPT98WGR2N7W91", "sources": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "user_statuses": [ { "external_user_id": "PJYTRGS", "user_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ] } }, "schema": { "$ref": "#/components/schemas/SchedulesShowScheduleReplicaResultV2" } } }, "description": "OK response." } }, "summary": "ShowScheduleReplica Schedules V2", "tags": [ "Schedules V2" ], "x-display-name": "Show", "x-docs-display-name": "Show", "x-docs-group-name": "Schedule Replicas V2", "x-docs-resource-type": "ScheduleReplicaV2" } }, "/v2/status_page_incident_updates": { "post": { "description": "Post an update on a Status Page incident.\n\nThis is the endpoint to use when resolving an incident - set incident_status to \"resolved\" to end the incident. There is a limit of 100 updates per incident.\n\nThis endpoint requires an API key with the \"Create status page incidents, status page maintenance windows, and publish status page updates\" scope.", "operationId": "Status Pages V2#CreateStatusPageIncidentUpdate", "requestBody": { "content": { "application/json": { "example": { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "incident_status": "investigating", "message": "The fix has been deployed and we are monitoring the situation. Some users may still experience intermittent issues.", "notify_subscribers": true, "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" }, "schema": { "$ref": "#/components/schemas/StatusPagesCreateStatusPageIncidentUpdatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "status_page_incident_update": { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } }, "schema": { "$ref": "#/components/schemas/StatusPagesCreateStatusPageIncidentUpdateResultV2" } } }, "description": "Created response." } }, "summary": "CreateStatusPageIncidentUpdate Status Pages V2", "tags": [ "Status Pages V2" ], "x-display-name": "Create", "x-docs-display-name": "Create", "x-docs-group-name": "Status Page Incident Updates V2", "x-docs-resource-type": "StatusPageIncidentUpdateV2" } }, "/v2/status_page_incidents": { "get": { "description": "List status page incidents.\n\nThis endpoint requires a valid API key but no specific scopes.", "operationId": "Status Pages V2#ListStatusPageIncidents", "parameters": [ { "allowEmptyValue": true, "description": "ID of the status page. You can find this by calling the ListStatusPages endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "status_page_id", "required": true, "schema": { "description": "ID of the status page. You can find this by calling the ListStatusPages endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page incidents to only those that impacted the specified component. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "in": "query", "name": "component_id", "schema": { "description": "Filter status page incidents to only those that impacted the specified component. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page incidents to only those that impacted components in the specified group. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG2", "in": "query", "name": "group_id", "schema": { "description": "Filter status page incidents to only those that impacted components in the specified group. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG2", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page incidents to only those that impacted the specified sub-page. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG3", "in": "query", "name": "sub_page_id", "schema": { "description": "Filter status page incidents to only those that impacted the specified sub-page. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG3", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page incidents to only those that had impacts during or after this time.", "example": "2021-08-17T13:28:57.801578Z", "in": "query", "name": "start_at", "schema": { "description": "Filter status page incidents to only those that had impacts during or after this time.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page incidents to only those that had impacts during or before this time.", "example": "2021-08-17T13:28:57.801578Z", "in": "query", "name": "end_at", "schema": { "description": "Filter status page incidents to only those that had impacts during or before this time.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "status_page_incidents": [ { "component_impacts": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "name": "Elevated API latency", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } ] }, "schema": { "$ref": "#/components/schemas/StatusPagesListStatusPageIncidentsResultV2" } } }, "description": "OK response." } }, "summary": "ListStatusPageIncidents Status Pages V2", "tags": [ "Status Pages V2" ], "x-display-name": "List", "x-docs-display-name": "List", "x-docs-group-name": "Status Page Incidents V2", "x-docs-resource-type": "StatusPageIncidentV2" }, "post": { "description": "Create a status page incident.\n\nThis endpoint requires an API key with the \"Create status page incidents, status page maintenance windows, and publish status page updates\" scope.", "operationId": "Status Pages V2#CreateStatusPageIncident", "requestBody": { "content": { "application/json": { "example": { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "idempotency_key": "alert-12345-abcde", "incident_status": "investigating", "message": "We are currently investigating reports of elevated error rates affecting our API.", "name": "Elevated API latency", "notify_subscribers": true, "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "schema": { "$ref": "#/components/schemas/StatusPagesCreateStatusPageIncidentPayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "status_page_incident": { "component_impacts": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "name": "Elevated API latency", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "schema": { "$ref": "#/components/schemas/StatusPagesCreateStatusPageIncidentResultV2" } } }, "description": "Created response." } }, "summary": "CreateStatusPageIncident Status Pages V2", "tags": [ "Status Pages V2" ], "x-display-name": "Create", "x-docs-display-name": "Create", "x-docs-group-name": "Status Page Incidents V2", "x-docs-resource-type": "StatusPageIncidentV2" } }, "/v2/status_page_incidents/{status_page_incident_id}": { "get": { "description": "Show a status page incident.\n\nThis endpoint requires a valid API key but no specific scopes.", "operationId": "Status Pages V2#ShowStatusPageIncident", "parameters": [ { "description": "ID of the status page incident", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "in": "path", "name": "status_page_incident_id", "required": true, "schema": { "description": "ID of the status page incident", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "status_page_incident": { "component_impacts": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "name": "Elevated API latency", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "schema": { "$ref": "#/components/schemas/StatusPagesShowStatusPageIncidentResultV2" } } }, "description": "OK response." } }, "summary": "ShowStatusPageIncident Status Pages V2", "tags": [ "Status Pages V2" ], "x-display-name": "Show", "x-docs-display-name": "Show", "x-docs-group-name": "Status Page Incidents V2", "x-docs-resource-type": "StatusPageIncidentV2" }, "put": { "description": "Update a status page incident.\n\nThis endpoint requires an API key with the \"Create status page incidents, status page maintenance windows, and publish status page updates\" scope.", "operationId": "Status Pages V2#UpdateStatusPageIncident", "parameters": [ { "description": "ID of the status page incident", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "in": "path", "name": "status_page_incident_id", "required": true, "schema": { "description": "ID of the status page incident", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "name": "Elevated API latency" }, "schema": { "$ref": "#/components/schemas/StatusPagesUpdateStatusPageIncidentPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "status_page_incident": { "component_impacts": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "name": "Elevated API latency", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "schema": { "$ref": "#/components/schemas/StatusPagesUpdateStatusPageIncidentResultV2" } } }, "description": "OK response." } }, "summary": "UpdateStatusPageIncident Status Pages V2", "tags": [ "Status Pages V2" ], "x-display-name": "Update", "x-docs-display-name": "Update", "x-docs-group-name": "Status Page Incidents V2", "x-docs-resource-type": "StatusPageIncidentV2" } }, "/v2/status_page_maintenance_updates": { "post": { "description": "Post an update on a Status Page maintenance window.\n\nThis is the endpoint to use when completing a maintenance window - set maintenance_status to \"maintenance_complete\" to end the maintenance. There is a limit of 100 updates per maintenance window.\n\nThis endpoint requires an API key with the \"Create status page incidents, status page maintenance windows, and publish status page updates\" scope.", "operationId": "Status Pages V2#CreateStatusPageMaintenanceUpdate", "requestBody": { "content": { "application/json": { "example": { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "maintenance_status": "maintenance_scheduled", "message": "Scheduled maintenance is underway for our database infrastructure. Some services may experience brief interruptions during this window.", "notify_subscribers": true, "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" }, "schema": { "$ref": "#/components/schemas/StatusPagesCreateStatusPageMaintenanceUpdatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "status_page_maintenance_update": { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } }, "schema": { "$ref": "#/components/schemas/StatusPagesCreateStatusPageMaintenanceUpdateResultV2" } } }, "description": "Created response." } }, "summary": "CreateStatusPageMaintenanceUpdate Status Pages V2", "tags": [ "Status Pages V2" ], "x-display-name": "Create", "x-docs-display-name": "Create", "x-docs-group-name": "Status Page Maintenance Updates V2", "x-docs-resource-type": "StatusPageMaintenanceUpdateV2" } }, "/v2/status_page_maintenances": { "get": { "description": "List status page maintenances.\n\nThis endpoint requires a valid API key but no specific scopes.", "operationId": "Status Pages V2#ListStatusPageMaintenances", "parameters": [ { "allowEmptyValue": true, "description": "ID of the status page. You can find this by calling the ListStatusPages endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "status_page_id", "required": true, "schema": { "description": "ID of the status page. You can find this by calling the ListStatusPages endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page maintenance windows to only those that impacted the specified component. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "in": "query", "name": "component_id", "schema": { "description": "Filter status page maintenance windows to only those that impacted the specified component. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page maintenance windows to only those that impacted components in the specified group. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG2", "in": "query", "name": "group_id", "schema": { "description": "Filter status page maintenance windows to only those that impacted components in the specified group. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG2", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page maintenance windows to only those that impacted the specified sub-page. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG3", "in": "query", "name": "sub_page_id", "schema": { "description": "Filter status page maintenance windows to only those that impacted the specified sub-page. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG3", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page maintenance windows to only those that had impacts during or after this time.", "example": "2021-08-17T13:28:57.801578Z", "in": "query", "name": "start_at", "schema": { "description": "Filter status page maintenance windows to only those that had impacts during or after this time.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page maintenance windows to only those that had impacts during or before this time.", "example": "2021-08-17T13:28:57.801578Z", "in": "query", "name": "end_at", "schema": { "description": "Filter status page maintenance windows to only those that had impacts during or before this time.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "status_page_maintenances": [ { "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } ] }, "schema": { "$ref": "#/components/schemas/StatusPagesListStatusPageMaintenancesResultV2" } } }, "description": "OK response." } }, "summary": "ListStatusPageMaintenances Status Pages V2", "tags": [ "Status Pages V2" ], "x-display-name": "List", "x-docs-display-name": "List", "x-docs-group-name": "Status Page Maintenances V2", "x-docs-resource-type": "StatusPageMaintenanceV2" }, "post": { "description": "Schedule a Status Page maintenance window.\n\nThis endpoint requires an API key with the \"Create status page incidents, status page maintenance windows, and publish status page updates\" scope.", "operationId": "Status Pages V2#CreateStatusPageMaintenance", "requestBody": { "content": { "application/json": { "example": { "affected_component_ids": [ "01FCNDV6P870EA6S7TK1DSYDG2" ], "end_at": "2025-01-28T12:00:00Z", "idempotency_key": "maintenance-12345-abcde", "maintenance_status": "maintenance_scheduled", "message": "Planned maintenance has been scheduled to upgrade our infrastructure. We expect minimal disruption, but some features may be briefly unavailable.", "name": "Routine infrastructure upgrade", "notify_subscribers": true, "start_at": "2025-01-28T10:00:00Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "schema": { "$ref": "#/components/schemas/StatusPagesCreateStatusPageMaintenancePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "status_page_maintenance": { "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "schema": { "$ref": "#/components/schemas/StatusPagesCreateStatusPageMaintenanceResultV2" } } }, "description": "Created response." } }, "summary": "CreateStatusPageMaintenance Status Pages V2", "tags": [ "Status Pages V2" ], "x-display-name": "Create", "x-docs-display-name": "Create", "x-docs-group-name": "Status Page Maintenances V2", "x-docs-resource-type": "StatusPageMaintenanceV2" } }, "/v2/status_page_maintenances/{status_page_maintenance_id}": { "get": { "description": "Show a status page maintenance window.\n\nThis endpoint requires a valid API key but no specific scopes.", "operationId": "Status Pages V2#ShowStatusPageMaintenance", "parameters": [ { "description": "ID of the status page maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "in": "path", "name": "status_page_maintenance_id", "required": true, "schema": { "description": "ID of the status page maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "status_page_maintenance": { "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "schema": { "$ref": "#/components/schemas/StatusPagesShowStatusPageMaintenanceResultV2" } } }, "description": "OK response." } }, "summary": "ShowStatusPageMaintenance Status Pages V2", "tags": [ "Status Pages V2" ], "x-display-name": "Show", "x-docs-display-name": "Show", "x-docs-group-name": "Status Page Maintenances V2", "x-docs-resource-type": "StatusPageMaintenanceV2" } }, "/v2/status_page_structures/{status_page_id}": { "get": { "description": "Show the structure of a status page.\n\nThis endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page. Use this to find component IDs when specifying affected components for incidents or maintenance windows.", "operationId": "Status Pages V2#ShowStatusPageStructure", "parameters": [ { "description": "ID of the status page", "example": "abc123", "in": "path", "name": "status_page_id", "required": true, "schema": { "description": "ID of the status page", "example": "abc123", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "current_structure": { "items": [ { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" }, "sub_page": { "id": "01FCNDV6P870EA6S7TK1DSYDG1", "items": [ { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" } } ], "name": "United Kingdom" } } ] } }, "schema": { "$ref": "#/components/schemas/StatusPagesShowStatusPageStructureResultV2" } } }, "description": "OK response." } }, "summary": "ShowStatusPageStructure Status Pages V2", "tags": [ "Status Pages V2" ], "x-display-name": "Show", "x-docs-display-name": "Show", "x-docs-group-name": "Status Pages V2", "x-docs-resource-type": "StatusPageV2" } }, "/v2/status_pages": { "get": { "description": "List all status pages for your organisation.\n\nThis endpoint requires a valid API key but no specific scopes. Use this to find status page IDs for use in other endpoints.", "operationId": "Status Pages V2#ListStatusPages", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "status_pages": [ { "description": "This status page is our public status page.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Our public status page", "public_url": "https://statuspage.incident.io/our-public-status-page" } ] }, "schema": { "$ref": "#/components/schemas/StatusPagesListStatusPagesResultV2" } } }, "description": "OK response." } }, "summary": "ListStatusPages Status Pages V2", "tags": [ "Status Pages V2" ], "x-display-name": "List", "x-docs-display-name": "List", "x-docs-group-name": "Status Pages V2", "x-docs-resource-type": "StatusPageV2" } }, "/v2/telemetry/data_sources/{id}": { "put": { "description": "Update the credentials or configuration of a telemetry data source. Provide only the config block that matches your data source type (e.g. grafana_config for Grafana, datadog_config for Datadog). New credentials are validated against the provider before being saved.", "operationId": "Telemetry V2#UpdateDataSource", "parameters": [ { "description": "Data source ID", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "in": "path", "name": "id", "required": true, "schema": { "description": "Data source ID", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "datadog_config": { "api_key": "abc123" }, "grafana_config": { "api_key": "glsa_123" }, "name": "Production Grafana" }, "schema": { "$ref": "#/components/schemas/TelemetryUpdateDataSourcePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data_source": { "created_at": "2021-08-17T13:28:57.801578Z", "enabled": true, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary Prometheus", "provider": "grafana", "source_type": "grafana", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/TelemetryUpdateDataSourceResultV2" } } }, "description": "OK response." } }, "summary": "UpdateDataSource Telemetry V2", "tags": [ "Telemetry V2" ], "x-display-name": "Update", "x-docs-display-name": "Update", "x-docs-group-name": "Telemetry V2", "x-docs-resource-type": "TelemetryDataSourceV2" } }, "/v2/users": { "get": { "description": "List users in your account.", "operationId": "Users V2#List", "parameters": [ { "allowEmptyValue": true, "description": "Filter by email address", "example": "john.doe@incident.io", "in": "query", "name": "email", "schema": { "description": "Filter by email address", "example": "john.doe@incident.io", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter by Slack user ID", "example": "U12345678", "in": "query", "name": "slack_user_id", "schema": { "description": "Filter by Slack user ID", "example": "U12345678", "type": "string" } }, { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 10000, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "users": [ { "base_role": { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" }, "custom_roles": [ { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" } ], "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "seats": { "on_call": "full_access", "response": "viewer_only" }, "slack_user_id": "U02AYNF2XJM" } ] }, "schema": { "$ref": "#/components/schemas/UsersListResultV2" } } }, "description": "OK response." } }, "summary": "List Users V2", "tags": [ "Users V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Users V2", "x-docs-resource-type": "UserWithRolesV2" } }, "/v2/users/{id}": { "get": { "description": "Get a single user.", "operationId": "Users V2#Show", "parameters": [ { "description": "Unique identifier of the user", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the user", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "user": { "base_role": { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" }, "custom_roles": [ { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" } ], "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "seats": { "on_call": "full_access", "response": "viewer_only" }, "slack_user_id": "U02AYNF2XJM" } }, "schema": { "$ref": "#/components/schemas/UsersShowResultV2" } } }, "description": "OK response." } }, "summary": "Show Users V2", "tags": [ "Users V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Users V2", "x-docs-resource-type": "UserWithRolesV2" } }, "/v2/users/{user_id}/notification_methods": { "get": { "description": "List notification methods for a user. Phone numbers are always partially redacted.", "operationId": "Users V2#ListNotificationMethods", "parameters": [ { "description": "The ID of the user whose notification methods you want to list.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "user_id", "required": true, "schema": { "description": "The ID of the user whose notification methods you want to list.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "notification_methods": [ { "address": "•••••••6789", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_usable": true, "method_type": "app" } ] }, "schema": { "$ref": "#/components/schemas/UsersListNotificationMethodsResultV2" } } }, "description": "OK response." } }, "summary": "ListNotificationMethods Users V2", "tags": [ "Users V2" ], "x-display-name": "List", "x-docs-display-name": "List", "x-docs-group-name": "Notification Methods V2", "x-docs-resource-type": "OnCallNotificationMethodPublicV2" } }, "/v2/users/{user_id}/notification_rules": { "get": { "description": "List notification rules for a user. Rules define how and when a user is notified for on-call pages. Only includes high_urgency and low_urgency rules; shift_changes rules are not returned.", "operationId": "Users V2#ListNotificationRules", "parameters": [ { "description": "The ID of the user whose notification rules you want to list.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "user_id", "required": true, "schema": { "description": "The ID of the user whose notification rules you want to list.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "notification_rules": [ { "app": { "push_notification_criticality": "critical" }, "delay_seconds": 0, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "method_target": { "all": {}, "specific": { "id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "specific" }, "method_type": "app", "rule_type": "low_urgency" } ] }, "schema": { "$ref": "#/components/schemas/UsersListNotificationRulesResultV2" } } }, "description": "OK response." } }, "summary": "ListNotificationRules Users V2", "tags": [ "Users V2" ], "x-display-name": "List", "x-docs-display-name": "List", "x-docs-group-name": "Notification Rules V2", "x-docs-resource-type": "OnCallNotificationRulePublicV2" } }, "/v2/users/{user_id}/paging_provider": { "get": { "description": "Show the paging provider that would be used to escalate to this user. Reflects their explicit preference if set; otherwise resolves to the effective fallback (typically `native` for on-call seat users, or a linked external provider otherwise). May be omitted only when the user cannot be escalated to at all (no seat and no linked external user).", "operationId": "Users V2#ShowPagingProvider", "parameters": [ { "description": "The ID of the user.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "user_id", "required": true, "schema": { "description": "The ID of the user.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "preferred_escalation_provider": "native" }, "schema": { "$ref": "#/components/schemas/UsersShowPagingProviderResultV2" } } }, "description": "OK response." } }, "summary": "ShowPagingProvider Users V2", "tags": [ "Users V2" ], "x-docs-group-name": "Users V2" }, "post": { "description": "Update a user's preferred paging provider.", "operationId": "Users V2#UpdatePagingProvider", "parameters": [ { "description": "The ID of the user to update.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "user_id", "required": true, "schema": { "description": "The ID of the user to update.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "preferred_escalation_provider": "native" }, "schema": { "$ref": "#/components/schemas/UsersUpdatePagingProviderPayloadV2" } } }, "required": true }, "responses": { "204": { "description": "No Content response." } }, "summary": "UpdatePagingProvider Users V2", "tags": [ "Users V2" ], "x-docs-group-name": "Users V2" } }, "/v2/workflows": { "get": { "description": "List all workflows", "operationId": "Workflows V2#ListWorkflows", "responses": { "200": { "content": { "application/json": { "example": { "workflows": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "folder": "My folder 01", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -\u003e Affected Team", "type": "IncidentSeverity" } ], "runs_from": "2021-08-17T13:28:57.801578Z", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "label": "PagerDuty Escalate", "name": "pagerduty.escalate" } ], "trigger": { "label": "Incident Updated", "name": "incident.updated" }, "version": 3 } ] }, "schema": { "$ref": "#/components/schemas/WorkflowsListWorkflowsResultV2" } } }, "description": "OK response." } }, "summary": "ListWorkflows Workflows V2", "tags": [ "Workflows V2" ], "x-display-name": "List", "x-docs-display-name": "List", "x-docs-group-name": "Workflows V2", "x-docs-resource-type": "WorkflowV2" }, "post": { "description": "Create a new workflow", "operationId": "Workflows V2#CreateWorkflow", "requestBody": { "content": { "application/json": { "example": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "folder": "My folder 01", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ "incident.url" ], "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "for_each": "abc123", "id": "abc123", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ] } ], "trigger": "incident.updated" }, "schema": { "$ref": "#/components/schemas/WorkflowsCreateWorkflowPayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "management_meta": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "managed_by": "dashboard", "source_url": "https://github.com/my-company/infrastructure" }, "workflow": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "folder": "My folder 01", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -\u003e Affected Team", "type": "IncidentSeverity" } ], "runs_from": "2021-08-17T13:28:57.801578Z", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "for_each": "abc123", "id": "abc123", "label": "PagerDuty Escalate", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ] } ], "trigger": { "label": "Incident Updated", "name": "incident.updated" }, "version": 3 } }, "schema": { "$ref": "#/components/schemas/WorkflowsCreateWorkflowResultV2" } } }, "description": "Created response." } }, "summary": "CreateWorkflow Workflows V2", "tags": [ "Workflows V2" ], "x-display-name": "Create", "x-docs-display-name": "Create", "x-docs-group-name": "Workflows V2", "x-docs-resource-type": "WorkflowV2" } }, "/v2/workflows/{id}": { "delete": { "description": "Archives a workflow", "operationId": "Workflows V2#DestroyWorkflow", "parameters": [ { "description": "Unique identifier for the workflow", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the workflow", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." } }, "summary": "DestroyWorkflow Workflows V2", "tags": [ "Workflows V2" ], "x-display-name": "Destroy", "x-docs-display-name": "Delete", "x-docs-group-name": "Workflows V2", "x-docs-resource-type": "WorkflowV2" }, "get": { "description": "Show a workflow by ID", "operationId": "Workflows V2#ShowWorkflow", "parameters": [ { "allowEmptyValue": true, "description": "Skips workflow step upgrades, when the parameters for an existing workflow step change", "example": false, "in": "query", "name": "skip_step_upgrades", "schema": { "description": "Skips workflow step upgrades, when the parameters for an existing workflow step change", "example": false, "type": "boolean" } }, { "description": "Unique identifier for the workflow", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the workflow", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "management_meta": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "managed_by": "dashboard", "source_url": "https://github.com/my-company/infrastructure" }, "workflow": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "folder": "My folder 01", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -\u003e Affected Team", "type": "IncidentSeverity" } ], "runs_from": "2021-08-17T13:28:57.801578Z", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "for_each": "abc123", "id": "abc123", "label": "PagerDuty Escalate", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ] } ], "trigger": { "label": "Incident Updated", "name": "incident.updated" }, "version": 3 } }, "schema": { "$ref": "#/components/schemas/WorkflowsShowWorkflowResultV2" } } }, "description": "OK response." } }, "summary": "ShowWorkflow Workflows V2", "tags": [ "Workflows V2" ], "x-display-name": "Show", "x-docs-display-name": "Show", "x-docs-group-name": "Workflows V2", "x-docs-resource-type": "WorkflowV2" }, "put": { "description": "Updates a workflow", "operationId": "Workflows V2#UpdateWorkflow", "parameters": [ { "description": "ID of the workflow to update", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "path", "name": "id", "required": true, "schema": { "description": "ID of the workflow to update", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "folder": "My folder 01", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ "incident.url" ], "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "skip_step_upgrades": false, "state": "active", "steps": [ { "for_each": "abc123", "id": "abc123", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ] } ] }, "schema": { "$ref": "#/components/schemas/WorkflowsUpdateWorkflowPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "management_meta": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "managed_by": "dashboard", "source_url": "https://github.com/my-company/infrastructure" }, "workflow": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "folder": "My folder 01", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -\u003e Affected Team", "type": "IncidentSeverity" } ], "runs_from": "2021-08-17T13:28:57.801578Z", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "for_each": "abc123", "id": "abc123", "label": "PagerDuty Escalate", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ] } ], "trigger": { "label": "Incident Updated", "name": "incident.updated" }, "version": 3 } }, "schema": { "$ref": "#/components/schemas/WorkflowsUpdateWorkflowResultV2" } } }, "description": "OK response." } }, "summary": "UpdateWorkflow Workflows V2", "tags": [ "Workflows V2" ], "x-display-name": "Update", "x-docs-display-name": "Update", "x-docs-group-name": "Workflows V2", "x-docs-resource-type": "WorkflowV2" } }, "/v3/catalog_entries": { "get": { "description": "List entries for a catalog type.", "operationId": "Catalog V3#ListEntries", "parameters": [ { "allowEmptyValue": true, "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "catalog_type_id", "required": true, "schema": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "The integer number of records to return", "examples": { "default": { "summary": "default", "value": 25 } }, "in": "query", "name": "page_size", "required": true, "schema": { "default": 25, "description": "The integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "examples": { "default": { "summary": "default", "value": "01FDAG4SAP5TYPT98WGR2N7W91" } }, "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "allowEmptyValue": true, "description": "If specified, only entries with this identifier will be returned. This will search by ID, external ID, and aliases.\n\nIf 'use name as identifier' is enabled for the catalog type, this will also match on name.", "example": "abc123", "in": "query", "name": "identifier", "schema": { "description": "If specified, only entries with this identifier will be returned. This will search by ID, external ID, and aliases.\n\nIf 'use name as identifier' is enabled for the catalog type, this will also match on name.", "example": "abc123", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "catalog_entries": [ { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" } ], "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true }, "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 } }, "schema": { "$ref": "#/components/schemas/CatalogListEntriesResultV3" } } }, "description": "OK response." } }, "summary": "ListEntries Catalog V3", "tags": [ "Catalog V3" ], "x-docs-display-name": "List Entries", "x-docs-group-name": "Catalog Entries V3", "x-docs-resource-type": "CatalogEntryV3" }, "post": { "description": "Create an entry within the catalog. We support a maximum of 50,000 entries per type.\n\nIf you call this API with a payload where the external_id and catalog_type_id match an existing entry, the existing entry will be updated.", "operationId": "Catalog V3#CreateEntry", "requestBody": { "content": { "application/json": { "example": { "aliases": [ "lawrence@incident.io", "lawrence" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "name": "Primary On-call", "rank": 3 }, "schema": { "$ref": "#/components/schemas/CatalogCreateEntryPayloadV3" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CatalogCreateEntryResultV3" } } }, "description": "Created response." } }, "summary": "CreateEntry Catalog V3", "tags": [ "Catalog V3" ], "x-docs-display-name": "Create Entry", "x-docs-group-name": "Catalog Entries V3", "x-docs-resource-type": "CatalogEntryV3" } }, "/v3/catalog_entries/actions/bulk_update": { "post": { "description": "Update multiple catalog entries in a single operation. You can update up to 250 entries at once. This operation is atomic - either all entries are updated successfully, or none are updated.", "operationId": "Catalog V3#BulkUpdateEntries", "requestBody": { "content": { "application/json": { "example": { "catalog_type_id": "01GW2G3V0S59R238FAHPDS1R66", "entries": [ { "aliases": [ "abc123" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "entry_id": "abc123", "external_id": "abc123", "name": "abc123", "rank": 1 }, { "aliases": [ "abc123" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "entry_id": "abc123", "external_id": "abc123", "name": "abc123", "rank": 1 } ], "update_attributes": [ "01GW2G3V0S59R238FAHPDS1R66", "01GW2G3V0S59R238FAHPDS1R67" ] }, "schema": { "$ref": "#/components/schemas/CatalogBulkUpdateEntriesPayloadV3" } } }, "required": true }, "responses": { "204": { "description": "No Content response." } }, "summary": "BulkUpdateEntries Catalog V3", "tags": [ "Catalog V3" ], "x-docs-display-name": "Bulk Update Entries", "x-docs-group-name": "Catalog Entries V3", "x-docs-resource-type": "CatalogEntryV3" } }, "/v3/catalog_entries/{id}": { "delete": { "description": "Archives a catalog entry.", "operationId": "Catalog V3#DestroyEntry", "parameters": [ { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." } }, "summary": "DestroyEntry Catalog V3", "tags": [ "Catalog V3" ], "x-docs-display-name": "Delete Entry", "x-docs-group-name": "Catalog Entries V3", "x-docs-resource-type": "CatalogEntryV3" }, "get": { "description": "Show a single catalog entry.", "operationId": "Catalog V3#ShowEntry", "parameters": [ { "allowEmptyValue": true, "description": "Whether to include details of all attribute links (forwards and backwards) within the response. Default behaviour (no query param) is to include only forward links. When expand is false, we only show attributes of the catalog entry itself.When expand is true, we show forward and backward links", "example": true, "in": "query", "name": "expand", "schema": { "description": "Whether to include details of all attribute links (forwards and backwards) within the response. Default behaviour (no query param) is to include only forward links. When expand is false, we only show attributes of the catalog entry itself.When expand is true, we show forward and backward links", "example": true, "type": "boolean" } }, { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" }, "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "schema": { "$ref": "#/components/schemas/CatalogShowEntryResultV3" } } }, "description": "OK response." } }, "summary": "ShowEntry Catalog V3", "tags": [ "Catalog V3" ], "x-docs-display-name": "Show Entry", "x-docs-group-name": "Catalog Entries V3", "x-docs-resource-type": "CatalogEntryV3" }, "put": { "description": "Updates an existing catalog entry.", "operationId": "Catalog V3#UpdateEntry", "parameters": [ { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "aliases": [ "lawrence@incident.io", "lawrence" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "name": "Primary On-call", "rank": 3, "update_attributes": [ "abc123" ] }, "schema": { "$ref": "#/components/schemas/CatalogUpdateEntryPayloadV3" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" }, "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "schema": { "$ref": "#/components/schemas/CatalogUpdateEntryResultV3" } } }, "description": "OK response." } }, "summary": "UpdateEntry Catalog V3", "tags": [ "Catalog V3" ], "x-docs-display-name": "Update Entry", "x-docs-group-name": "Catalog Entries V3", "x-docs-resource-type": "CatalogEntryV3" } }, "/v3/catalog_resources": { "get": { "description": "List available engine resources for the catalog.\n\nA resource represents a type of data that can be held within the catalog, so this\nendpoint can be used to see what attribute types can be used when updating the\nschema of a catalog type.\n", "operationId": "Catalog V3#ListResources", "responses": { "200": { "content": { "application/json": { "example": { "resources": [ { "category": "custom", "description": "Boolean true or false value", "label": "GitHub Repository", "type": "CatalogEntry[\"01GVGYJSD39FRKVDWACK9NDS4E\"]", "value_docstring": "Either the GraphQL node ID of the repository or a string of \u003cowner\u003e/\u003crepo\u003e, e.g. incident-io/website" } ] }, "schema": { "$ref": "#/components/schemas/CatalogListResourcesResultV3" } } }, "description": "OK response." } }, "summary": "ListResources Catalog V3", "tags": [ "Catalog V3" ], "x-docs-display-name": "List Resources", "x-docs-group-name": "Catalog Resources V3", "x-docs-resource-type": "CatalogResourceV3" } }, "/v3/catalog_types": { "get": { "description": "List all catalog types for an organisation, including those synced from external resources.", "operationId": "Catalog V3#ListTypes", "responses": { "200": { "content": { "application/json": { "example": { "catalog_types": [ { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } ] }, "schema": { "$ref": "#/components/schemas/CatalogListTypesResultV3" } } }, "description": "OK response." } }, "summary": "ListTypes Catalog V3", "tags": [ "Catalog V3" ], "x-docs-display-name": "List Types", "x-docs-group-name": "Catalog Types V3", "x-docs-resource-type": "CatalogTypeV3" }, "post": { "description": "Create a catalog type. The schema must be updated using the UpdateTypeSchema endpoint.", "operationId": "Catalog V3#CreateType", "requestBody": { "content": { "application/json": { "example": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "description": "Represents Kubernetes clusters that we run inside of GKE.", "icon": "alert", "name": "Kubernetes Cluster", "ranked": true, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "use_name_as_identifier": true }, "schema": { "$ref": "#/components/schemas/CatalogCreateTypePayloadV3" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "schema": { "$ref": "#/components/schemas/CatalogCreateTypeResultV3" } } }, "description": "Created response." } }, "summary": "CreateType Catalog V3", "tags": [ "Catalog V3" ], "x-docs-display-name": "Create Type", "x-docs-group-name": "Catalog Types V3", "x-docs-resource-type": "CatalogTypeV3" } }, "/v3/catalog_types/{id}": { "delete": { "description": "Archives a catalog type and associated entries.", "operationId": "Catalog V3#DestroyType", "parameters": [ { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." } }, "summary": "DestroyType Catalog V3", "tags": [ "Catalog V3" ], "x-docs-display-name": "Delete Type", "x-docs-group-name": "Catalog Types V3", "x-docs-resource-type": "CatalogTypeV3" }, "get": { "description": "Show a single catalog type.", "operationId": "Catalog V3#ShowType", "parameters": [ { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "schema": { "$ref": "#/components/schemas/CatalogShowTypeResultV3" } } }, "description": "OK response." } }, "summary": "ShowType Catalog V3", "tags": [ "Catalog V3" ], "x-docs-display-name": "Show Type", "x-docs-group-name": "Catalog Types V3", "x-docs-resource-type": "CatalogTypeV3" }, "put": { "description": "Updates an existing catalog type. The schema must be updated using the UpdateTypeSchema endpoint.", "operationId": "Catalog V3#UpdateType", "parameters": [ { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "description": "Represents Kubernetes clusters that we run inside of GKE.", "icon": "alert", "name": "Kubernetes Cluster", "ranked": true, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "use_name_as_identifier": true }, "schema": { "$ref": "#/components/schemas/CatalogUpdateTypePayloadV3" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "schema": { "$ref": "#/components/schemas/CatalogUpdateTypeResultV3" } } }, "description": "OK response." } }, "summary": "UpdateType Catalog V3", "tags": [ "Catalog V3" ], "x-docs-display-name": "Update Type", "x-docs-group-name": "Catalog Types V3", "x-docs-resource-type": "CatalogTypeV3" } }, "/v3/catalog_types/{id}/actions/update_schema": { "post": { "description": "Update an existing catalog types schema, adding or removing attributes.\n\nUpdating the schema is handled separately from creating and updating types, so that you don't\nhave to worry about dependencies between types. For example, if type A has an attribute that\nrelies on type B, you would have to create type B first.\n\nBy allowing the creation of types without a schema, they can be created in any order, but it\nmeans that you need to make a separate call to this endpoint to update the schema.", "operationId": "Catalog V3#UpdateTypeSchema", "parameters": [ { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/CatalogUpdateTypeSchemaPayloadV3" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "schema": { "$ref": "#/components/schemas/CatalogUpdateTypeSchemaResultV3" } } }, "description": "OK response." } }, "summary": "UpdateTypeSchema Catalog V3", "tags": [ "Catalog V3" ], "x-docs-display-name": "Update Type Schema", "x-docs-group-name": "Catalog Types V3", "x-docs-resource-type": "CatalogTypeV3" } }, "/v3/teams": { "get": { "description": "List all teams in the organisation.", "operationId": "Teams V3#List", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "teams": [ { "catalog_entry": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "id": "abc123", "members": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "slack_user_id": "U02AYNF2XJM" } ], "name": "abc123" } ] }, "schema": { "$ref": "#/components/schemas/TeamsListResultV3" } } }, "description": "OK response." } }, "summary": "List Teams V3", "tags": [ "Teams V3" ], "x-docs-display-name": "List", "x-docs-group-name": "Teams V3", "x-docs-resource-type": "TeamV3" } }, "/v3/teams/{id}": { "get": { "description": "Get a single team.", "operationId": "Teams V3#Show", "parameters": [ { "description": "Unique ID of the team", "example": "abc123", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique ID of the team", "example": "abc123", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "team": { "catalog_entry": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "id": "abc123", "members": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "slack_user_id": "U02AYNF2XJM" } ], "name": "abc123" } }, "schema": { "$ref": "#/components/schemas/TeamsShowResultV3" } } }, "description": "OK response." } }, "summary": "Show Teams V3", "tags": [ "Teams V3" ], "x-docs-display-name": "Show", "x-docs-group-name": "Teams V3", "x-docs-resource-type": "TeamV3" } } }, "servers": [ { "url": "https://api.incident.io" } ], "tags": [ { "description": "Manage API keys for your organization.\n\nThis API lets you view, create, update, delete, and rotate API keys programmatically, including configuring account-level roles and roles scoped to specific teams.\n\nCommon use cases include:\n- **API key rotation**: You can issue a new access token for any API key using the `Rotate` endpoint.\n- **Managing keys at scale**: use the `Show`, `List`, `Create`, `Update`, and `Delete` endpoints to automate API key lifecycle management.\n\n## Permissions model\n\nTo use these endpoints, your API key must have the `api_keys_manage` role granted at either the account level or for specific teams.\n\nIn addition, the following rules apply, when a \"caller\" API key is managing a \"target\" API key:\n\n- A caller key can only assign roles whose scopes are a subset of its own scopes. For example, a key with `viewer` and `incident_creator` can assign those roles to a target key, but cannot assign the `incident_editor` role, since it has additional scopes.\n- The same applies at the team level: A caller key with `schedules_editor` at the account level can create a target key with that role for a specific team, but a key with `schedules_editor` only for one team (Team A, say) cannot assign it at the account level or for another team, Team B.\n- The `api_keys_manage` role cannot be assigned via the API. To create a key with that role, you must go to Settings → API keys in the dashboard, and click \"Add new\", creating a key with the \"View, create, edit, delete or rotate API keys\" role (`api_keys_manage`).\n- The `Delete` endpoint does not check whether the calling API key holds the scopes of the key being deleted. However, a team-scoped key can only delete keys belonging to its teams.\n- To rotate the token of an API key, use the Rotate endpoint or by clicking \"Rotate token\" on any API key listed in the dashboard. The same permissions limitations apply as when creating or updating an API key.\n\n## Finding role names and team IDs\n\nTo find valid values for `role_names`, `team_ids`, and `team_role_names`, go to Settings → API keys in the dashboard. Click to either edit an existing key or create a new one, select the desired roles and teams, and then use the copy button to get hold of the role and team identifiers as JSON.", "name": "API Keys V1" }, { "description": "Manage incident actions.\n\nThese endpoints have been deprecated in favour of Actions V2 and Follow-ups V2, as these\nconcepts have become increasingly separate.\n\nIncidents have two types of actions associated to them:\n\n- Actions, used during an incident response as ephemeral todo lists\n- Follow-ups, actions which are for after the incident and can be exported to external\n\tissue trackers\n\nYou can manage actions in the incident Slack channel with \u003ccode\u003e/incident actions\u003c/code\u003e, or on\nthe incident homepage.\n\nExporting follow-ups to external issue trackers can be done in the incident homepage.\n", "name": "Actions V1" }, { "description": "Manage incident actions.\n\nIncident actions are used during an incident, to track work such as 'restart the database' or 'contact the customer'.\n\nYou can manage actions in the incident Slack channel with \u003ccode\u003e/incident actions\u003c/code\u003e, or on\nthe incident homepage.\n", "name": "Actions V2" }, { "description": "View and manage alert attributes.\n\nAlert attributes are used to parse structured data from alerts coming in via alert sources.", "name": "Alert Attributes V2" }, { "description": "Create alerts within incident.io.\n\nThe alerts API allows you to create alerts within incident.io by posting alert events. You\ncan use alerts to automatically trigger incidents.\n\nTo create an alert, you must first configure an alert source in the incident.io dashboard.\n", "name": "Alert Events V2" }, { "description": "Configure your alert routes in incident.io.\n\nAlert routes define how alerts from different sources are processed, grouped, and routed to the right teams and people.", "name": "Alert Routes V2" }, { "description": "Configure your alert sources in incident.io.\n\nAlert sources are the systems that send alerts to incident.io, which can then be routed to the right people and teams.", "name": "Alert Sources V2" }, { "description": "Read your alerts in incident.io.\n\nAlerts are events ingested from third parties by alert sources. They can trigger incidents and escalations, as configured in alert routes.\nTo view your alerts, you can list all alerts, or show a single alert. \nIf you'd like to view only alerts that are currently firing, you can filter by status. \nTo view the alert that was created for an event in your external system, filter by deduplication key. \n\nIf you'd like to view alerts connected to a particular incident, you can list incident alerts. You can filter by incident_id to find all alerts attached to a particular incident, or by alert_id to find the incident that a particular alert triggered. \n", "name": "Alerts V2" }, { "description": "Manage and browse catalog resources.\n\nThese endpoints have been deprecated in favour of CatalogV3. The only breaking change is\nthat the 'manual' attribute mode is now split into 'api' and 'dashboard'. We also removed\nthe usage of some types that were deprecated in the V2 API. \n\nUse the incident.io catalog to track services, teams, product features and anything\nelse that helps build a map of your organisation. These different categories of thing\nbecome catalog types, and each instance (like a particular service or team) is a\ncatalog entry.\n\nEach type is made up of a series of attributes, and each attribute has a type. Types\ncan even have attributes that refer to other catalog types.\n\nWe automatically create catalog types when you connect an integration, such as GitHub\nrepositories or PagerDuty services and teams. You can use this API to create custom\ntypes, that are specifically tailored to your organisation.\n\nExamples might be a 'Service' type with an 'Alert channel' which you can point at a\nSlack channel, or 'Team' which specifies its 'Manager' and 'Technical Lead' as Slack\nusers. You can then use these types to create powerful new workflows.\n\nConsider using our official [catalog importer](https://github.com/incident-io/catalog-importer).\nIt can be used to sync catalog data from sources like local files or GitHub and push\nthem into the incident.io catalog without having to directly interact with our public API.\n", "name": "Catalog V2" }, { "description": "Manage and browse catalog resources.\n\nUse the incident.io catalog to track services, teams, product features and anything\nelse that helps build a map of your organisation. These different categories of thing\nbecome catalog types, and each instance (like a particular service or team) is a\ncatalog entry.\n\nEach type is made up of a series of attributes, and each attribute has a type. Types\ncan even have attributes that refer to other catalog types.\n\nWe automatically create catalog types when you connect an integration, such as GitHub\nrepositories or PagerDuty services and teams. You can use this API to create custom\ntypes, that are specifically tailored to your organisation.\n\nExamples might be a 'Service' type with an 'Alert channel' which you can point at a\nSlack channel, or 'Team' which specifies its 'Manager' and 'Technical Lead' as Slack\nusers. You can then use these types to create powerful new workflows.\n\nConsider using our official [catalog importer](https://github.com/incident-io/catalog-importer).\nIt can be used to sync catalog data from sources like local files or GitHub and push\nthem into the incident.io catalog without having to directly interact with our public API.\n", "name": "Catalog V3" }, { "description": "Manage custom field options.\n\nSingle- and multi-select custom fields have a list of all available options,\nwhich have a value, and a sort key. The value must be unique to the custom\nfield. For example, you might have an Incident Type custom field, with options\n\"Data breach\", \"Performance degradation\", \"API downtime\", etc.", "name": "Custom Field Options V1" }, { "description": "Manage custom fields.\n\nCustom fields are used to attach metadata to incidents, which you can use when searching\nfor incidents in the dashboard, triggering workflows, building announcement rules or for\nyour own data needs.\n\nEach field has a type:\n\n- Single-select, single value selected from a predefined list of options (e.g. Detection Method)\n- Multi-select, as above but you can pick more than one option (e.g. Affected Teams)\n- Text, freeform text field (e.g. Customer ID)\n- Link, link URL that is synced to Slack bookmarks on the incident channel (e.g. External Status Page)\n- Number, integer or fractional numbers (e.g. # Customers Affected)\n\nWe may add more custom field types in the future - we'd love to hear any other types you'd like to use!\n", "name": "Custom Fields V1" }, { "description": "Manage custom fields.\n\nCustom fields are used to attach metadata to incidents, which you can use when searching\nfor incidents in the dashboard, triggering workflows, building announcement rules or for\nyour own data needs.\n\nEach field has a type:\n\n- Single-select, single value selected from a predefined list of options (e.g. Detection Method)\n- Multi-select, as above but you can pick more than one option (e.g. Affected Teams)\n- Text, freeform text field (e.g. Customer ID)\n- Link, link URL that is synced to Slack bookmarks on the incident channel (e.g. External Status Page)\n- Number, integer or fractional numbers (e.g. # Customers Affected)\n\nWe may add more custom field types in the future - we'd love to hear any other types you'd like to use!\n", "name": "Custom Fields V2" }, { "description": "Create and manage escalation paths, and create, list and filter escalations.\n\nWith incident.io On-call you can create escalation paths that describe how a page should\nbe escalated to people and schedules.\n", "name": "Escalations V2" }, { "description": "Manage incident follow-ups.\n\nIncidents can have follow-ups associated with them, which track work that should be done\nafter an incident (e.g. improving some documentation, or upgrading a dependency). They can\nalso be exported to external issue trackers.\n\nYou can manage follow-ups in the incident Slack channel with \u003ccode\u003e/incident follow-ups\u003c/code\u003e, or on\nthe incident homepage.\n", "name": "Follow-ups V2" }, { "description": "Send heartbeat pings for dead man's switch monitoring.\n\nHeartbeat alert sources expect periodic pings. If pings stop arriving, alerts\nfire automatically. Use the ping endpoints to signal that your job or service\nis still healthy.\n", "name": "Heartbeat V2" }, { "description": "Manage the IP allowlist.\n\nWhen enabled, the IP allowlist restricts authenticated traffic from the dashboard, public API and mobile app.", "name": "IPAllowlists V1" }, { "description": "Create, list and delete incident attachments.\n\nIncident Attachments allows you to connect resources from external systems into incidents.\nExamples include: PagerDuty incidents and GitHub pull requests.\n", "name": "Incident Attachments V1" }, { "description": "Manage private incident memberships", "name": "Incident Memberships V1" }, { "description": "View related incidents for an incident", "name": "Incident Relationships V1" }, { "description": "Manage incident roles.\n\nDuring an incident, you can assign responders to one of the incident roles that are\nconfigured in your organisation settings.\n\nEvery organisation will have a special 'lead' role, which signifies the incident lead or\ncommander. This role cannot be deleted, but can be renamed in the incident.io dashboard.\n", "name": "Incident Roles V1" }, { "description": "Manage incident roles.\n\nDuring an incident, you can assign responders to one of the incident roles that are\nconfigured in your organisation settings.\n\nEvery organisation will have a special 'lead' role, which signifies the incident lead or\ncommander. This role cannot be deleted, but can be renamed in the incident.io dashboard.\n", "name": "Incident Roles V2" }, { "description": "Manage incident statuses.\n\nEach incident has a status, picked from one of the statuses configured in your\norganisations settings.\n\nStatuses help communicate where an incident is in its lifecycle. You can use\nstatuses when filtering incidents in the dashboard, and in workflows and announcement\nrules.\n", "name": "Incident Statuses V1" }, { "description": "View incident timestamps.\n\nEach incident has a number of timestamps; some being defaults that we set on\neach incident for you, and other being configured for your organisation within\nsettings.\n\nTimestamps help to communicate when a given action was taken for a specific\nincident, for example when it was reported, closed or fixed.\n", "name": "Incident Timestamps V2" }, { "description": "View incident types.\n\nWith incident types enabled, you can tailor your process to the situation you're\nresponding to with different custom fields and roles for each incident type.\n", "name": "Incident Types V1" }, { "description": "List incident updates.\n\nIncident Updates allows you to see all the updates that have been shared against a\nparticular incident. This will include any time that the Severity or Status of\nan incident changed, alongside any additional updates that were provided.\n", "name": "Incident Updates V2" }, { "description": "Create and read incidents.\n\nIncidents are a core resource, on which many other resources (actions, etc) are created.\n\nCare should be taken around these endpoints, as automation that creates duplicate\nincidents can be distracting, and impact reporting.\n\nThe maximum page size that can be requested is 250.\n", "name": "Incidents V1" }, { "description": "Create and read incidents.\n\nIncidents are a core resource, on which many other resources (actions, etc) are created.\n\nCare should be taken around these endpoints, as automation that creates duplicate\nincidents can be distracting, and impact reporting.\n", "name": "Incidents V2" }, { "description": "Manage maintenance windows for temporarily overriding alert routing during planned maintenance.\n\nMaintenance windows allow you to suppress or redirect alerts during scheduled maintenance periods, preventing unnecessary escalations and noise.", "name": "MaintenanceWindows V1" }, { "description": "Manage post-mortem documents.\n\nPost-mortem documents capture the learnings from an incident, and are associated with a specific\nincident. Use this API to list and retrieve post-mortem documents, update their status, and fetch\nthe full document's content.\n", "name": "PostmortemDocuments V1" }, { "description": "View and manage schedules.\nManage your full schedule of on-call rotations, including the users and rotation configuration.\n", "name": "Schedules V2" }, { "description": "Manage incident severities.\n\nEach incident has a severity, picked from one of the severities configured in your\norganisations settings.\n\nSeverities help categorise incidents, and communicate urgency/impact. You can use\nseverities when filtering incidents in the dashboard, and in workflows and announcement\nrules.\n", "name": "Severities V1" }, { "description": "This API currently only allows linked Response incidents for a status page incident to be listed.", "name": "Status Pages V1" }, { "description": "Manage and publish to status pages.\n\nBefore using these endpoints, you must create a status page in the incident.io dashboard (find Status Pages in the left navigation bar). You can then use the ListStatusPages endpoint to find your status page IDs, and the ShowStatusPageStructure endpoint to find component IDs and group IDs for your status page.\n\nFor read-only access (listing status pages, viewing structure, incidents, and maintenance windows), any valid API key will work. For write requests (creating incidents, maintenance windows, and publishing updates), you will need an API key with the \"Create status page incidents, status page maintenance windows, and publish status page updates\" scope.\n", "name": "Status Pages V2" }, { "description": "Manage teams.\n\nTeams are groups of users that can be associated with incidents, escalation paths, and other\nresources. Teams are built on top of catalog entries, allowing you to enrich them with\ncustom attributes.\n", "name": "Teams V3" }, { "description": "Manage telemetry data source integrations.", "name": "Telemetry V2" }, { "description": "View users.\n\nUsers all have a single base role, and can be assigned multiple custom roles. They can be managed via your Slack workspace or SAML provider.\n", "name": "Users V2" }, { "description": "Miscelaneous utility endpoints.\n\nCollection of utility functions that can help build integrations against this API.\n", "name": "Utilities V1" }, { "description": "Manage workflows.\n\nWorkflows allow you to automate certain actions and behaviors based on specific triggers.", "name": "Workflows V2" }, { "description": "Webhooks can be used to receive notifications when certain events occur in incident.io. This might be useful for annotating graphs in a monitoring tool with incidents, or keeping track of follow-ups in another system. Our webhooks are powered by \u003ca href=\"https://svix.com\" target=\"_blank\"\u003eSvix\u003c/a\u003e.\n\n## Getting started with webhooks\n\nTo start using webhooks, you’ll need to create a webhook endpoint. You can do this in the same way that you’d create any other endpoint in your application. If you’d like to play around with our webhooks, we’d recommend using \u003ca href=\"https://www.svix.com/play/\" target=\"_blank\"\u003eSvix play\u003c/a\u003e which allows you to set up an endpoint and inspect the payloads via their web interface. There are also other services (e.g. \u003ca href=\"https://ngrok.com/\" target=\"_blank\"\u003engrok\u003c/a\u003e) which have great debugging tools to help getting started with webhooks.\n\nOnce you have a webhook endpoint set up, you can head to \u003ca href=\"https://app.incident.io/settings/webhooks\" target=\"_blank\"\u003eSettings \u003e Webhooks\u003c/a\u003e to configure your endpoint. In here you'll be able to choose which types of events you'd like to recieve, send test events, see recent event deliveries, and retry any failed events.\n\n## Status codes, errors and retries\n\nWhen processing webhooks, please return a 2xx status code (e.g. `200 OK` or `204 No Content`). If the endpoint returns a non-2xx status code, we’ll try to resend the event with a backoff over the next 24 hours. If attempts to a specific endpoint repeatedly fail over a 5 day period, we’ll mark the endpoint as disabled and notify you via email. If you do miss some messages (e.g. due to unexpected downtime), Svix offer a number of options for [replaying messages](https://docs.svix.com/receiving/using-app-portal/replaying-messages) which you can access via \u003ca href=\"https://app.incident.io/settings/webhooks\" target=\"_blank\"\u003eSettings \u003e Webhooks\u003c/a\u003e.\n\n## Verifying webhooks\n\nIt’s important to know whether a webhook has come from incident.io, or a third party that might be trying to exploit a vulnerability. To avoid this, we send a `signature` in the header of our webhooks, which you can verify using the `Signing secret` from the webhook endpoint settings page. The webhooks we send will have three headers that you’ll want to look at:\n\n```json\n{\n \"webhook-id\": \"123\",\n \"webhook-timestamp\": 1676033031,\n \"webhook-signature\": \"v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE=\"\n}\n```\n\nThese are signed using a HMAC signature in the following format:\n\n```\n$WEBHOOK_ID.$WEBHOOK_TIMESTAMP.$REQUEST_BODY\n```\n\nYou can verify the signature either using the \u003ca href=\"https://docs.svix.com/receiving/verifying-payloads/how\" target=\"_blank\"\u003eSvix client libraries\u003c/a\u003e, or manually by following \u003ca href=\"https://docs.svix.com/receiving/verifying-payloads/how-manual\" target=\"_blank\"\u003ethese instructions\u003c/a\u003e.\n\n## Keeping another system in-line with incident.io\n\nA common use-case for webhooks is to keep another system up-to-date with everything that’s happening in incident.io. As we deliver webhooks individually over HTTPS, we cannot guarantee that they’ll be delivered in the correct order. That means that, to keep the other system up-to-date, we’d recommend that you build an application which:\n\n- Receives a webhook about INC-123\n- Makes a request to our public API to get the latest state of INC-123\n- Save that state to your system\n\nThis means you aren’t relying on the order in which you receive webhooks to make sure your system remains up-to-date.\n\n## Webhooks on private incidents\n\nIn general, we try to send webhooks with all the relevant information in the payload (e.g. the name, summary, status etc.). However, private incidents are the exception. For private incidents, we only send the ID of the resource that’s been changed. If your integration needs to access the full data, you’ll need to \u003ca href=\"https://docs.incident.io/integrations/api-overview\" target=\"_blank\"\u003ecreate an API Key\u003c/a\u003e that can view private incidents. You can then use that key to get the details about the specific incident or follow-up. This is to make sure we don’t leak information about private incidents to a system that shouldn’t have access to them.\n", "name": "Webhooks" }, { "description": "To give you visibility over the changes that are made within your incident.io account, we use an audit log. Our audit log is powered by \u003ca href=\"https://workos.com\" target=\"_blank\"\u003eWorkOS\u003c/a\u003e. The log is available for customers on our [Enterprise plan](https://incident.io/pricing).\n\nThe audit log contains information about any configuration changes, as well as changes to a user's permissions (e.g. being given a new role, or access to a private incident).\n\nEach entry will have an actor (the person or system that made the change) and one or more targets (a thing that was modified by this change). It will also include the Location and User Agent of the actor, where applicable.\n\nEach entry will conform to a schema, which is documented here. Each entry also has a version, so that if our schema changes over time you’ll still be able to parse old events.\n\nWe’ll retain these entries for one year.\n\nAudit log entries start from 18 April, 2023 (there are no entries available from before that date) and are retained in WorkOS for 365 days.\n\n## Viewing your audit log\n\nYou can view your audit log via our [security settings](https://app.incident.io/settings/security) page.\n\nFrom there, you'll be able to:\n\n- View the entries via a web interface (filterable by target, event type, actor and date)\n- Export the entries for a given time period to a CSV\n- Set up a log stream to a provider of your choice (e.g. Splunk or an Amazon S3 bucket)\n\n## Understanding actors\n\nEach entry will have an actor associated with it, which is one of 6 types:\n\n### Users\n\nThis is for changes triggered by the actions of a particular user in your account.\n\nAs an example:\n\n```\n\"actor\": {\n \"type\": \"user\",\n \"id\": \"01G0J1EXE7AXZ2C93K61WBPYEH\",\n \"name\": \"Kelsey Mills\",\n \"metadata\": {\n \"user_base_role_slug\": \"admin\",\n \"user_custom_role_slugs\": \"engineering,security\"\n }\n }\n```\n\n### API Keys\n\nThis is for changes triggered by an API key.\n\nAs an example:\n\n```\n\"actor\": {\n \"type\": \"api_key\",\n \"id\": \"01G0J1EXE7AXZ2C93K61WBPYEH\",\n \"name\": \"Lisa's development key\",\n \"metadata\": {\n \"api_key_roles\": \"incident_creator,global_access\"\n }\n }\n```\n\n### Integrations\n\nThis is for changes triggered by a system. Sometimes that will be a third party system (e.g. a user might be created\nvia Slack) or sometimes it might be something triggered from inside incident.io (e.g. a severity created as part of setup).\n\nAs an example:\n\n```\n\"actor\": {\n \"type\": \"system\",\n \"id\": \"incident_setup\",\n \"name\": \"incident.io (setup)\",\n \"metadata\": {}\n }\n```\n\n### Workflows\n\nThis is for changes triggered by a workflow: for example, a workflow that invites users to a private incident.\n\nAs an example:\n\n```\n\"actor\": {\n \"type\": \"workflow\",\n \"id\": \"01G0J1EXE7AXZ2C93K61WBPYEH\",\n \"name\": \"Auto-invite security team to private incidents\",\n \"metadata\": {}\n }\n```\n\n### External resources\n\nThis is for changes triggered by a specific [external resource](https://api-docs.incident.io/tag/Incident-Attachments-V1) (also known as an attachment).\n\nAs an example:\n\n```\n\"actor\": {\n \"type\": \"external_resource\",\n \"id\": \"01G0J1EXE7AXZ2C93K61WBPYEH\",\n \"name\": \"#1234 Increased API latency\",\n \"metadata\": {\n \"external_resource_type\": \"pager_duty_incident\",\n \"external_resource_external_id\": \"q1234\"\n }\n }\n```\n\n### Alerts\n\nThis is for changes triggered by a specific alert (e.g. from Datadog or Grafana).\n\nAs an example:\n\n```\n\"actor\": {\n \"type\": \"alert\",\n \"id\": \"01G0J1EXE7AXZ2C93K61WBPYEH\",\n \"name\": \"Staging: pod CPU high\",\n \"metadata\": {\n \"alert_source_id\": \"01HB0ZG3B0HM04RCXNSPV1EDYG\"\n }\n }\n```\n", "name": "Audit logs" } ], "x-webhooks": { "/x-audit-logs/activity_log.scrubbed.1": { "get": { "description": "This entry is created whenever an activity log entry is permanently erased", "operationId": "ActivityLogScrubbedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "activity_log.scrubbed", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Activity log entry (01FCNDV6P870EA6S7TK1DSYDG0)", "type": "activity_log" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsActivityLogScrubbedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/alert.scrubbed.1": { "get": { "description": "This entry is created whenever sensitive data is permanently erased from an alert, its events, and linked escalations.", "operationId": "AlertScrubbedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "alert.scrubbed", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Alert (01KB0083ASNF7EPT8NHQNRDXFC)", "type": "alert" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsAlertScrubbedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/alert_chat_message_template.created.1": { "get": { "description": "This entry is created whenever an alert chat message template is created", "operationId": "AlertChatMessageTemplateCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "alert_chat_message_template.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Standard", "type": "alert_chat_message_template" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsAlertChatMessageTemplateCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/alert_chat_message_template.deleted.1": { "get": { "description": "This entry is created whenever an alert chat message template is deleted", "operationId": "AlertChatMessageTemplateDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "alert_chat_message_template.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Standard", "type": "alert_chat_message_template" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsAlertChatMessageTemplateDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/alert_chat_message_template.updated.1": { "get": { "description": "This entry is created whenever an alert chat message template is updated", "operationId": "AlertChatMessageTemplateUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "alert_chat_message_template.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Standard", "type": "alert_chat_message_template" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsAlertChatMessageTemplateUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/alert_priority.created.1": { "get": { "description": "This entry is created whenever an alert priority is created", "operationId": "AlertPriorityCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "alert_priority.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Urgent", "type": "alert_priority" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsAlertPriorityCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/alert_priority.deleted.1": { "get": { "description": "This entry is created whenever an alert priority is deleted", "operationId": "AlertPriorityDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "alert_priority.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Urgent", "type": "alert_priority" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsAlertPriorityDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/alert_priority.set_as_default.1": { "get": { "description": "This entry is created whenever an alert priority is set as the default", "operationId": "AlertPrioritySetAsDefaultV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "alert_priority.set_as_default", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Urgent", "type": "alert_priority" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsAlertPrioritySetAsDefaultV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/alert_priority.updated.1": { "get": { "description": "This entry is created whenever an alert priority is updated", "operationId": "AlertPriorityUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "alert_priority.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Urgent", "type": "alert_priority" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsAlertPriorityUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/alert_route.created.1": { "get": { "description": "This entry is created whenever an alert route is created", "operationId": "AlertRouteCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "alert_route.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Production incidents", "type": "alert_route" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsAlertRouteCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/alert_route.deleted.1": { "get": { "description": "This entry is created whenever an alert route is deleted", "operationId": "AlertRouteDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "alert_route.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Production incidents", "type": "alert_route" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsAlertRouteDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/alert_route.updated.1": { "get": { "description": "This entry is created whenever an alert route is updated", "operationId": "AlertRouteUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "alert_route.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Production incidents", "type": "alert_route" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsAlertRouteUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/alert_schema.updated.1": { "get": { "description": "This entry is created whenever alert attributes are updated", "operationId": "AlertSchemaUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "alert_schema.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Alert schema", "type": "alert_schema" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsAlertSchemaUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/alert_source_config.created.1": { "get": { "description": "This entry is created whenever an alert source is created", "operationId": "AlertSourceConfigCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "alert_source_config.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Datadog alerts", "type": "alert_source" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsAlertSourceConfigCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/alert_source_config.deleted.1": { "get": { "description": "This entry is created whenever an alert source is deleted", "operationId": "AlertSourceConfigDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "alert_source_config.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Datadog alerts", "type": "alert_source" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsAlertSourceConfigDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/alert_source_config.updated.1": { "get": { "description": "This entry is created whenever an alert source is updated", "operationId": "AlertSourceConfigUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "alert_source_config.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Datadog alerts", "type": "alert_source" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsAlertSourceConfigUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/announcement_rule.created.1": { "get": { "description": "This entry is created whenever a announcement rule is created", "operationId": "AnnouncementRuleCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "announcement_rule.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#engineering", "type": "announcement_rule" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsAnnouncementRuleCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/announcement_rule.deleted.1": { "get": { "description": "This entry is created whenever a announcement rule is deleted", "operationId": "AnnouncementRuleDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "announcement_rule.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#engineering", "type": "announcement_rule" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsAnnouncementRuleDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/announcement_rule.updated.1": { "get": { "description": "This entry is created whenever a announcement rule is updated", "operationId": "AnnouncementRuleUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "announcement_rule.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#engineering", "type": "announcement_rule" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsAnnouncementRuleUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/api_key.created.1": { "get": { "description": "This entry is created whenever a api key is created", "operationId": "ApiKeyCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "api_key.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Development API Key", "type": "api_key" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsAPIKeyCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/api_key.deleted.1": { "get": { "description": "This entry is created whenever a api key is deleted", "operationId": "ApiKeyDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "api_key.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Development API Key", "type": "api_key" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsAPIKeyDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/api_key.rotated.1": { "get": { "description": "This entry is created whenever an api key is rotated", "operationId": "ApiKeyRotatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "api_key.rotated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Development API Key", "type": "api_key" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsAPIKeyRotatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/api_key.updated.1": { "get": { "description": "This entry is created whenever a api key is updated", "operationId": "ApiKeyUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "api_key.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Development API Key", "type": "api_key" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsAPIKeyUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/catalog_entry_attribute.updated.1": { "get": { "description": "This entry is created whenever a restricted catalog entry attribute is updated", "operationId": "CatalogEntryAttributeUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "catalog_entry_attribute.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "after_values": [ "01FCNDV6P870EA6S7TK1DSYDG0", "01FCNDV6P870EA6S7TK1DSYDG2" ], "before_values": [ "01FCNDV6P870EA6S7TK1DSYDG0", "01FCNDV6P870EA6S7TK1DSYDG1" ] }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Service", "type": "catalog_type" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Engineering Team", "type": "catalog_entry" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Members", "type": "catalog_attribute" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsCatalogEntryAttributeUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/catalog_entry_attribute.updated.2": { "get": { "description": "This entry is created whenever a restricted catalog entry attribute is updated", "operationId": "CatalogEntryAttributeUpdatedV2", "responses": { "200": { "content": { "application/json": { "example": { "action": "catalog_entry_attribute.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "after_values": "01FCNDV6P870EA6S7TK1DSYDG0,01FCNDV6P870EA6S7TK1DSYDG2", "before_values": "01FCNDV6P870EA6S7TK1DSYDG0,01FCNDV6P870EA6S7TK1DSYDG1" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Service", "type": "catalog_type" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Engineering Team", "type": "catalog_entry" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Members", "type": "catalog_attribute" } ], "version": 2 }, "schema": { "$ref": "#/components/schemas/AuditLogsCatalogEntryAttributeUpdatedV2" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/catalog_type.created.1": { "get": { "description": "This entry is created whenever a catalog type is created", "operationId": "CatalogTypeCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "catalog_type.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Service", "type": "catalog_type" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsCatalogTypeCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/catalog_type.deleted.1": { "get": { "description": "This entry is created whenever a catalog type is deleted", "operationId": "CatalogTypeDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "catalog_type.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Service", "type": "catalog_type" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsCatalogTypeDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/catalog_type.updated.1": { "get": { "description": "This entry is created whenever a catalog type is updated", "operationId": "CatalogTypeUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "catalog_type.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Service", "type": "catalog_type" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsCatalogTypeUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/connector_config.created.1": { "get": { "description": "This entry is created whenever a connector config is created", "operationId": "ConnectorConfigCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "connector_config.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My Connector", "type": "connector_config" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsConnectorConfigCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/connector_config.token_generated.1": { "get": { "description": "This entry is created whenever a connector config token is regenerated", "operationId": "ConnectorConfigTokenGeneratedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "connector_config.token_generated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My Connector", "type": "connector_config" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsConnectorConfigTokenGeneratedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/connector_config.updated.1": { "get": { "description": "This entry is created whenever a connector config is updated", "operationId": "ConnectorConfigUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "connector_config.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My Connector", "type": "connector_config" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsConnectorConfigUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/custom_field.created.1": { "get": { "description": "This entry is created whenever a custom field is created", "operationId": "CustomFieldCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "custom_field.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected teams", "type": "custom_field" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsCustomFieldCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/custom_field.deleted.1": { "get": { "description": "This entry is created whenever a custom field is deleted", "operationId": "CustomFieldDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "custom_field.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected teams", "type": "custom_field" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsCustomFieldDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/custom_field.updated.1": { "get": { "description": "This entry is created whenever a custom field is updated", "operationId": "CustomFieldUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "custom_field.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected teams", "type": "custom_field" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsCustomFieldUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/debrief_invite_rule.created.1": { "get": { "description": "This entry is created whenever a debrief invite rule is created", "operationId": "DebriefInviteRuleCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "debrief_invite_rule.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Invite founders for critical incidents", "type": "debrief_invite_rule" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsDebriefInviteRuleCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/debrief_invite_rule.deleted.1": { "get": { "description": "This entry is created whenever a debrief invite rule is deleted", "operationId": "DebriefInviteRuleDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "debrief_invite_rule.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Invite founders for critical incidents", "type": "debrief_invite_rule" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsDebriefInviteRuleDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/debrief_invite_rule.updated.1": { "get": { "description": "This entry is created whenever a debrief invite rule is updated", "operationId": "DebriefInviteRuleUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "debrief_invite_rule.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Invite founders for critical incidents", "type": "debrief_invite_rule" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsDebriefInviteRuleUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/email_otp_login_setting.updated.1": { "get": { "description": "This entry is created whenever the email OTP login setting is toggled for an organisation", "operationId": "EmailOtpLoginSettingUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "email_otp_login_setting.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "enabled": "true" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Organisation Settings", "type": "organisation_settings" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsEmailOtpLoginSettingUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/escalation.scrubbed.1": { "get": { "description": "This entry is created whenever sensitive data is permanently erased from an escalation.", "operationId": "EscalationScrubbedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "escalation.scrubbed", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Escalation (01KB0083ASNF7EPT8NHQNRDXFC)", "type": "escalation" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsEscalationScrubbedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/escalation_path.created.1": { "get": { "description": "This entry is created whenever an escalation path is created", "operationId": "EscalationPathCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "escalation_path.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Critical incidents", "type": "escalation_path" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsEscalationPathCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/escalation_path.deleted.1": { "get": { "description": "This entry is created whenever an escalation path is deleted", "operationId": "EscalationPathDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "escalation_path.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Critical incidents", "type": "escalation_path" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsEscalationPathDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/escalation_path.updated.1": { "get": { "description": "This entry is created whenever an escalation path is updated", "operationId": "EscalationPathUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "escalation_path.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Critical incidents", "type": "escalation_path" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsEscalationPathUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/follow_up_category.created.1": { "get": { "description": "This entry is created whenever a follow up category is created", "operationId": "FollowUpCategoryCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "follow_up_category.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Category Name", "type": "follow_up_category" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsFollowUpCategoryCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/follow_up_category.deleted.1": { "get": { "description": "This entry is created whenever a follow up category is deleted", "operationId": "FollowUpCategoryDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "follow_up_category.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Category Name", "type": "follow_up_category" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsFollowUpCategoryDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/follow_up_category.updated.1": { "get": { "description": "This entry is created whenever a follow up category is updated", "operationId": "FollowUpCategoryUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "follow_up_category.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Category Name", "type": "follow_up_category" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsFollowUpCategoryUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/follow_up_priority.created.1": { "get": { "description": "This entry is created whenever a follow up priority is created", "operationId": "FollowUpPriorityCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "follow_up_priority.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Low", "type": "follow_up_priority" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsFollowUpPriorityCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/follow_up_priority.deleted.1": { "get": { "description": "This entry is created whenever a follow up priority is deleted", "operationId": "FollowUpPriorityDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "follow_up_priority.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Low", "type": "follow_up_priority" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsFollowUpPriorityDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/follow_up_priority.updated.1": { "get": { "description": "This entry is created whenever a follow up priority is updated", "operationId": "FollowUpPriorityUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "follow_up_priority.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Low", "type": "follow_up_priority" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsFollowUpPriorityUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/holiday_user_feed.created.1": { "get": { "description": "This entry is created whenever a holiday user feed is created", "operationId": "HolidayUserFeedCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "holiday_user_feed.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "US Team holidays", "type": "holiday_user_feed" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsHolidayUserFeedCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/holiday_user_feed.deleted.1": { "get": { "description": "This entry is created whenever a holiday user feed is deleted", "operationId": "HolidayUserFeedDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "holiday_user_feed.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "US Team holidays", "type": "holiday_user_feed" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsHolidayUserFeedDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/holiday_user_feed.updated.1": { "get": { "description": "This entry is created whenever a holiday user feed is updated", "operationId": "HolidayUserFeedUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "holiday_user_feed.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "US Team holidays", "type": "holiday_user_feed" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsHolidayUserFeedUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/incident_call_setting.updated.1": { "get": { "description": "This entry is created whenever an organisation's incident call settings are updated", "operationId": "IncidentCallSettingUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "incident_call_setting.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Incident call settings", "type": "incident_call_setting" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsIncidentCallSettingUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/incident_call_transcription_session.deleted.1": { "get": { "description": "This entry is created whenever a calls notes (transcription session) are deleted", "operationId": "IncidentCallTranscriptionSessionDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "incident_call_transcription_session.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Call transcription session", "type": "incident_call_transcription_session" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsIncidentCallTranscriptionSessionDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/incident_duration_metric.created.1": { "get": { "description": "This entry is created whenever a incident duration metric is created", "operationId": "IncidentDurationMetricCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "incident_duration_metric.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Time to resolve", "type": "incident_duration_metric" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsIncidentDurationMetricCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/incident_duration_metric.deleted.1": { "get": { "description": "This entry is created whenever a incident duration metric is deleted", "operationId": "IncidentDurationMetricDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "incident_duration_metric.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Time to resolve", "type": "incident_duration_metric" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsIncidentDurationMetricDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/incident_duration_metric.updated.1": { "get": { "description": "This entry is created whenever a incident duration metric is updated", "operationId": "IncidentDurationMetricUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "incident_duration_metric.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Time to resolve", "type": "incident_duration_metric" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsIncidentDurationMetricUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/incident_role.created.1": { "get": { "description": "This entry is created whenever a incident role is created", "operationId": "IncidentRoleCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "incident_role.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Communications Lead", "type": "incident_role" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsIncidentRoleCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/incident_role.deleted.1": { "get": { "description": "This entry is created whenever a incident role is deleted", "operationId": "IncidentRoleDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "incident_role.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Communications Lead", "type": "incident_role" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsIncidentRoleDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/incident_role.updated.1": { "get": { "description": "This entry is created whenever a incident role is updated", "operationId": "IncidentRoleUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "incident_role.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Communications Lead", "type": "incident_role" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsIncidentRoleUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/incident_status.created.1": { "get": { "description": "This entry is created whenever a incident status is created", "operationId": "IncidentStatusCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "incident_status.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Investigating", "type": "incident_status" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsIncidentStatusCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/incident_status.deleted.1": { "get": { "description": "This entry is created whenever a incident status is deleted", "operationId": "IncidentStatusDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "incident_status.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Investigating", "type": "incident_status" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsIncidentStatusDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/incident_status.updated.1": { "get": { "description": "This entry is created whenever a incident status is updated", "operationId": "IncidentStatusUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "incident_status.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Investigating", "type": "incident_status" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsIncidentStatusUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/incident_timestamp.created.1": { "get": { "description": "This entry is created whenever a incident timestamp is created", "operationId": "IncidentTimestampCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "incident_timestamp.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Fixed at", "type": "incident_timestamp" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsIncidentTimestampCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/incident_timestamp.deleted.1": { "get": { "description": "This entry is created whenever a incident timestamp is deleted", "operationId": "IncidentTimestampDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "incident_timestamp.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Fixed at", "type": "incident_timestamp" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsIncidentTimestampDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/incident_timestamp.updated.1": { "get": { "description": "This entry is created whenever a incident timestamp is updated", "operationId": "IncidentTimestampUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "incident_timestamp.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Fixed at", "type": "incident_timestamp" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsIncidentTimestampUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/incident_timestamp_set_by_rule.created.1": { "get": { "description": "This entry is created whenever an incident timestamp set by rule is created", "operationId": "IncidentTimestampSetByRuleCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "incident_timestamp_set_by_rule.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Fixed at", "type": "incident_timestamp" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Resolved at ('set by' rule)", "type": "incident_timestamp_set_by_rule" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsIncidentTimestampSetByRuleCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/incident_timestamp_set_by_rule.deleted.1": { "get": { "description": "This entry is created whenever an incident timestamp set by rule is deleted", "operationId": "IncidentTimestampSetByRuleDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "incident_timestamp_set_by_rule.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Fixed at", "type": "incident_timestamp" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Resolved at ('set by' rule)", "type": "incident_timestamp_set_by_rule" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsIncidentTimestampSetByRuleDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/incident_timestamp_set_by_rule.updated.1": { "get": { "description": "This entry is created whenever an incident timestamp set by rule is updated", "operationId": "IncidentTimestampSetByRuleUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "incident_timestamp_set_by_rule.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Fixed at", "type": "incident_timestamp" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Resolved at ('set by' rule)", "type": "incident_timestamp_set_by_rule" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsIncidentTimestampSetByRuleUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/incident_type.created.1": { "get": { "description": "This entry is created whenever a incident type is created", "operationId": "IncidentTypeCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "incident_type.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Security", "type": "incident_type" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsIncidentTypeCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/incident_type.deleted.1": { "get": { "description": "This entry is created whenever a incident type is deleted", "operationId": "IncidentTypeDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "incident_type.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Security", "type": "incident_type" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsIncidentTypeDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/incident_type.updated.1": { "get": { "description": "This entry is created whenever a incident type is updated", "operationId": "IncidentTypeUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "incident_type.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Security", "type": "incident_type" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsIncidentTypeUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/integration.installed.1": { "get": { "description": "This entry is created whenever an integration is installed", "operationId": "IntegrationInstalledV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "integration.installed", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "github", "name": "Github", "type": "integration" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsIntegrationInstalledV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/integration.uninstalled.1": { "get": { "description": "This entry is created whenever an integration is uninstalled", "operationId": "IntegrationUninstalledV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "integration.uninstalled", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "github", "name": "Github", "type": "integration" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsIntegrationUninstalledV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/internal_status_page.created.1": { "get": { "description": "This entry is created whenever an internal status page is created", "operationId": "InternalStatusPageCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "internal_status_page.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Public Page", "type": "internal_status_page" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsInternalStatusPageCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/internal_status_page.deleted.1": { "get": { "description": "This entry is created whenever an internal status page is deleted", "operationId": "InternalStatusPageDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "internal_status_page.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Public Page", "type": "internal_status_page" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsInternalStatusPageDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/internal_status_page.updated.1": { "get": { "description": "This entry is created whenever an internal status page has its configuration updated", "operationId": "InternalStatusPageUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "internal_status_page.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Public Page", "type": "internal_status_page" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsInternalStatusPageUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/ip_allowlist.updated.1": { "get": { "description": "This entry is created whenever an IP allowlist is updated", "operationId": "IpAllowlistUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "ip_allowlist.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "additions": "[\"192.0.2.0\",\"192.0.2.0/24\"]", "additions_count": "2", "enabled": "true", "removals": "[\"192.0.2.1\"]", "removals_count": "1", "version": "2" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "IP allowlist", "type": "ip_allowlist" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsIPAllowlistUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/maintenance_window.created.1": { "get": { "description": "This entry is created whenever a maintenance window is created", "operationId": "MaintenanceWindowCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "maintenance_window.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Planned DB migration", "type": "maintenance_window" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsMaintenanceWindowCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/maintenance_window.deleted.1": { "get": { "description": "This entry is created whenever a maintenance window is deleted", "operationId": "MaintenanceWindowDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "maintenance_window.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Planned DB migration", "type": "maintenance_window" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsMaintenanceWindowDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/maintenance_window.updated.1": { "get": { "description": "This entry is created whenever a maintenance window is updated", "operationId": "MaintenanceWindowUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "maintenance_window.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Planned DB migration", "type": "maintenance_window" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsMaintenanceWindowUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/nudge.created.1": { "get": { "description": "This entry is created whenever a nudge is created", "operationId": "NudgeCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "nudge.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Reminder to take a break", "type": "nudge" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsNudgeCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/nudge.deleted.1": { "get": { "description": "This entry is created whenever a nudge is deleted", "operationId": "NudgeDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "nudge.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Reminder to take a break", "type": "nudge" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsNudgeDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/nudge.updated.1": { "get": { "description": "This entry is created whenever a nudge is updated", "operationId": "NudgeUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "nudge.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Reminder to take a break", "type": "nudge" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsNudgeUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/on_call_notification_method.created.1": { "get": { "description": "This entry is created whenever an on-call notification method is created by an actor that isn't the owning user", "operationId": "OnCallNotificationMethodCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "on_call_notification_method.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Phone notification method", "type": "on_call_notification_method" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsOnCallNotificationMethodCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/on_call_notification_method.created.2": { "get": { "description": "This entry is created whenever an on-call notification method is created by an actor that isn't the owning user", "operationId": "OnCallNotificationMethodCreatedV2", "responses": { "200": { "content": { "application/json": { "example": { "action": "on_call_notification_method.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "target_user": "01JV9EMFCFRGCFVNDWTBKT2EBR" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Phone notification method", "type": "on_call_notification_method" } ], "version": 2 }, "schema": { "$ref": "#/components/schemas/AuditLogsOnCallNotificationMethodCreatedV2" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/on_call_notification_method.destroyed.1": { "get": { "description": "This entry is created whenever an on-call notification method is destroyed by an actor that isn't the owning user", "operationId": "OnCallNotificationMethodDestroyedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "on_call_notification_method.destroyed", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Phone notification method", "type": "on_call_notification_method" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsOnCallNotificationMethodDestroyedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/on_call_notification_method.destroyed.2": { "get": { "description": "This entry is created whenever an on-call notification method is destroyed by an actor that isn't the owning user", "operationId": "OnCallNotificationMethodDestroyedV2", "responses": { "200": { "content": { "application/json": { "example": { "action": "on_call_notification_method.destroyed", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "target_user": "01JV9EMFCFRGCFVNDWTBKT2EBR" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Phone notification method", "type": "on_call_notification_method" } ], "version": 2 }, "schema": { "$ref": "#/components/schemas/AuditLogsOnCallNotificationMethodDestroyedV2" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/organisation_settings.updated.1": { "get": { "description": "This entry is created when certain organisation settings are updated", "operationId": "OrganisationSettingsUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "organisation_settings.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "default_timezone": "Europe/London" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Organisation Settings", "type": "organisation_settings" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsOrganisationSettingsUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/policy.created.1": { "get": { "description": "This entry is created whenever a policy is created", "operationId": "PolicyCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "policy.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Follow-ups must be closed within 3 weeks", "type": "policy" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsPolicyCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/policy.deleted.1": { "get": { "description": "This entry is created whenever a policy is deleted", "operationId": "PolicyDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "policy.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Follow-ups must be closed within 3 weeks", "type": "policy" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsPolicyDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/policy.updated.1": { "get": { "description": "This entry is created whenever a policy is updated", "operationId": "PolicyUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "policy.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Follow-ups must be closed within 3 weeks", "type": "policy" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsPolicyUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/post_incident_task.created.1": { "get": { "description": "This entry is created whenever a post-incident task is created", "operationId": "PostIncidentTaskCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "post_incident_task.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsPostIncidentTaskCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/post_incident_task.deleted.1": { "get": { "description": "This entry is created whenever a post-incident task is deleted", "operationId": "PostIncidentTaskDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "post_incident_task.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsPostIncidentTaskDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/post_incident_task.updated.1": { "get": { "description": "This entry is created whenever a post-incident task is updated", "operationId": "PostIncidentTaskUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "post_incident_task.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsPostIncidentTaskUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/postmortem_section.created.1": { "get": { "description": "This entry is created whenever a postmortem template section is created", "operationId": "PostmortemSectionCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "postmortem_section.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsPostmortemSectionCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/postmortem_section.created.2": { "get": { "description": "This entry is created whenever a postmortem template section is created", "operationId": "PostmortemSectionCreatedV2", "responses": { "200": { "content": { "application/json": { "example": { "action": "postmortem_section.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "follow_ups", "type": "postmortem_template_section" } ], "version": 2 }, "schema": { "$ref": "#/components/schemas/AuditLogsPostmortemSectionCreatedV2" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/postmortem_section.deleted.1": { "get": { "description": "This entry is created whenever a postmortem template section is deleted", "operationId": "PostmortemSectionDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "postmortem_section.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsPostmortemSectionDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/postmortem_section.deleted.2": { "get": { "description": "This entry is created whenever a postmortem template section is deleted", "operationId": "PostmortemSectionDeletedV2", "responses": { "200": { "content": { "application/json": { "example": { "action": "postmortem_section.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "follow_ups", "type": "postmortem_template_section" } ], "version": 2 }, "schema": { "$ref": "#/components/schemas/AuditLogsPostmortemSectionDeletedV2" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/postmortem_section.updated.1": { "get": { "description": "This entry is created whenever a postmortem template section is updated", "operationId": "PostmortemSectionUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "postmortem_section.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsPostmortemSectionUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/postmortem_section.updated.2": { "get": { "description": "This entry is created whenever a postmortem template section is updated", "operationId": "PostmortemSectionUpdatedV2", "responses": { "200": { "content": { "application/json": { "example": { "action": "postmortem_section.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "follow_ups", "type": "postmortem_template_section" } ], "version": 2 }, "schema": { "$ref": "#/components/schemas/AuditLogsPostmortemSectionUpdatedV2" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/postmortem_template.created.1": { "get": { "description": "This entry is created whenever a postmortem template is created", "operationId": "PostmortemTemplateCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "postmortem_template.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsPostmortemTemplateCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/postmortem_template.created.2": { "get": { "description": "This entry is created whenever a postmortem template is created", "operationId": "PostmortemTemplateCreatedV2", "responses": { "200": { "content": { "application/json": { "example": { "action": "postmortem_template.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Root cause analysis (RCA)", "type": "postmortem_template" } ], "version": 2 }, "schema": { "$ref": "#/components/schemas/AuditLogsPostmortemTemplateCreatedV2" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/postmortem_template.deleted.1": { "get": { "description": "This entry is created whenever a postmortem template is deleted", "operationId": "PostmortemTemplateDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "postmortem_template.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsPostmortemTemplateDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/postmortem_template.deleted.2": { "get": { "description": "This entry is created whenever a postmortem template is deleted", "operationId": "PostmortemTemplateDeletedV2", "responses": { "200": { "content": { "application/json": { "example": { "action": "postmortem_template.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Root cause analysis (RCA)", "type": "postmortem_template" } ], "version": 2 }, "schema": { "$ref": "#/components/schemas/AuditLogsPostmortemTemplateDeletedV2" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/postmortem_template.updated.1": { "get": { "description": "This entry is created whenever a postmortem template is updated", "operationId": "PostmortemTemplateUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "postmortem_template.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Schedule a debrief", "type": "post_incident_task" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsPostmortemTemplateUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/postmortem_template.updated.2": { "get": { "description": "This entry is created whenever a postmortem template is updated", "operationId": "PostmortemTemplateUpdatedV2", "responses": { "200": { "content": { "application/json": { "example": { "action": "postmortem_template.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Root cause analysis (RCA)", "type": "postmortem_template" } ], "version": 2 }, "schema": { "$ref": "#/components/schemas/AuditLogsPostmortemTemplateUpdatedV2" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/private_alert.access_attempted.1": { "get": { "description": "This entry is created whenever someone attempts to access a private alert.", "operationId": "PrivateAlertAccessAttemptedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "private_alert.access_attempted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "outcome": "granted" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Alert (01KB0083ASNF7EPT8NHQNRDXFC)", "type": "alert" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsPrivateAlertAccessAttemptedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/private_escalation.access_attempted.1": { "get": { "description": "This entry is created whenever someone attempts to access a private escalation.", "operationId": "PrivateEscalationAccessAttemptedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "private_escalation.access_attempted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "outcome": "granted" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Escalation (01KB0083ASNF7EPT8NHQNRDXFC)", "type": "escalation" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsPrivateEscalationAccessAttemptedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/private_incident.access_attempted.1": { "get": { "description": "This entry is created whenever someone attempts to access a private incident.", "operationId": "PrivateIncidentAccessAttemptedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "private_incident.access_attempted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "outcome": "granted" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#INC-123 The website is slow", "type": "incident" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsPrivateIncidentAccessAttemptedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/private_incident.access_requested.1": { "get": { "description": "This entry is created whenever someone requests access to a private incident.", "operationId": "PrivateIncidentAccessRequestedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "private_incident.access_requested", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#INC-123 The website is slow", "type": "incident" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsPrivateIncidentAccessRequestedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/private_incident.accessed_via_bot.1": { "get": { "description": "This entry is created whenever someone accesses a private incident via the incident bot.", "operationId": "PrivateIncidentAccessedViaBotV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "private_incident.accessed_via_bot", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#INC-123 The website is slow", "type": "incident" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsPrivateIncidentAccessedViaBotV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/private_incident_membership.granted.1": { "get": { "description": "This entry is created whenever someone is granted access to a private incident. If they have the 'manage private incidents' permission, then it'll appear that the system has given them access to the incident.", "operationId": "PrivateIncidentMembershipGrantedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "private_incident_membership.granted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#INC-123 The website is slow", "type": "incident" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsPrivateIncidentMembershipGrantedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/private_incident_membership.revoked.1": { "get": { "description": "This entry is created whenever someone's access to a private incident is revoked.", "operationId": "PrivateIncidentMembershipRevokedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "private_incident_membership.revoked", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" }, { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "#INC-123 The website is slow", "type": "incident" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsPrivateIncidentMembershipRevokedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/qr_code_mobile_login_setting.updated.1": { "get": { "description": "This entry is created whenever the QR code mobile login setting is toggled for an organisation", "operationId": "QrCodeMobileLoginSettingUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "qr_code_mobile_login_setting.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "enabled": "true" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Organisation Settings", "type": "organisation_settings" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsQrCodeMobileLoginSettingUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/rbac_role.created.1": { "get": { "description": "This entry is created whenever a rbac role is created", "operationId": "RbacRoleCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "rbac_role.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Engineering", "type": "rbac_role" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsRbacRoleCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/rbac_role.deleted.1": { "get": { "description": "This entry is created whenever a rbac role is deleted", "operationId": "RbacRoleDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "rbac_role.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Engineering", "type": "rbac_role" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsRbacRoleDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/rbac_role.updated.1": { "get": { "description": "This entry is created whenever a rbac role is updated", "operationId": "RbacRoleUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "rbac_role.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Engineering", "type": "rbac_role" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsRbacRoleUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/schedule.created.1": { "get": { "description": "This entry is created whenever a schedule is created", "operationId": "ScheduleCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "schedule.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "On-call", "type": "schedule" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsScheduleCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/schedule.deleted.1": { "get": { "description": "This entry is created whenever a schedule is deleted", "operationId": "ScheduleDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "schedule.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "On-call", "type": "schedule" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsScheduleDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/schedule.updated.1": { "get": { "description": "This entry is created whenever a schedule is updated", "operationId": "ScheduleUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "schedule.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "On-call", "type": "schedule" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsScheduleUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/schedule_override.created.1": { "get": { "description": "This entry is created whenever a schedule override is created", "operationId": "ScheduleOverrideCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "schedule_override.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Override for Urgent Support", "type": "schedule_override" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsScheduleOverrideCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/schedule_override.created.2": { "get": { "description": "This entry is created whenever a schedule override is created", "operationId": "ScheduleOverrideCreatedV2", "responses": { "200": { "content": { "application/json": { "example": { "action": "schedule_override.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "after_user_ids": "01FCNDV6P870EA6S7TK1DSYDG2", "after_user_names": "Nicole C", "before_user_ids": "01FCNDV6P870EA6S7TK1DSYDG0,01FCNDV6P870EA6S7TK1DSYDG1", "before_user_names": "Nicole A,Nicole B", "end_at": "2026-03-02T08:00:00Z", "start_at": "2026-03-01T18:00:00Z" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Override for Urgent Support", "type": "schedule_override" } ], "version": 2 }, "schema": { "$ref": "#/components/schemas/AuditLogsScheduleOverrideCreatedV2" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/schedule_override.deleted.1": { "get": { "description": "This entry is created whenever a schedule override is deleted", "operationId": "ScheduleOverrideDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "schedule_override.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Override for Urgent Support", "type": "schedule_override" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsScheduleOverrideDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/schedule_override.deleted.2": { "get": { "description": "This entry is created whenever a schedule override is deleted", "operationId": "ScheduleOverrideDeletedV2", "responses": { "200": { "content": { "application/json": { "example": { "action": "schedule_override.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "after_user_ids": "01FCNDV6P870EA6S7TK1DSYDG2", "after_user_names": "Nicole C", "before_user_ids": "01FCNDV6P870EA6S7TK1DSYDG0,01FCNDV6P870EA6S7TK1DSYDG1", "before_user_names": "Nicole A,Nicole B", "end_at": "2026-03-02T08:00:00Z", "start_at": "2026-03-01T18:00:00Z" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Override for Urgent Support", "type": "schedule_override" } ], "version": 2 }, "schema": { "$ref": "#/components/schemas/AuditLogsScheduleOverrideDeletedV2" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/schedule_override.updated.1": { "get": { "description": "This entry is created whenever a schedule override is updated", "operationId": "ScheduleOverrideUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "schedule_override.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Override for Urgent Support", "type": "schedule_override" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsScheduleOverrideUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/schedule_override.updated.2": { "get": { "description": "This entry is created whenever a schedule override is updated", "operationId": "ScheduleOverrideUpdatedV2", "responses": { "200": { "content": { "application/json": { "example": { "action": "schedule_override.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "after_user_ids": "01FCNDV6P870EA6S7TK1DSYDG2", "after_user_names": "Nicole C", "before_user_ids": "01FCNDV6P870EA6S7TK1DSYDG0,01FCNDV6P870EA6S7TK1DSYDG1", "before_user_names": "Nicole A,Nicole B", "end_at": "2026-03-02T08:00:00Z", "start_at": "2026-03-01T18:00:00Z" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Override for Urgent Support", "type": "schedule_override" } ], "version": 2 }, "schema": { "$ref": "#/components/schemas/AuditLogsScheduleOverrideUpdatedV2" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/scim_group.role_mappings_updated.1": { "get": { "description": "This entry is created whenever a SCIM group is mapped to a new RBAC role", "operationId": "ScimGroupRoleMappingsUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "scim_group.role_mappings_updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "after_base_role_slug": "owner", "after_custom_role_slugs": "engineering,data", "before_base_role_slug": "admin", "before_custom_role_slugs": "engineering,security" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Security", "type": "scim_group" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsScimGroupRoleMappingsUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/scim_group.seat_mappings_updated.1": { "get": { "description": "This entry is created whenever a SCIM group is mapped to new seat types", "operationId": "ScimGroupSeatMappingsUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "scim_group.seat_mappings_updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "after_seat_types": "[full_access, responder_access]", "before_seat_types": "[full_access]" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Security", "type": "scim_group" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsScimGroupSeatMappingsUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/severity.created.1": { "get": { "description": "This entry is created whenever a severity is created", "operationId": "SeverityCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "severity.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "type": "severity" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsSeverityCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/severity.deleted.1": { "get": { "description": "This entry is created whenever a severity is deleted", "operationId": "SeverityDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "severity.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "type": "severity" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsSeverityDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/severity.updated.1": { "get": { "description": "This entry is created whenever a severity is updated", "operationId": "SeverityUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "severity.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "type": "severity" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsSeverityUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/status_page.created.1": { "get": { "description": "This entry is created whenever a status page is created", "operationId": "StatusPageCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "status_page.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Public Page", "type": "status_page" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsStatusPageCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/status_page.deleted.1": { "get": { "description": "This entry is created whenever a status page is deleted", "operationId": "StatusPageDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "status_page.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Public Page", "type": "status_page" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsStatusPageDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/status_page.updated.1": { "get": { "description": "This entry is created whenever a status page has its configuration updated", "operationId": "StatusPageUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "status_page.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Public Page", "type": "status_page" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsStatusPageUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/status_page_sub_page.created.1": { "get": { "description": "This entry is created whenever a status page sub-page is created", "operationId": "StatusPageSubPageCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "status_page_sub_page.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Superpayments France", "type": "status_page_sub_page" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsStatusPageSubPageCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/status_page_sub_page.deleted.1": { "get": { "description": "This entry is created whenever a status page sub-page is deleted", "operationId": "StatusPageSubPageDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "status_page_sub_page.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Superpayments France", "type": "status_page_sub_page" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsStatusPageSubPageDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/status_page_sub_page.updated.1": { "get": { "description": "This entry is created whenever a status page sub-page has its configuration updated", "operationId": "StatusPageSubPageUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "status_page_sub_page.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Superpayments France", "type": "status_page_sub_page" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsStatusPageSubPageUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/status_page_template.created.1": { "get": { "description": "This entry is created whenever a status page template is created", "operationId": "StatusPageTemplateCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "status_page_template.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Investigating", "type": "status_page_template" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsStatusPageTemplateCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/status_page_template.deleted.1": { "get": { "description": "This entry is created whenever a status page template is deleted", "operationId": "StatusPageTemplateDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "status_page_template.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Investigating", "type": "status_page_template" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsStatusPageTemplateDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/status_page_template.updated.1": { "get": { "description": "This entry is created whenever a status page template is updated", "operationId": "StatusPageTemplateUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "status_page_template.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Investigating", "type": "status_page_template" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsStatusPageTemplateUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/team_role.created.1": { "get": { "description": "This entry is created whenever a team role is created", "operationId": "TeamRoleCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "team_role.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Tech lead", "type": "team_role" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsTeamRoleCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/team_role.deleted.1": { "get": { "description": "This entry is created whenever a team role is deleted", "operationId": "TeamRoleDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "team_role.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Tech lead", "type": "team_role" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsTeamRoleDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/team_role.updated.1": { "get": { "description": "This entry is created whenever a team role is updated", "operationId": "TeamRoleUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "team_role.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Tech lead", "type": "team_role" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsTeamRoleUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/team_settings.updated.1": { "get": { "description": "This entry is created whenever team settings are updated", "operationId": "TeamSettingsUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "team_settings.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Team Settings", "type": "team_settings" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsTeamSettingsUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/telemetry_data_source.installed.1": { "get": { "description": "This entry is created whenever a telemetry data source is connected", "operationId": "TelemetryDataSourceInstalledV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "telemetry_data_source.installed", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Grafana Cloud", "type": "telemetry_data_source" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsTelemetryDataSourceInstalledV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/telemetry_data_source.uninstalled.1": { "get": { "description": "This entry is created whenever a telemetry data source is disconnected", "operationId": "TelemetryDataSourceUninstalledV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "telemetry_data_source.uninstalled", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Grafana Cloud", "type": "telemetry_data_source" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsTelemetryDataSourceUninstalledV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/timeline_item.deleted.1": { "get": { "description": "This entry is created whenever a timeline item is deleted", "operationId": "TimelineItemDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "timeline_item.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Timeline item (01FCNDV6P870EA6S7TK1DSYDG0)", "type": "timeline_item" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsTimelineItemDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/user.created.1": { "get": { "description": "This entry is created whenever a user is created", "operationId": "UserCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "user.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsUserCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/user.deactivated.1": { "get": { "description": "This entry is created whenever a user is deactivated", "operationId": "UserDeactivatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "user.deactivated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsUserDeactivatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/user.reinstated.1": { "get": { "description": "This entry is created when a user is reinstated after being deactivated", "operationId": "UserReinstatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "user.reinstated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsUserReinstatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/user.role_memberships_updated.1": { "get": { "description": "This entry is created whenever a user's role memberships are changed.", "operationId": "UserRoleMembershipsUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "user.role_memberships_updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "metadata": { "after_base_role_slug": "owner", "after_custom_role_slugs": "engineering,data", "before_base_role_slug": "admin", "before_custom_role_slugs": "engineering,security" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsUserRoleMembershipsUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/user.updated.1": { "get": { "description": "This entry is created whenever a user is updated", "operationId": "UserUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "user.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Bob the builder", "type": "user" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsUserUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/workflow.created.1": { "get": { "description": "This entry is created whenever a workflow is created", "operationId": "WorkflowCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "workflow.created", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Nudge to write a postmortem", "type": "workflow" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsWorkflowCreatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/workflow.deleted.1": { "get": { "description": "This entry is created whenever a workflow is deleted", "operationId": "WorkflowDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "workflow.deleted", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Nudge to write a postmortem", "type": "workflow" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsWorkflowDeletedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-audit-logs/workflow.updated.1": { "get": { "description": "This entry is created whenever a workflow is updated", "operationId": "WorkflowUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "action": "workflow.updated", "actor": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "metadata": { "user_base_role_slug": "admin", "user_custom_role_slugs": "engineering,security" }, "name": "John Doe", "type": "user" }, "context": { "location": "1.2.3.4", "user_agent": "Chrome/91.0.4472.114" }, "occurred_at": "2021-08-17T13:28:57.801578Z", "targets": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Nudge to write a postmortem", "type": "workflow" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AuditLogsWorkflowUpdatedV1" } } }, "description": "OK response." } }, "tags": [ "Audit logs" ] } }, "/x-webhooks/private_alert.alert_created_v1": { "get": { "description": "This webhook is emitted whenever a new private alert is created.", "operationId": "PrivateAlertCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "private_alert.alert_created_v1", "private_alert.alert_created_v1": { "id": "abc123" } }, "schema": { "$ref": "#/components/schemas/WebhooksPrivateAlertCreatedV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Webhooks" ] } }, "/x-webhooks/private_incident.action_created_v1": { "get": { "description": "This webhook is emitted whenever a follow-up for a private incident is created.", "operationId": "PrivateIncidentActionCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "private_incident.action_created_v1", "private_incident.action_created_v1": { "id": "abc123" } }, "schema": { "$ref": "#/components/schemas/WebhooksPrivateIncidentActionCreatedV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Webhooks" ] } }, "/x-webhooks/private_incident.action_updated_v1": { "get": { "description": "This webhook is emitted whenever a follow-up for a private incident is updated.", "operationId": "PrivateIncidentActionUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "private_incident.action_updated_v1", "private_incident.action_updated_v1": { "id": "abc123" } }, "schema": { "$ref": "#/components/schemas/WebhooksPrivateIncidentActionUpdatedV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Webhooks" ] } }, "/x-webhooks/private_incident.follow_up_created_v1": { "get": { "description": "This webhook is emitted whenever a follow-up for a private incident is created.", "operationId": "PrivateIncidentFollowUpCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "private_incident.follow_up_created_v1", "private_incident.follow_up_created_v1": { "id": "abc123" } }, "schema": { "$ref": "#/components/schemas/WebhooksPrivateIncidentFollowUpCreatedV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Webhooks" ] } }, "/x-webhooks/private_incident.follow_up_created_v2": { "get": { "description": "This webhook is emitted whenever a follow-up for a private incident is created.", "operationId": "PrivateIncidentFollowUpCreatedV2", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "private_incident.follow_up_created_v2", "private_incident.follow_up_created_v2": { "id": "abc123" } }, "schema": { "$ref": "#/components/schemas/WebhooksPrivateIncidentFollowUpCreatedV2ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Webhooks" ] } }, "/x-webhooks/private_incident.follow_up_updated_v1": { "get": { "description": "This webhook is emitted whenever a follow-up for a private incident is updated.", "operationId": "PrivateIncidentFollowUpUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "private_incident.follow_up_updated_v1", "private_incident.follow_up_updated_v1": { "id": "abc123" } }, "schema": { "$ref": "#/components/schemas/WebhooksPrivateIncidentFollowUpUpdatedV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Webhooks" ] } }, "/x-webhooks/private_incident.follow_up_updated_v2": { "get": { "description": "This webhook is emitted whenever a follow-up for a private incident is updated.", "operationId": "PrivateIncidentFollowUpUpdatedV2", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "private_incident.follow_up_updated_v2", "private_incident.follow_up_updated_v2": { "id": "abc123" } }, "schema": { "$ref": "#/components/schemas/WebhooksPrivateIncidentFollowUpUpdatedV2ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Webhooks" ] } }, "/x-webhooks/private_incident.incident_created_v2": { "get": { "description": "This webhook is emitted whenever a new private incident is created.", "operationId": "PrivateIncidentIncidentCreatedV2", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "private_incident.incident_created_v2", "private_incident.incident_created_v2": { "id": "abc123" } }, "schema": { "$ref": "#/components/schemas/WebhooksPrivateIncidentIncidentCreatedV2ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Webhooks" ] } }, "/x-webhooks/private_incident.incident_updated_v2": { "get": { "description": "This webhook is emitted whenever a private incident is updated.", "operationId": "PrivateIncidentIncidentUpdatedV2", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "private_incident.incident_updated_v2", "private_incident.incident_updated_v2": { "id": "abc123" } }, "schema": { "$ref": "#/components/schemas/WebhooksPrivateIncidentIncidentUpdatedV2ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Webhooks" ] } }, "/x-webhooks/private_incident.membership_granted_v1": { "get": { "description": "This webhook is emitted whenever a user is given access to a private incident.", "operationId": "PrivateIncidentMembershipGrantedV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "private_incident.membership_granted_v1", "private_incident.membership_granted_v1": { "actor_user_id": "abc123", "incident_id": "abc123", "user_id": "abc123" } }, "schema": { "$ref": "#/components/schemas/WebhooksPrivateIncidentMembershipGrantedV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Webhooks" ] } }, "/x-webhooks/private_incident.membership_revoked_v1": { "get": { "description": "This webhook is emitted whenever a user's access to a private incident is revoked.", "operationId": "PrivateIncidentMembershipRevokedV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "private_incident.membership_revoked_v1", "private_incident.membership_revoked_v1": { "actor_user_id": "abc123", "incident_id": "abc123", "user_id": "abc123" } }, "schema": { "$ref": "#/components/schemas/WebhooksPrivateIncidentMembershipRevokedV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Webhooks" ] } }, "/x-webhooks/private_incident.postmortem_document_status_updated_v1": { "get": { "description": "This webhook is emitted whenever a postmortem's status, on a private incident, is updated", "operationId": "PrivateIncidentPostmortemDocumentStatusUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "private_incident.postmortem_document_status_updated_v1", "private_incident.postmortem_document_status_updated_v1": { "id": "abc123" } }, "schema": { "$ref": "#/components/schemas/WebhooksPrivateIncidentPostmortemDocumentStatusUpdatedV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Webhooks" ] } }, "/x-webhooks/public_alert.alert_created_v1": { "get": { "description": "This webhook is emitted whenever a new alert is created.", "operationId": "PublicAlertCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "public_alert.alert_created_v1", "public_alert.alert_created_v1": { "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66", "attributes": [ { "array_value": [ { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } ], "attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "value": { "catalog_entry": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "label": "Payments Team", "literal": "SEV123" } } ], "created_at": "2021-08-17T13:28:57.801578Z", "deduplication_key": "4293868629", "description": "CPU on the payments service has exceeded 75 percent for 5 minutes", "id": "01GW2G3V0S59R238FAHPDS1R66", "resolved_at": "2021-08-17T14:28:57.801578Z", "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/WebhooksPublicAlertCreatedV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Webhooks" ] } }, "/x-webhooks/public_incident.action_created_v1": { "get": { "description": "This webhook is emitted whenever a follow-up is created.", "operationId": "PublicIncidentActionCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "public_incident.action_created_v1", "public_incident.action_created_v1": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "follow_up": true, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/WebhooksPublicIncidentActionCreatedV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Webhooks" ] } }, "/x-webhooks/public_incident.action_updated_v1": { "get": { "description": "This webhook is emitted whenever a follow-up is updated.", "operationId": "PublicIncidentActionUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "public_incident.action_updated_v1", "public_incident.action_updated_v1": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "follow_up": true, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/WebhooksPublicIncidentActionUpdatedV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Webhooks" ] } }, "/x-webhooks/public_incident.follow_up_created_v1": { "get": { "description": "This webhook is emitted whenever a follow-up is created.", "operationId": "PublicIncidentFollowUpCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "public_incident.follow_up_created_v1", "public_incident.follow_up_created_v1": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "follow_up": true, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/WebhooksPublicIncidentFollowUpCreatedV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Webhooks" ] } }, "/x-webhooks/public_incident.follow_up_created_v2": { "get": { "description": "This webhook is emitted whenever a follow-up is created.", "operationId": "PublicIncidentFollowUpCreatedV2", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "public_incident.follow_up_created_v2", "public_incident.follow_up_created_v2": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/WebhooksPublicIncidentFollowUpCreatedV2ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Webhooks" ] } }, "/x-webhooks/public_incident.follow_up_updated_v1": { "get": { "description": "This webhook is emitted whenever a follow-up is updated.", "operationId": "PublicIncidentFollowUpUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "public_incident.follow_up_updated_v1", "public_incident.follow_up_updated_v1": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "follow_up": true, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/WebhooksPublicIncidentFollowUpUpdatedV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Webhooks" ] } }, "/x-webhooks/public_incident.follow_up_updated_v2": { "get": { "description": "This webhook is emitted whenever a follow-up is updated.", "operationId": "PublicIncidentFollowUpUpdatedV2", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "public_incident.follow_up_updated_v2", "public_incident.follow_up_updated_v2": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/WebhooksPublicIncidentFollowUpUpdatedV2ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Webhooks" ] } }, "/x-webhooks/public_incident.incident_created_v2": { "get": { "description": "This webhook is emitted whenever a new incident is created.", "operationId": "PublicIncidentIncidentCreatedV2", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "public_incident.incident_created_v2", "public_incident.incident_created_v2": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "value_seconds": 10800 } ], "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "has_debrief": false, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "incident_timestamp_values": [ { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "value": { "value": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "standard", "most_recent_update_message": "We're working on a fix, hoping to ship in the next 30 minutes", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_ids": [ "01FCNDV6P870EA6S7TK1DSYD5H" ], "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "related_incidents": [ "INC-237" ], "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 } }, "schema": { "$ref": "#/components/schemas/WebhooksPublicIncidentIncidentCreatedV2ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Webhooks" ] } }, "/x-webhooks/public_incident.incident_status_updated_v2": { "get": { "description": "This webhook is emitted whenever an incident's status changes.", "operationId": "PublicIncidentIncidentStatusUpdatedV2", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "public_incident.incident_status_updated_v2", "public_incident.incident_status_updated_v2": { "incident": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "value_seconds": 10800 } ], "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "has_debrief": false, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "incident_timestamp_values": [ { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "value": { "value": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "standard", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_ids": [ "01FCNDV6P870EA6S7TK1DSYD5H" ], "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 }, "message": "We're working on a fix, hoping to ship in the next 30 minutes", "new_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "previous_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" } } }, "schema": { "$ref": "#/components/schemas/WebhooksPublicIncidentIncidentStatusUpdatedV2ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Webhooks" ] } }, "/x-webhooks/public_incident.incident_updated_v2": { "get": { "description": "This webhook is emitted whenever an incident is updated.", "operationId": "PublicIncidentIncidentUpdatedV2", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "public_incident.incident_updated_v2", "public_incident.incident_updated_v2": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "value_seconds": 10800 } ], "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "has_debrief": false, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "incident_role_assignments": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "required": false, "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } } ], "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "incident_timestamp_values": [ { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "value": { "value": "2021-08-17T13:28:57.801578Z" } } ], "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" }, "mode": "standard", "most_recent_update_message": "We're working on a fix, hoping to ship in the next 30 minutes", "name": "Our database is sad", "permalink": "https://app.incident.io/incidents/123", "postmortem_document_ids": [ "01FCNDV6P870EA6S7TK1DSYD5H" ], "postmortem_document_url": "https://docs.google.com/my_doc_id", "reference": "INC-123", "related_incidents": [ "INC-237" ], "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "slack_channel_id": "C02AW36C1M5", "slack_channel_name": "inc-165-green-parrot", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 } }, "schema": { "$ref": "#/components/schemas/WebhooksPublicIncidentIncidentUpdatedV2ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Webhooks" ] } }, "/x-webhooks/public_incident.postmortem_document_status_updated_v1": { "get": { "description": "This webhook is emitted whenever a postmortem's status is updated", "operationId": "PublicIncidentPostmortemDocumentStatusUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "public_incident.postmortem_document_status_updated_v1", "public_incident.postmortem_document_status_updated_v1": { "new_status": "complete", "postmortem_document": { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" }, "previous_status": "review" } }, "schema": { "$ref": "#/components/schemas/WebhooksPublicIncidentPostmortemDocumentStatusUpdatedV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Webhooks" ] } } } }