{ "openapi": "3.0.3", "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": [ { "description": "Read the history of your workflow runs.\n\nA workflow run is one execution of a workflow, carrying the progress of every step it ran. Where\na step sent a webhook, that progress also carries the delivery: its outcome, the status code, and\nhow long the request took. Fetch a single run to additionally see the request and response\nheaders and bodies.\n\nRuns on private incidents are returned only to an API key with global incident access.", "name": "Workflow Runs V2" } ], "paths": { "/v2/workflow_runs": { "get": { "description": "List workflow runs, newest first. Cancelled runs are never returned.\n\nThe webhook delivery on each step omits the headers and bodies. Fetch a single run to see them.\n\nYou can filter on when a run was created:\n\n```\n# Runs created on or after a date\ncurl 'https://api.incident.io/v2/workflow_runs?created_at[gte]=2026-07-01'\n\n# Runs created on or before a date\ncurl 'https://api.incident.io/v2/workflow_runs?created_at[lte]=2026-07-31'\n\n# Runs created between two dates\ncurl 'https://api.incident.io/v2/workflow_runs?created_at[date_range]=2026-07-01~2026-07-31'\n```\n\nPaginate by passing the last run's ID as `after`. The response's\n`pagination_meta.after` carries the value to send next, and is absent on the last page.\nAn `after` that isn't a run in your organisation returns 404.", "operationId": "WorkflowRuns V2_List", "parameters": [ { "allowEmptyValue": true, "description": "Unique identifier for the workflow to filter by", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "workflow_id", "schema": { "description": "Unique identifier for the workflow to filter by", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Unique identifier for the incident to filter by", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "incident_id", "schema": { "description": "Unique identifier for the incident to filter by", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter on workflow run created at timestamp. The accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "date_range": [ "2026-07-01~2026-07-31" ] }, "in": "query", "name": "created_at", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on workflow run created at timestamp. The accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "date_range": [ "2026-07-01~2026-07-31" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Number of workflow runs to return per page", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Number of workflow runs to return per page", "example": 25, "format": "int64", "maximum": 50, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "A workflow run's ID. This endpoint will return a list of workflow runs after this ID in relation to the API response order.", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "query", "name": "after", "schema": { "description": "A workflow run's ID. This endpoint will return a list of workflow runs after this ID in relation to the API response order.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 }, "workflow_runs": [ { "cancelled_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "enqueued_at": "2021-08-17T13:28:57.801578Z", "error": "Something went wrong and our engineers have been notified.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_reference": "INC-123", "progress": [ { "completed_at": "2021-08-17T13:28:57.801578Z", "error": "Something went wrong and our engineers have been notified.", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_reference": "INC-123", "status": "complete", "step": "slack.post_message", "webhook_delivery": { "duration_ms": 412, "endpoint": "https://example.com/hooks/incident", "method": "POST", "outcome": "non_2xx", "status_code": 500 }, "webhook_delivery_state": "expired" } ], "scheduled_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z", "workflow_id": "01FCNDV6P870EA6S7TK1DSYDG0", "workflow_name": "Announce incident updates", "workflow_version_id": "01FCNDV6P870EA6S7TK1DSYDG0", "workflow_version_number": 3 } ] }, "schema": { "$ref": "#/components/schemas/WorkflowRunsListResultV2" } } }, "description": "OK response." } }, "summary": "List", "tags": [ "Workflow Runs V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Workflow Runs V2", "x-docs-resource-type": "WorkflowRunV2", "x-mint": { "content": "🔑 Requires the `workflows.view` scope." }, "x-rbac-scopes": [ "workflows.view" ] } }, "/v2/workflow_runs/{id}": { "get": { "description": "Show a single workflow run, including the full webhook delivery for any step that sent one.\n\nA delivery is kept for 7 days. After that `webhook_delivery_state` becomes\n`expired` and the delivery itself is absent: the step still ran and may well have\nsucceeded, so an expired delivery must not be read as a failure.\n\nThis may return a cancelled run, in which case `cancelled_at` is set.", "operationId": "WorkflowRuns V2_Show", "parameters": [ { "description": "Unique identifier for the workflow run", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the workflow run", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "workflow_run": { "cancelled_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "enqueued_at": "2021-08-17T13:28:57.801578Z", "error": "Something went wrong and our engineers have been notified.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_reference": "INC-123", "progress": [ { "completed_at": "2021-08-17T13:28:57.801578Z", "error": "Something went wrong and our engineers have been notified.", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_reference": "INC-123", "status": "complete", "step": "slack.post_message", "webhook_delivery": { "duration_ms": 412, "endpoint": "https://example.com/hooks/incident", "method": "POST", "outcome": "non_2xx", "request": { "body": "{\"incident_id\":\"01FCNDV6P870EA6S7TK1DSYDG0\"}", "body_truncated": false, "headers": { "Content-Type": "application/json" } }, "response": { "body": "{\"error\":\"unprocessable\"}", "body_truncated": false, "headers": { "Content-Type": "application/json" } }, "status_code": 500 }, "webhook_delivery_state": "expired" } ], "scheduled_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z", "workflow_id": "01FCNDV6P870EA6S7TK1DSYDG0", "workflow_name": "Announce incident updates", "workflow_version_id": "01FCNDV6P870EA6S7TK1DSYDG0", "workflow_version_number": 3 } }, "schema": { "$ref": "#/components/schemas/WorkflowRunsShowResultV2" } } }, "description": "OK response." } }, "summary": "Show", "tags": [ "Workflow Runs V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Workflow Runs V2", "x-docs-resource-type": "WorkflowRunV2", "x-mint": { "content": "🔑 Requires the `workflows.view` scope." }, "x-rbac-scopes": [ "workflows.view" ] } } }, "components": { "schemas": { "WorkflowRunsListResultV2": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 }, "workflow_runs": [ { "cancelled_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "enqueued_at": "2021-08-17T13:28:57.801578Z", "error": "Something went wrong and our engineers have been notified.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_reference": "INC-123", "progress": [ { "completed_at": "2021-08-17T13:28:57.801578Z", "error": "Something went wrong and our engineers have been notified.", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_reference": "INC-123", "status": "complete", "step": "slack.post_message", "webhook_delivery": { "duration_ms": 412, "endpoint": "https://example.com/hooks/incident", "method": "POST", "outcome": "non_2xx", "status_code": 500 }, "webhook_delivery_state": "expired" } ], "scheduled_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z", "workflow_id": "01FCNDV6P870EA6S7TK1DSYDG0", "workflow_name": "Announce incident updates", "workflow_version_id": "01FCNDV6P870EA6S7TK1DSYDG0", "workflow_version_number": 3 } ] }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultWithTotalV2" }, "workflow_runs": { "example": [ { "cancelled_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "enqueued_at": "2021-08-17T13:28:57.801578Z", "error": "Something went wrong and our engineers have been notified.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_reference": "INC-123", "progress": [ { "completed_at": "2021-08-17T13:28:57.801578Z", "error": "Something went wrong and our engineers have been notified.", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_reference": "INC-123", "status": "complete", "step": "slack.post_message", "webhook_delivery": { "duration_ms": 412, "endpoint": "https://example.com/hooks/incident", "method": "POST", "outcome": "non_2xx", "status_code": 500 }, "webhook_delivery_state": "expired" } ], "scheduled_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z", "workflow_id": "01FCNDV6P870EA6S7TK1DSYDG0", "workflow_name": "Announce incident updates", "workflow_version_id": "01FCNDV6P870EA6S7TK1DSYDG0", "workflow_version_number": 3 } ], "items": { "$ref": "#/components/schemas/WorkflowRunSlimV2" }, "type": "array" } }, "required": [ "workflow_runs" ], "type": "object" }, "WorkflowRunsShowResultV2": { "example": { "workflow_run": { "cancelled_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "enqueued_at": "2021-08-17T13:28:57.801578Z", "error": "Something went wrong and our engineers have been notified.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_reference": "INC-123", "progress": [ { "completed_at": "2021-08-17T13:28:57.801578Z", "error": "Something went wrong and our engineers have been notified.", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_reference": "INC-123", "status": "complete", "step": "slack.post_message", "webhook_delivery": { "duration_ms": 412, "endpoint": "https://example.com/hooks/incident", "method": "POST", "outcome": "non_2xx", "request": { "body": "{\"incident_id\":\"01FCNDV6P870EA6S7TK1DSYDG0\"}", "body_truncated": false, "headers": { "Content-Type": "application/json" } }, "response": { "body": "{\"error\":\"unprocessable\"}", "body_truncated": false, "headers": { "Content-Type": "application/json" } }, "status_code": 500 }, "webhook_delivery_state": "expired" } ], "scheduled_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z", "workflow_id": "01FCNDV6P870EA6S7TK1DSYDG0", "workflow_name": "Announce incident updates", "workflow_version_id": "01FCNDV6P870EA6S7TK1DSYDG0", "workflow_version_number": 3 } }, "properties": { "workflow_run": { "$ref": "#/components/schemas/WorkflowRunV2" } }, "required": [ "workflow_run" ], "type": "object" }, "PaginationMetaResultWithTotalV2": { "example": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 }, "properties": { "after": { "description": "If provided, pass this as the 'after' param to load the next page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "page_size": { "default": 25, "description": "What was the maximum number of results requested", "example": 25, "format": "int64", "maximum": 250, "type": "integer" }, "total_record_count": { "description": "How many matching records were there in total, if known", "example": 238, "format": "int64", "type": "integer" } }, "required": [ "page_size" ], "type": "object" }, "WorkflowRunSlimV2": { "example": { "cancelled_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "enqueued_at": "2021-08-17T13:28:57.801578Z", "error": "Something went wrong and our engineers have been notified.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_reference": "INC-123", "progress": [ { "completed_at": "2021-08-17T13:28:57.801578Z", "error": "Something went wrong and our engineers have been notified.", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_reference": "INC-123", "status": "complete", "step": "slack.post_message", "webhook_delivery": { "duration_ms": 412, "endpoint": "https://example.com/hooks/incident", "method": "POST", "outcome": "non_2xx", "status_code": 500 }, "webhook_delivery_state": "expired" } ], "scheduled_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z", "workflow_id": "01FCNDV6P870EA6S7TK1DSYDG0", "workflow_name": "Announce incident updates", "workflow_version_id": "01FCNDV6P870EA6S7TK1DSYDG0", "workflow_version_number": 3 }, "properties": { "cancelled_at": { "description": "If the run was cancelled, this is when", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "created_at": { "description": "When the resource was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "enqueued_at": { "description": "When the run was enqueued for execution", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "error": { "description": "Error produced by the workflow, if it failed", "example": "Something went wrong and our engineers have been notified.", "type": "string" }, "id": { "description": "Unique identifier for the workflow run", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_id": { "description": "If this run was against a specific incident, this is the ID of that incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_reference": { "description": "If this run was against a specific incident, this is the reference of that incident", "example": "INC-123", "type": "string" }, "progress": { "description": "Status of each step as it is worked", "example": [ { "completed_at": "2021-08-17T13:28:57.801578Z", "error": "Something went wrong and our engineers have been notified.", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_reference": "INC-123", "status": "complete", "step": "slack.post_message", "webhook_delivery": { "duration_ms": 412, "endpoint": "https://example.com/hooks/incident", "method": "POST", "outcome": "non_2xx", "status_code": 500 }, "webhook_delivery_state": "expired" } ], "items": { "$ref": "#/components/schemas/StepProgressSlimV2" }, "type": "array" }, "scheduled_at": { "description": "When the run was scheduled for", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "updated_at": { "description": "When the resource was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "workflow_id": { "description": "Unique identifier for the underlying workflow", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "workflow_name": { "description": "Name of the underlying workflow", "example": "Announce incident updates", "type": "string" }, "workflow_version_id": { "description": "Unique identifier of the workflow version", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "workflow_version_number": { "description": "Monotonically incrementing version number for the version that ran", "example": 3, "format": "int64", "type": "integer" } }, "required": [ "id", "workflow_id", "workflow_version_id", "workflow_version_number", "progress", "scheduled_at", "created_at", "updated_at" ], "type": "object" }, "WorkflowRunV2": { "properties": { "cancelled_at": { "description": "If the run was cancelled, this is when", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "created_at": { "description": "When the resource was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "enqueued_at": { "description": "When the run was enqueued for execution", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "error": { "description": "Error produced by the workflow, if it failed", "example": "Something went wrong and our engineers have been notified.", "type": "string" }, "id": { "description": "Unique identifier for the workflow run", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_id": { "description": "If this run was against a specific incident, this is the ID of that incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_reference": { "description": "If this run was against a specific incident, this is the reference of that incident", "example": "INC-123", "type": "string" }, "progress": { "description": "Status of each step as it is worked", "example": [ { "completed_at": "2021-08-17T13:28:57.801578Z", "error": "Something went wrong and our engineers have been notified.", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_reference": "INC-123", "status": "complete", "step": "slack.post_message", "webhook_delivery": { "duration_ms": 412, "endpoint": "https://example.com/hooks/incident", "method": "POST", "outcome": "non_2xx", "request": { "body": "{\"incident_id\":\"01FCNDV6P870EA6S7TK1DSYDG0\"}", "body_truncated": false, "headers": { "Content-Type": "application/json" } }, "response": { "body": "{\"error\":\"unprocessable\"}", "body_truncated": false, "headers": { "Content-Type": "application/json" } }, "status_code": 500 }, "webhook_delivery_state": "expired" } ], "items": { "$ref": "#/components/schemas/StepProgressV2" }, "type": "array" }, "scheduled_at": { "description": "When the run was scheduled for", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "updated_at": { "description": "When the resource was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "workflow_id": { "description": "Unique identifier for the underlying workflow", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "workflow_name": { "description": "Name of the underlying workflow", "example": "Announce incident updates", "type": "string" }, "workflow_version_id": { "description": "Unique identifier of the workflow version", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "workflow_version_number": { "description": "Monotonically incrementing version number for the version that ran", "example": 3, "format": "int64", "type": "integer" } }, "required": [ "id", "workflow_id", "workflow_version_id", "workflow_version_number", "progress", "scheduled_at", "created_at", "updated_at" ], "type": "object" }, "StepProgressSlimV2": { "example": { "completed_at": "2021-08-17T13:28:57.801578Z", "error": "Something went wrong and our engineers have been notified.", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_reference": "INC-123", "status": "complete", "step": "slack.post_message", "webhook_delivery": { "duration_ms": 412, "endpoint": "https://example.com/hooks/incident", "method": "POST", "outcome": "non_2xx", "status_code": 500 }, "webhook_delivery_state": "expired" }, "properties": { "completed_at": { "description": "Status of the step", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "error": { "description": "The cause of an errored step", "example": "Something went wrong and our engineers have been notified.", "type": "string" }, "incident_id": { "description": "If this step ran for a specific incident (e.g. in a loop), the incident ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_reference": { "description": "If this step ran for a specific incident (e.g. in a loop), the incident reference", "example": "INC-123", "type": "string" }, "status": { "description": "Status of the step", "enum": [ "complete", "pending", "error" ], "example": "complete", "type": "string" }, "step": { "description": "Name of the step", "example": "slack.post_message", "type": "string" }, "webhook_delivery": { "$ref": "#/components/schemas/WebhookDeliverySlimV2" }, "webhook_delivery_state": { "description": "Whether this step's delivery can be shown, for a webhook.send step. Absent for all other step types", "enum": [ "available", "expired", "unavailable" ], "example": "expired", "type": "string" } }, "required": [ "step", "status" ], "type": "object" }, "StepProgressV2": { "example": { "completed_at": "2021-08-17T13:28:57.801578Z", "error": "Something went wrong and our engineers have been notified.", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_reference": "INC-123", "status": "complete", "step": "slack.post_message", "webhook_delivery": { "duration_ms": 412, "endpoint": "https://example.com/hooks/incident", "method": "POST", "outcome": "non_2xx", "request": { "body": "{\"incident_id\":\"01FCNDV6P870EA6S7TK1DSYDG0\"}", "body_truncated": false, "headers": { "Content-Type": "application/json" } }, "response": { "body": "{\"error\":\"unprocessable\"}", "body_truncated": false, "headers": { "Content-Type": "application/json" } }, "status_code": 500 }, "webhook_delivery_state": "expired" }, "properties": { "completed_at": { "description": "Status of the step", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "error": { "description": "The cause of an errored step", "example": "Something went wrong and our engineers have been notified.", "type": "string" }, "incident_id": { "description": "If this step ran for a specific incident (e.g. in a loop), the incident ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_reference": { "description": "If this step ran for a specific incident (e.g. in a loop), the incident reference", "example": "INC-123", "type": "string" }, "status": { "description": "Status of the step", "enum": [ "complete", "pending", "error" ], "example": "complete", "type": "string" }, "step": { "description": "Name of the step", "example": "slack.post_message", "type": "string" }, "webhook_delivery": { "$ref": "#/components/schemas/WebhookDeliveryV2" }, "webhook_delivery_state": { "description": "Whether this step's delivery can be shown, for a webhook.send step. Absent for all other step types", "enum": [ "available", "expired", "unavailable" ], "example": "expired", "type": "string" } }, "required": [ "step", "status" ], "type": "object" }, "WebhookDeliverySlimV2": { "example": { "duration_ms": 412, "endpoint": "https://example.com/hooks/incident", "method": "POST", "outcome": "non_2xx", "status_code": 500 }, "properties": { "duration_ms": { "description": "Time taken by the request, in milliseconds", "example": 412, "format": "int64", "type": "integer" }, "endpoint": { "description": "The interpolated URL the request was sent to. Redirects are followed, so this is the URL requested rather than the URL that ultimately served it", "example": "https://example.com/hooks/incident", "type": "string" }, "method": { "description": "HTTP method used for the request", "example": "POST", "type": "string" }, "outcome": { "description": "The result of the delivery attempt. Only success and non_2xx have a response", "enum": [ "success", "non_2xx", "timeout", "unreachable", "network_error", "tls_error" ], "example": "non_2xx", "type": "string" }, "status_code": { "description": "HTTP status code returned by the endpoint. Absent when no response was received", "example": 500, "format": "int64", "type": "integer" } }, "required": [ "outcome", "method", "endpoint" ], "type": "object" }, "WebhookDeliveryV2": { "example": { "duration_ms": 412, "endpoint": "https://example.com/hooks/incident", "method": "POST", "outcome": "non_2xx", "request": { "body": "{\"incident_id\":\"01FCNDV6P870EA6S7TK1DSYDG0\"}", "body_truncated": false, "headers": { "Content-Type": "application/json" } }, "response": { "body": "{\"error\":\"unprocessable\"}", "body_truncated": false, "headers": { "Content-Type": "application/json" } }, "status_code": 500 }, "properties": { "duration_ms": { "description": "Time taken by the request, in milliseconds", "example": 412, "format": "int64", "type": "integer" }, "endpoint": { "description": "The interpolated URL the request was sent to. Redirects are followed, so this is the URL requested rather than the URL that ultimately served it", "example": "https://example.com/hooks/incident", "type": "string" }, "method": { "description": "HTTP method used for the request", "example": "POST", "type": "string" }, "outcome": { "description": "The result of the delivery attempt. Only success and non_2xx have a response", "enum": [ "success", "non_2xx", "timeout", "unreachable", "network_error", "tls_error" ], "example": "non_2xx", "type": "string" }, "request": { "$ref": "#/components/schemas/WebhookDeliveryRequestV2" }, "response": { "$ref": "#/components/schemas/WebhookDeliveryResponseV2" }, "status_code": { "description": "HTTP status code returned by the endpoint. Absent when no response was received", "example": 500, "format": "int64", "type": "integer" } }, "required": [ "outcome", "method", "endpoint", "request" ], "type": "object" }, "WebhookDeliveryRequestV2": { "example": { "body": "{\"incident_id\":\"01FCNDV6P870EA6S7TK1DSYDG0\"}", "body_truncated": false, "headers": { "Content-Type": "application/json" } }, "properties": { "body": { "description": "The interpolated request body", "example": "{\"incident_id\":\"01FCNDV6P870EA6S7TK1DSYDG0\"}", "type": "string" }, "body_truncated": { "description": "Whether the body was truncated, in which case it may not be valid JSON", "example": false, "type": "boolean" }, "headers": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Headers sent with the request, including those added automatically. Values interpolated from a secret are replaced with [secret], and the signature header is always redacted", "example": { "Content-Type": "application/json" }, "type": "object" } }, "required": [ "headers", "body_truncated" ], "type": "object" }, "WebhookDeliveryResponseV2": { "example": { "body": "{\"error\":\"unprocessable\"}", "body_truncated": false, "headers": { "Content-Type": "application/json" } }, "properties": { "body": { "description": "The response body returned by the endpoint", "example": "{\"error\":\"unprocessable\"}", "type": "string" }, "body_truncated": { "description": "Whether the body was truncated, in which case it may not be valid JSON", "example": false, "type": "boolean" }, "headers": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Headers returned by the endpoint, excluding any whose name resembles a credential", "example": { "Content-Type": "application/json" }, "type": "object" } }, "required": [ "headers", "body_truncated" ], "type": "object" } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "description": "API key from your incident.io dashboard (Settings → API keys)" } } } }