{ "openapi": "3.1.0", "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 \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\nLimits are token buckets that refill continuously rather than resetting on a fixed window boundary. The default\nbucket holds 1200 requests and refills at 20 per second, so you can burst up to the full bucket and then sustain\n20 requests/second indefinitely. There is no boundary at which your quota resets to full in one step.\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.\n\n### Rate limit headers\n\nResponses to requests authenticated with an API key carry your current allowance, so you can pace yourself rather\nthan waiting to be throttled:\n\n```\nX-RateLimit-Limit: 60, 1200;window=60, 60;window=60\nX-RateLimit-Remaining: 59\nX-RateLimit-Used: 1\nX-RateLimit-Reset: 1785173199\n```\n\n| Header | Meaning |\n| --- | --- |\n| `X-RateLimit-Limit` | The quota that binds this request, followed by every limit that applied and the window it applies over |\n| `X-RateLimit-Remaining` | Requests you can make right now against the binding limit |\n| `X-RateLimit-Used` | Requests you have spent against it |\n| `X-RateLimit-Reset` | Unix timestamp (seconds) at which that limit will be back to full |\n\nMore than one limit can apply to a request: your API key's overall limit, and for some endpoints a lower limit of\ntheir own. `X-RateLimit-Limit` lists all of them, each with its window, so `1200;window=60` means 1200 requests per\nminute. Because our limits refill continuously rather than resetting on a boundary, that window is what tells you\nthe rate you can sustain: 1200 per 60 seconds is 20 requests/second indefinitely.\n\n`Remaining`, `Used` and `Reset` describe whichever limit has the least allowance left, since that is the one you\nwill hit first.\n\n`X-RateLimit-Remaining` may lag by a small number of requests under high concurrency, and can move by more than the\nrequests you made, because limits scoped to your whole organisation are shared with your other API keys.\n\nHeaders are omitted rather than guessed if we cannot determine your allowance for a request.\n\n### Exceeding a rate limit\n\nWhen you exceed a rate limit the API responds with `429 Too Many Requests` and a `Retry-After` header giving the\nnumber of seconds to wait:\n\n```\nX-RateLimit-Limit: 1200, 1200;window=60\nX-RateLimit-Remaining: 0\nX-RateLimit-Used: 1200\nX-RateLimit-Reset: 1785173199\nRetry-After: 1\n```\n\nPrefer `Retry-After` over `X-RateLimit-Reset` when deciding how long to back off. `Retry-After` is when a single\nrequest will succeed; `X-RateLimit-Reset` is the later point at which your whole allowance has returned. It is a\nduration rather than a timestamp, so it does not depend on your clock agreeing with ours.\n\nThe 429 also carries a JSON body with the same information:\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\": \"2025-04-17T11:17:18Z\"\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`), as an RFC3339 timestamp\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" }, "servers": [ { "url": "https://api.incident.io" } ], "security": [ { "BearerAuth": [] } ], "tags": [ { "name": "Action V1" }, { "name": "Alert V1" }, { "name": "Created V1" }, { "name": "Deleted V1" }, { "name": "Escalation V1" }, { "name": "Escalation status V1" }, { "name": "Follow up V1" }, { "name": "Follow up V2" }, { "name": "Incident V2" }, { "name": "Incident status V2" }, { "name": "Membership V1" }, { "name": "Postmortem document status V1" }, { "name": "Shift V1" }, { "name": "Updated V1" } ], "paths": {}, "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": [ "Alert V1" ], "summary": "Created (private)" } }, "private_alert.alert_resolved_v1": { "get": { "description": "This webhook is emitted whenever a private alert is resolved.", "operationId": "PrivateAlertResolvedV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "private_alert.alert_resolved_v1", "private_alert.alert_resolved_v1": { "id": "abc123" } }, "schema": { "$ref": "#/components/schemas/WebhooksPrivateAlertResolvedV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Alert V1" ], "summary": "Resolved (private)" } }, "private_escalation.escalation_created_v1": { "get": { "description": "This webhook is emitted whenever a private escalation is created.", "operationId": "PrivateEscalationCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "private_escalation.escalation_created_v1", "private_escalation.escalation_created_v1": { "id": "abc123" } }, "schema": { "$ref": "#/components/schemas/WebhooksPrivateEscalationCreatedV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Escalation V1" ], "summary": "Created (private)" } }, "private_escalation.escalation_status_updated_v1": { "get": { "description": "This webhook is emitted whenever a private escalation changes status.", "operationId": "PrivateEscalationStatusUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "private_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_v1": { "id": "abc123" } }, "schema": { "$ref": "#/components/schemas/WebhooksPrivateEscalationStatusUpdatedV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Escalation status V1" ], "summary": "Updated (private)" } }, "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": [ "Action V1" ], "summary": "Created (private)" } }, "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": [ "Action V1" ], "summary": "Updated (private)" } }, "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": [ "Follow up V1" ], "summary": "Created (private)" } }, "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": [ "Follow up V2" ], "summary": "Created (private)" } }, "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": [ "Follow up V1" ], "summary": "Updated (private)" } }, "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": [ "Follow up V2" ], "summary": "Updated (private)" } }, "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": [ "Incident V2" ], "summary": "Created (private)" } }, "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": [ "Incident V2" ], "summary": "Updated (private)" } }, "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": [ "Membership V1" ], "summary": "Granted (private)" } }, "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": [ "Membership V1" ], "summary": "Revoked (private)" } }, "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": [ "Postmortem document status V1" ], "summary": "Updated (private)" } }, "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_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "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": [ "Alert V1" ], "summary": "Created (public)" } }, "public_alert.alert_resolved_v1": { "get": { "description": "This webhook is emitted whenever an alert is resolved.", "operationId": "PublicAlertResolvedV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "public_alert.alert_resolved_v1", "public_alert.alert_resolved_v1": { "alert_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "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/WebhooksPublicAlertResolvedV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Alert V1" ], "summary": "Resolved (public)" } }, "public_escalation.escalation_created_v1": { "get": { "description": "This webhook is emitted whenever an escalation is created.", "operationId": "PublicEscalationCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "public_escalation.escalation_created_v1", "public_escalation.escalation_created_v1": { "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_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "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/WebhooksPublicEscalationCreatedV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Escalation V1" ], "summary": "Created (public)" } }, "public_escalation.escalation_status_updated_v1": { "get": { "description": "This webhook is emitted whenever an escalation changes status. See [escalation statuses](https://docs.incident.io/on-call/escalation-statuses) for details on each status value.", "operationId": "PublicEscalationStatusUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "public_escalation.escalation_status_updated_v1", "public_escalation.escalation_status_updated_v1": { "actor": { "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" } }, "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_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "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" }, "new_status": "pending", "previous_status": "pending" } }, "schema": { "$ref": "#/components/schemas/WebhooksPublicEscalationStatusUpdatedV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Escalation status V1" ], "summary": "Updated (public)" } }, "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": [ "Action V1" ], "summary": "Created (public)" } }, "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": [ "Action V1" ], "summary": "Updated (public)" } }, "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": [ "Follow up V1" ], "summary": "Created (public)" } }, "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" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "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": [ "Follow up V2" ], "summary": "Created (public)" } }, "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": [ "Follow up V1" ], "summary": "Updated (public)" } }, "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" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "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": [ "Follow up V2" ], "summary": "Updated (public)" } }, "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" }, "status": "success", "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": [ "Incident V2" ], "summary": "Created (public)" } }, "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" }, "status": "success", "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": [ "Incident status V2" ], "summary": "Updated (public)" } }, "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" }, "status": "success", "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": [ "Incident V2" ], "summary": "Updated (public)" } }, "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": [ "Postmortem document status V1" ], "summary": "Updated (public)" } }, "schedule.created_v1": { "get": { "description": "This webhook is emitted whenever a schedule is created.", "operationId": "ScheduleCreatedV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "schedule.created_v1", "schedule.created_v1": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/WebhooksScheduleCreatedV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Created V1" ], "summary": " (public)" } }, "schedule.deleted_v1": { "get": { "description": "This webhook is emitted whenever a schedule is deleted.", "operationId": "ScheduleDeletedV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "schedule.deleted_v1", "schedule.deleted_v1": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/WebhooksScheduleDeletedV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Deleted V1" ], "summary": " (public)" } }, "schedule.shift_change_v1": { "get": { "description": "This webhook is emitted whenever the on-call user(s) change on a schedule.", "operationId": "ScheduleShiftChangeV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "schedule.shift_change_v1", "schedule.shift_change_v1": { "current_users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "previous_users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "schedule": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" } } }, "schema": { "$ref": "#/components/schemas/WebhooksScheduleShiftChangeV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Shift V1" ], "summary": "Change (public)" } }, "schedule.updated_v1": { "get": { "description": "This webhook is emitted whenever a schedule's configuration is updated.", "operationId": "ScheduleUpdatedV1", "responses": { "200": { "content": { "application/json": { "example": { "event_type": "schedule.updated_v1", "schedule.updated_v1": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/WebhooksScheduleUpdatedV1ResponseBody" } } }, "description": "OK response." } }, "tags": [ "Updated V1" ], "summary": " (public)" } } }, "components": { "schemas": { "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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_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" }, "WebhooksPrivateAlertResolvedV1ResponseBody": { "example": { "event_type": "private_alert.alert_resolved_v1", "private_alert.alert_resolved_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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_v1" ], "example": "private_alert.alert_resolved_v1", "type": "string" }, "private_alert.alert_resolved_v1": { "$ref": "#/components/schemas/WebhookPrivateResourceV2" } }, "required": [ "event_type", "private_alert.alert_resolved_v1" ], "type": "object" }, "WebhooksPrivateEscalationCreatedV1ResponseBody": { "example": { "event_type": "private_escalation.escalation_created_v1", "private_escalation.escalation_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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_v1" ], "example": "private_escalation.escalation_created_v1", "type": "string" }, "private_escalation.escalation_created_v1": { "$ref": "#/components/schemas/WebhookPrivateResourceV2" } }, "required": [ "event_type", "private_escalation.escalation_created_v1" ], "type": "object" }, "WebhooksPrivateEscalationStatusUpdatedV1ResponseBody": { "example": { "event_type": "private_escalation.escalation_status_updated_v1", "private_escalation.escalation_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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_v1" ], "example": "private_escalation.escalation_status_updated_v1", "type": "string" }, "private_escalation.escalation_status_updated_v1": { "$ref": "#/components/schemas/WebhookPrivateResourceV2" } }, "required": [ "event_type", "private_escalation.escalation_status_updated_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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_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_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_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" }, "WebhooksPublicAlertResolvedV1ResponseBody": { "example": { "event_type": "public_alert.alert_resolved_v1", "public_alert.alert_resolved_v1": { "alert_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_v1" ], "example": "public_alert.alert_resolved_v1", "type": "string" }, "public_alert.alert_resolved_v1": { "$ref": "#/components/schemas/AlertV2" } }, "required": [ "event_type", "public_alert.alert_resolved_v1" ], "type": "object" }, "WebhooksPublicEscalationCreatedV1ResponseBody": { "example": { "event_type": "public_escalation.escalation_created_v1", "public_escalation.escalation_created_v1": { "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_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "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": { "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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_v1" ], "example": "public_escalation.escalation_created_v1", "type": "string" }, "public_escalation.escalation_created_v1": { "$ref": "#/components/schemas/EscalationV2" } }, "required": [ "event_type", "public_escalation.escalation_created_v1" ], "type": "object" }, "WebhooksPublicEscalationStatusUpdatedV1ResponseBody": { "example": { "event_type": "public_escalation.escalation_status_updated_v1", "public_escalation.escalation_status_updated_v1": { "actor": { "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" } }, "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_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "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" }, "new_status": "pending", "previous_status": "pending" } }, "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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_v1" ], "example": "public_escalation.escalation_status_updated_v1", "type": "string" }, "public_escalation.escalation_status_updated_v1": { "$ref": "#/components/schemas/EscalationWithStatusChangeV2" } }, "required": [ "event_type", "public_escalation.escalation_status_updated_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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_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" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_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" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_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" }, "status": "success", "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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_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" }, "status": "success", "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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_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" }, "status": "success", "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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_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" }, "WebhooksScheduleCreatedV1ResponseBody": { "example": { "event_type": "schedule.created_v1", "schedule.created_v1": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_v1" ], "example": "schedule.created_v1", "type": "string" }, "schedule.created_v1": { "$ref": "#/components/schemas/ScheduleSlimV2" } }, "required": [ "event_type", "schedule.created_v1" ], "type": "object" }, "WebhooksScheduleDeletedV1ResponseBody": { "example": { "event_type": "schedule.deleted_v1", "schedule.deleted_v1": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_v1" ], "example": "schedule.deleted_v1", "type": "string" }, "schedule.deleted_v1": { "$ref": "#/components/schemas/ScheduleSlimV2" } }, "required": [ "event_type", "schedule.deleted_v1" ], "type": "object" }, "WebhooksScheduleShiftChangeV1ResponseBody": { "example": { "event_type": "schedule.shift_change_v1", "schedule.shift_change_v1": { "current_users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "previous_users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "schedule": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_v1" ], "example": "schedule.shift_change_v1", "type": "string" }, "schedule.shift_change_v1": { "$ref": "#/components/schemas/ScheduleShiftChangeV2" } }, "required": [ "event_type", "schedule.shift_change_v1" ], "type": "object" }, "WebhooksScheduleUpdatedV1ResponseBody": { "example": { "event_type": "schedule.updated_v1", "schedule.updated_v1": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "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", "public_alert.alert_resolved_v1", "private_alert.alert_resolved_v1", "public_escalation.escalation_created_v1", "private_escalation.escalation_created_v1", "public_escalation.escalation_status_updated_v1", "private_escalation.escalation_status_updated_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", "schedule.shift_change_v1", "schedule.created_v1", "schedule.updated_v1", "schedule.deleted_v1" ], "example": "schedule.updated_v1", "type": "string" }, "schedule.updated_v1": { "$ref": "#/components/schemas/ScheduleSlimV2" } }, "required": [ "event_type", "schedule.updated_v1" ], "type": "object" }, "WebhookPrivateResourceV2": { "example": { "id": "abc123" }, "properties": { "id": { "description": "The ID of the resource", "example": "abc123", "type": "string" } }, "required": [ "id" ], "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" }, "AlertV2": { "properties": { "alert_group_ids": { "description": "The IDs of every alert group this alert belongs to. Empty when the alert is not part of any group.", "example": [ "01GW2G3V0S59R238FAHPDS1R66" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "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" }, "EscalationV2": { "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_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "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" }, "EscalationWithStatusChangeV2": { "example": { "actor": { "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" } }, "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_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "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" }, "new_status": "pending", "previous_status": "pending" }, "properties": { "actor": { "$ref": "#/components/schemas/ActorV2" }, "escalation": { "$ref": "#/components/schemas/EscalationV2" }, "new_status": { "description": "The new status of the escalation", "enum": [ "pending", "triggered", "acked", "resolved", "expired", "cancelled", "snoozed", "delayed", "pending_repeat" ], "example": "pending", "type": "string" }, "previous_status": { "description": "The previous status of the escalation", "enum": [ "pending", "triggered", "acked", "resolved", "expired", "cancelled", "snoozed", "delayed", "pending_repeat" ], "example": "pending", "type": "string" } }, "required": [ "escalation", "new_status" ], "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" }, "FollowUpV2": { "properties": { "assignee": { "$ref": "#/components/schemas/UserV2" }, "assignee_team": { "$ref": "#/components/schemas/TeamSlimV2" }, "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" }, "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" }, "status": "success", "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" }, "status": "success", "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" }, "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" }, "status": "success", "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" }, "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" }, "ScheduleSlimV2": { "example": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "created_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "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" }, "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", "created_at", "updated_at" ], "type": "object" }, "ScheduleShiftChangeV2": { "example": { "current_users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "previous_users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "schedule": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "current_users": { "description": "Users who are now on-call (empty array if shift ending)", "example": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "items": { "$ref": "#/components/schemas/UserV2" }, "type": "array" }, "previous_users": { "description": "Users who were previously on-call (empty array if shift starting)", "example": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "items": { "$ref": "#/components/schemas/UserV2" }, "type": "array" }, "schedule": { "$ref": "#/components/schemas/ScheduleSlimV2" } }, "required": [ "schedule", "previous_users", "current_users" ], "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" }, "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" }, "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" }, "AlertSlimV2": { "example": { "alert_group_ids": [ "01GW2G3V0S59R238FAHPDS1R66" ], "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_group_ids": { "description": "The IDs of every alert group this alert belongs to. Empty when the alert is not part of any group.", "example": [ "01GW2G3V0S59R238FAHPDS1R66" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "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" }, "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" }, "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" }, "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" }, "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" }, "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" }, "TeamSlimV2": { "example": { "id": "abc123", "name": "abc123" }, "properties": { "id": { "description": "Unique ID of the team", "example": "abc123", "type": "string" }, "name": { "description": "Name of the team", "example": "abc123", "type": "string" } }, "required": [ "id", "name" ], "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" }, "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" }, "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" }, "IncidentDurationMetricWithValueV2": { "example": { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "status": "success", "value_seconds": 10800 }, "properties": { "duration_metric": { "$ref": "#/components/schemas/IncidentDurationMetricV2" }, "status": { "description": "Whether value_seconds matches this incident's current timestamps ('success'), or why it doesn't", "enum": [ "success", "timestamps_missing", "calculating", "invalid_timestamps" ], "example": "success", "type": "string" }, "value_seconds": { "description": "The duration we last calculated for this metric, omitted if we've never calculated one. If status isn't 'success', this incident's timestamps have changed since and no longer match this value", "example": 10800, "format": "int64", "type": "integer" } }, "required": [ "duration_metric", "status" ], "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" }, "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" }, "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" }, "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" }, "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" }, "IncidentV2": { "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" }, "status": "success", "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" }, "PostmortemDocumentV1": { "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" }, "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" }, "AlertAttributeV2": { "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" }, "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" }, "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" }, "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" }, "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" }, "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" }, "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" }, "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" }, "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" }, "IncidentTimestampV2": { "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" }, "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" }, "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" }, "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" }, "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" } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "description": "API key from your incident.io dashboard (Settings → API keys)" } } } }