{ "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": "Manage API keys for your organization.\n\nThis API lets you view, create, update, delete, and rotate API keys programmatically, including configuring account-level roles and roles scoped to specific teams.\n\nCommon use cases include:\n- **API key rotation**: You can issue a new access token for any API key using the `Rotate` endpoint.\n- **Managing keys at scale**: use the `Show`, `List`, `Create`, `Update`, and `Delete` endpoints to automate API key lifecycle management.\n\n## Permissions model\n\nTo use these endpoints, your API key must have the `api_keys_manage` role granted at either the account level or for specific teams.\n\nIn addition, the following rules apply, when a \"caller\" API key is managing a \"target\" API key:\n\n- A caller key can only assign roles whose scopes are a subset of its own scopes. For example, a key with `viewer` and `incident_creator` can assign those roles to a target key, but cannot assign the `incident_editor` role, since it has additional scopes.\n- The same applies at the team level: A caller key with `schedules_editor` at the account level can create a target key with that role for a specific team, but a key with `schedules_editor` only for one team (Team A, say) cannot assign it at the account level or for another team, Team B.\n- The `api_keys_manage` role cannot be assigned via the API. To create a key with that role, you must go to Settings → API keys in the dashboard, and click \"Add new\", creating a key with the \"View, create, edit, delete or rotate API keys\" role (`api_keys_manage`).\n- The `Delete` endpoint does not check whether the calling API key holds the scopes of the key being deleted. However, a team-scoped key can only delete keys belonging to its teams.\n- To rotate the token of an API key, use the Rotate endpoint or by clicking \"Rotate token\" on any API key listed in the dashboard. The same permissions limitations apply as when creating or updating an API key.\n\n## Finding role names and team IDs\n\nTo find valid values for `role_names`, `team_ids`, and `team_role_names`, go to Settings → API keys in the dashboard. Click to either edit an existing key or create a new one, select the desired roles and teams, and then use the copy button to get hold of the role and team identifiers as JSON.", "name": "API Keys V1" }, { "description": "Manage incident actions.\n\nIncident actions are used during an incident, to track work such as 'restart the database' or 'contact the customer'.\n\nYou can manage actions in the incident Slack channel with /incident actions, or on\nthe incident homepage.\n", "name": "Actions V3" }, { "description": "View and manage alert attributes.\n\nAlert attributes are used to parse structured data from alerts coming in via alert sources.", "name": "Alert Attributes V2" }, { "description": "Create alerts within incident.io.\n\nThe alerts API allows you to create alerts within incident.io by posting alert events. You\ncan use alerts to automatically trigger incidents.\n\nTo create an alert, you must first configure an alert source in the incident.io dashboard.\n", "name": "Alert Events V2" }, { "description": "Manage notes attached to alerts.\n\nNotes let your team capture context, decisions, and investigation findings against\nan individual alert without needing to declare an incident.\n\nNote content is stored and returned as Markdown. The following formatting is\nsupported:\n\n- **Headings** (`#`, `##`, `###`)\n- **Bold** and *italic* text formatting\n- ~~Strikethrough~~ text\n- Inline `code` and fenced code blocks\n- Bullet lists and numbered lists\n- Blockquotes\n- [Links](url) using Markdown link syntax — bare URLs are not auto-linked\n- Tables (GitHub-flavoured Markdown)\n- Horizontal rules (`---`)\n\nRaw HTML, image syntax (`![alt](url)`), task lists, and footnotes are not\nsupported, and will be stripped or rendered as plain text.\n", "name": "Alert Notes V1" }, { "description": "Configure your alert routes in incident.io.\n\nAlert routes define how alerts from different sources are processed, grouped, and routed to the right teams and people.", "name": "Alert Routes V3" }, { "description": "Configure your alert sources in incident.io.\n\nAlert sources are the systems that send alerts to incident.io, which can then be routed to the right people and teams.", "name": "Alert Sources V2" }, { "description": "Read your alerts in incident.io.\n\nAlerts are events ingested from third parties by alert sources. They can trigger incidents and escalations, as configured in alert routes.\nTo view your alerts, you can list all alerts, or show a single alert. \nIf you'd like to view only alerts that are currently firing, you can filter by status. \nTo view the alert that was created for an event in your external system, filter by deduplication key. \n\nIf you'd like to view alerts connected to a particular incident, you can list incident alerts. You can filter by incident_id to find all alerts attached to a particular incident, or by alert_id to find the incident that a particular alert triggered. \n", "name": "Alerts V2" }, { "description": "View and manage call routes: phone numbers your customers can call to\nreach whoever is on call.\n\nUse these endpoints to read how a route is configured, and to change who it\npages, the language it speaks to callers, and which number responders see when\nit calls them.\n\nList and edit call routes here. Create and delete them in the dashboard.", "name": "Call Routes V2" }, { "description": "List Scribe call sessions.\n\nCall sessions are the individual meetings Scribe attended: several can accumulate\nover time. Use this endpoint together with Call Transcript Entries to export what\nScribe transcribed during each session.", "name": "Call Sessions V2" }, { "description": "List the transcript entries Scribe captured during a call session.\n\nEntries are returned oldest first, ordered by when each participant started\nspeaking. To export a full transcript, page through with 'page_size' and 'after'\nuntil the response no longer includes a 'pagination_meta.after' value.", "name": "Call Transcript Entries V2" }, { "description": "Manage and browse catalog resources.\n\nUse the incident.io catalog to track services, teams, product features and anything\nelse that helps build a map of your organisation. These different categories of thing\nbecome catalog types, and each instance (like a particular service or team) is a\ncatalog entry.\n\nEach type is made up of a series of attributes, and each attribute has a type. Types\ncan even have attributes that refer to other catalog types.\n\nWe automatically create catalog types when you connect an integration, such as GitHub\nrepositories or PagerDuty services and teams. You can use this API to create custom\ntypes, that are specifically tailored to your organisation.\n\nExamples might be a 'Service' type with an 'Alert channel' which you can point at a\nSlack channel, or 'Team' which specifies its 'Manager' and 'Technical Lead' as Slack\nusers. You can then use these types to create powerful new workflows.\n\nConsider using our official [catalog importer](https://github.com/incident-io/catalog-importer).\nIt can be used to sync catalog data from sources like local files or GitHub and push\nthem into the incident.io catalog without having to directly interact with our public API.\n", "name": "Catalog V3" }, { "description": "Manage custom field options.\n\nSingle- and multi-select custom fields have a list of all available options,\nwhich have a value, and a sort key. The value must be unique to the custom\nfield. For example, you might have an Incident Type custom field, with options\n\"Data breach\", \"Performance degradation\", \"API downtime\", etc.", "name": "Custom Field Options V1" }, { "description": "Manage custom fields.\n\nCustom fields are used to attach metadata to incidents, which you can use when searching\nfor incidents in the dashboard, triggering workflows, building announcement rules or for\nyour own data needs.\n\nEach field has a type:\n\n- Single-select, single value selected from a predefined list of options (e.g. Detection Method)\n- Multi-select, as above but you can pick more than one option (e.g. Affected Teams)\n- Text, freeform text field (e.g. Customer ID)\n- Link, link URL that is synced to Slack bookmarks on the incident channel (e.g. External Status Page)\n- Number, integer or fractional numbers (e.g. # Customers Affected)\n\nWe may add more custom field types in the future - we'd love to hear any other types you'd like to use!\n", "name": "Custom Fields V2" }, { "description": "Create and manage reusable, parameterised escalation path templates.\n\nAn escalation path template declares parameters and a binding-aware path. Escalation\npaths built from a template bind those parameters to concrete values.\n", "name": "Escalation Path Templates V2" }, { "description": "Create and manage escalation paths, and create, list, filter and respond to escalations.\n\nWith incident.io On-call you can create escalation paths that describe how a page should\nbe escalated to people and schedules.\n", "name": "Escalations V2" }, { "description": "Manage incident follow-ups.\n\nIncidents can have follow-ups associated with them, which track work that should be done\nafter an incident (e.g. improving some documentation, or upgrading a dependency). They can\nalso be exported to external issue trackers.\n\nYou can manage follow-ups in the incident Slack channel with /incident follow-ups, or on\nthe incident homepage.\n", "name": "Follow-ups V3" }, { "description": "Send heartbeat pings for dead man's switch monitoring.\n\nHeartbeat alert sources expect periodic pings. If pings stop arriving, alerts\nfire automatically. Use the ping endpoints to signal that your job or service\nis still healthy.\n", "name": "Heartbeat V2" }, { "description": "Manage the IP allowlist.\n\nWhen enabled, the IP allowlist restricts authenticated traffic from the dashboard, public API and mobile app.", "name": "IPAllowlists V1" }, { "description": "Read everything that happened on an incident.\n\nThe activity log is the full record: every status change, role handover, escalation, field\nedit and update, in the order they happened. Some of it gets promoted onto the incident's\ntimeline, which also carries items written by hand that never appear here.\n\nUse this to pull an incident's history into your own systems - a retrospective, a report, an\naudit of how a response ran.\n", "name": "Incident Activity Log Entries V2" }, { "description": "Create, list and delete incident attachments.\n\nIncident Attachments allows you to connect resources from external systems into incidents.\nExamples include: PagerDuty incidents and GitHub pull requests.\n", "name": "Incident Attachments V1" }, { "description": "Manage private incident memberships", "name": "Incident Memberships V1" }, { "description": "View related incidents for an incident", "name": "Incident Relationships V1" }, { "description": "Manage incident roles.\n\nDuring an incident, you can assign responders to one of the incident roles that are\nconfigured in your organisation settings.\n\nEvery organisation will have a special 'lead' role, which signifies the incident lead or\ncommander. This role cannot be deleted, but can be renamed in the incident.io dashboard.\n", "name": "Incident Roles V2" }, { "description": "Manage incident statuses.\n\nEach incident has a status, picked from one of the statuses configured in your\norganisations settings.\n\nStatuses help communicate where an incident is in its lifecycle. You can use\nstatuses when filtering incidents in the dashboard, and in workflows and announcement\nrules.\n", "name": "Incident Statuses V1" }, { "description": "Manage incident templates: reusable sets of values applied to incidents created from alerts.", "name": "Incident Templates V1" }, { "description": "Read and write the items on an incident's timeline.\n\nThe timeline is the curated narrative of an incident: the handful of moments that explain what\nhappened, rather than the activity log, which records everything that did. Items are either\npromoted or custom. Promoted items are activity lifted onto the timeline - a pinned message,\nan escalation, an incident update, an event added by a workflow - and carry the ID of the\nactivity log entry they came from. Custom items are written by hand, in the dashboard or\nthrough this API, and have no activity_log_id.\n\nUse this to pull an incident's narrative into your own systems - a retrospective template, a\nreport, a record you keep outside incident.io - and to put the things you know about back on\nit, like a deploy, a config change or a load test you halted.\n", "name": "Incident Timeline Items V2" }, { "description": "View incident timestamps.\n\nEach incident has a number of timestamps; some being defaults that we set on\neach incident for you, and other being configured for your organisation within\nsettings.\n\nTimestamps help to communicate when a given action was taken for a specific\nincident, for example when it was reported, closed or fixed.\n", "name": "Incident Timestamps V2" }, { "description": "View incident types.\n\nWith incident types enabled, you can tailor your process to the situation you're\nresponding to with different custom fields and roles for each incident type.\n", "name": "Incident Types V1" }, { "description": "List and create incident updates.\n\nIncident Updates allows you to see all the updates that have been shared against a\nparticular incident. This will include any time that the Severity or Status of\nan incident changed, alongside any additional updates that were provided.\n", "name": "Incident Updates V2" }, { "description": "Read how much time each participant has spent working on an incident.", "name": "IncidentParticipantWorkloads V2" }, { "description": "Read who participated in an incident and the role they took.", "name": "IncidentParticipants V2" }, { "description": "Create and read incidents.\n\nIncidents are a core resource, on which many other resources (actions, etc) are created.\n\nCare should be taken around these endpoints, as automation that creates duplicate\nincidents can be distracting, and impact reporting.\n", "name": "Incidents V2" }, { "description": "Manage maintenance windows for temporarily overriding alert routing during planned maintenance.\n\nMaintenance windows allow you to suppress or redirect alerts during scheduled maintenance periods, preventing unnecessary escalations and noise.", "name": "MaintenanceWindows V1" }, { "description": "Manage the policies that encode how your organisation should handle incidents.\n\nA policy scopes itself to a set of resources with conditions, states the requirements\nthose resources must meet, and describes who to chase when they don't.\n\nEvery policy has a policy_type, which selects exactly one matching\nconfiguration block: a follow_up policy carries follow_up\nconfig, a schedule policy carries schedule config, and so\non. Sending a block that doesn't match the policy type is rejected.\n", "name": "Policies V2" }, { "description": "View and manage the findings your policies raise.\n\nA finding records that a resource fell short of a policy: a follow-up that was\nnever exported, a schedule with a gap in cover, a user without the notification\nrules their on-call policy requires.\n\nFindings are materialised by a job that runs hourly, so every finding carries a\nlast_checked_at telling you how fresh it is.\n", "name": "Policy Findings V2" }, { "description": "Manage post-mortem documents.\n\nPost-mortem documents capture the learnings from an incident, and are associated with a specific\nincident. Use this API to list and retrieve post-mortem documents, update their status, and fetch\nthe full document's content.\n", "name": "PostmortemDocuments V1" }, { "description": "Manage schedule sync targets (Slack user groups that schedules can sync to).", "name": "Schedule Sync Targets V2" }, { "description": "View and manage schedules.\nManage your full schedule of on-call rotations, including the users and rotation configuration.\n", "name": "Schedules V2" }, { "description": "Manage secrets: named credentials that workflows can reference. A secret's value can be set and rotated but is never returned by the API.", "name": "Secrets V2" }, { "description": "Manage incident severities.\n\nEach incident has a severity, picked from one of the severities configured in your\norganisations settings.\n\nSeverities help categorise incidents, and communicate urgency/impact. You can use\nseverities when filtering incidents in the dashboard, and in workflows and announcement\nrules.\n", "name": "Severities V1" }, { "description": "This API currently only allows linked Response incidents for a status page incident to be listed.", "name": "Status Pages V1" }, { "description": "Manage and publish to status pages.\n\nBefore using these endpoints, you must create a status page in the incident.io dashboard (find Status Pages in the left navigation bar). You can then use the ListStatusPages endpoint to find your status page IDs, and the ShowStatusPageStructure endpoint to find component IDs and group IDs for your status page.\n\nFor read-only access (listing status pages, viewing structure, incidents, and maintenance windows), any valid API key will work. For write requests (creating incidents, maintenance windows, and publishing updates), you will need an API key with the \"Create status page incidents, status page maintenance windows, and publish status page updates\" scope.\n", "name": "Status Pages V2" }, { "description": "Manage teams.\n\nTeams are groups of users that can be associated with incidents, escalation paths, and other\nresources. Teams are built on top of catalog entries, allowing you to enrich them with\ncustom attributes.\n", "name": "Teams V3" }, { "description": "Manage telemetry data source integrations.", "name": "Telemetry V2" }, { "description": "View users.\n\nUsers all have a single base role, and can be assigned multiple custom roles. They can be managed via your Slack workspace or SAML provider.\n", "name": "Users V2" }, { "description": "Miscelaneous utility endpoints.\n\nCollection of utility functions that can help build integrations against this API.\n", "name": "Utilities V1" }, { "description": "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": "WorkflowRuns V2" }, { "description": "Manage workflows.\n\nWorkflows allow you to automate certain actions and behaviors based on specific triggers.", "name": "Workflows V2" } ], "paths": { "/v3/actions": { "get": { "description": "List actions for an organisation.\n\nResults are paginated and ordered by action ID, oldest first. Use the after\nvalue from pagination_meta to fetch the next page; it is only set when there\nmay be more results.\n\n### By created_at and updated_at\n\nBoth timestamp filters accept the operators \"gte\" (greater than or equal to), \"lte\" (less\nthan or equal to) and \"date_range\" (between two dates). The following example finds all\nactions updated after 2025-01-01:\n\n```bash\ncurl --get 'https://api.incident.io/v3/actions' \\\n--data 'updated_at[gte]=2025-01-01T00:00:00Z'\n```\n\nTo find actions created within a specific date range, use the date_range operator with\ntilde-separated dates:\n\n```bash\ncurl --get 'https://api.incident.io/v3/actions' \\\n--data 'created_at[date_range]=2024-12-02~2024-12-08'\n```\n\nFiltering on updated_at is useful for incrementally syncing actions: poll with\nupdated_at[gte] set to your last sync time instead of re-fetching the full history. Two\ncaveats: updated_at moves whenever the action row itself is written, but changes to\nembedded objects (e.g. an assignee being renamed) can alter the payload without bumping\nit. And timestamps are stamped before commit, so an action can become visible with an\nolder updated_at than rows you have already seen — overlap your sync window by a few\nminutes to allow for writes that commit out of timestamp order.\n", "operationId": "Actions V3_List", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "An action's ID. This endpoint will return a list of actions after this ID in relation to the API response order.", "examples": { "default": { "summary": "default", "value": "01FDAG4SAP5TYPT98WGR2N7W91" } }, "in": "query", "name": "after", "schema": { "description": "An action's ID. This endpoint will return a list of actions after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "allowEmptyValue": true, "description": "Find actions related to this incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "incident_id", "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter to actions from incidents of the given mode. If not set, only actions from `standard` and `retrospective` incidents are returned", "example": "standard", "in": "query", "name": "incident_mode", "schema": { "description": "Filter to actions from incidents of the given mode. If not set, only actions from `standard` and `retrospective` incidents are returned", "enum": [ "standard", "retrospective", "test", "tutorial", "stream" ], "example": "standard", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter on action created at timestamp. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2025-01-01" ] }, "in": "query", "name": "created_at", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on action created at timestamp. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2025-01-01" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on action updated at timestamp. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2025-01-01" ] }, "in": "query", "name": "updated_at", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on action updated at timestamp. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2025-01-01" ] }, "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "example": { "actions": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/ActionsListResultV3" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Actions V3" ], "x-docs-display-name": "List", "x-docs-group-name": "Actions V3", "x-docs-resource-type": "ActionV3", "x-mint": { "content": "🔑 Requires the `actions.view` scope." }, "x-rbac-scopes": [ "actions.view" ] }, "post": { "description": "Create a new incident action.", "operationId": "Actions V3_Create", "requestBody": { "content": { "application/json": { "example": { "assignee_id": "01FCNDV6P870EA6S7TK1DSYDG0", "description": "Call the fire brigade", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H" }, "schema": { "$ref": "#/components/schemas/ActionsCreatePayloadV3" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "action": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/ActionsCreateResultV3" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Actions V3" ], "x-docs-display-name": "Create", "x-docs-group-name": "Actions V3", "x-docs-resource-type": "ActionV3", "x-mint": { "content": "🔑 Requires the `actions.create` scope." }, "x-rbac-scopes": [ "actions.create" ] } }, "/v3/actions/{id}": { "delete": { "description": "Delete an incident action.", "operationId": "Actions V3_Delete", "parameters": [ { "description": "Unique identifier for the action", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "path", "name": "id", "required": true, "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Actions V3" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Actions V3", "x-docs-resource-type": "ActionV3", "x-mint": { "content": "🔑 Requires the `actions.destroy` scope." }, "x-rbac-scopes": [ "actions.destroy" ] }, "get": { "description": "Get a single incident action.", "operationId": "Actions V3_Show", "parameters": [ { "description": "Unique identifier for the action", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "path", "name": "id", "required": true, "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "action": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/ActionsShowResultV3" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Actions V3" ], "x-docs-display-name": "Show", "x-docs-group-name": "Actions V3", "x-docs-resource-type": "ActionV3", "x-mint": { "content": "🔑 Requires the `actions.view` scope." }, "x-rbac-scopes": [ "actions.view" ] }, "put": { "description": "Update an existing incident action.", "operationId": "Actions V3_Update", "parameters": [ { "description": "Unique identifier for the action", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "path", "name": "id", "required": true, "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "assignee_id": "01FCNDV6P870EA6S7TK1DSYDG0", "description": "Call the fire brigade", "status": "outstanding" }, "schema": { "$ref": "#/components/schemas/ActionsUpdatePayloadV3" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "action": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/ActionsUpdateResultV3" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Actions V3" ], "x-docs-display-name": "Update", "x-docs-group-name": "Actions V3", "x-docs-resource-type": "ActionV3", "x-mint": { "content": "🔑 Requires the `actions.update` scope." }, "x-rbac-scopes": [ "actions.update" ] } }, "/v2/alert_attributes": { "get": { "description": "List alert attributes.", "operationId": "Alert Attributes V2_List", "responses": { "200": { "content": { "application/json": { "example": { "alert_attributes": [ { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" } ] }, "schema": { "$ref": "#/components/schemas/AlertAttributesListResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Alert Attributes V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Alert Attributes V2", "x-docs-resource-type": "AlertAttributeV2", "x-mint": { "content": "🔑 Requires the `alert_schema.view` scope." }, "x-rbac-scopes": [ "alert_schema.view" ] }, "post": { "description": "Create a new alert attribute.", "operationId": "Alert Attributes V2_Create", "requestBody": { "content": { "application/json": { "example": { "array": false, "emoji": "fire", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "schema": { "$ref": "#/components/schemas/AlertAttributesCreatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "alert_attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" } }, "schema": { "$ref": "#/components/schemas/AlertAttributesCreateResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Alert Attributes V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Alert Attributes V2", "x-docs-resource-type": "AlertAttributeV2", "x-mint": { "content": "🔑 Requires the `alert_schema.update` scope." }, "x-rbac-scopes": [ "alert_schema.update" ] } }, "/v2/alert_attributes/{id}": { "delete": { "description": "Destroy an alert attribute.", "operationId": "Alert Attributes V2_Destroy", "parameters": [ { "description": "The ID of this attribute", "example": "01GW2G3V0S59R238FAHPDS1R66", "in": "path", "name": "id", "required": true, "schema": { "description": "The ID of this attribute", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Alert Attributes V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Alert Attributes V2", "x-docs-resource-type": "AlertAttributeV2", "x-mint": { "content": "🔑 Requires the `alert_schema.update` scope." }, "x-rbac-scopes": [ "alert_schema.update" ] }, "get": { "description": "Show an alert attribute.", "operationId": "Alert Attributes V2_Show", "parameters": [ { "description": "The ID of this attribute", "example": "01GW2G3V0S59R238FAHPDS1R66", "in": "path", "name": "id", "required": true, "schema": { "description": "The ID of this attribute", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "alert_attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" } }, "schema": { "$ref": "#/components/schemas/AlertAttributesShowResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Alert Attributes V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Alert Attributes V2", "x-docs-resource-type": "AlertAttributeV2", "x-mint": { "content": "🔑 Requires the `alert_schema.view` scope." }, "x-rbac-scopes": [ "alert_schema.view" ] }, "put": { "description": "Update an alert attribute.", "operationId": "Alert Attributes V2_Update", "parameters": [ { "description": "The ID of this attribute", "example": "01GW2G3V0S59R238FAHPDS1R66", "in": "path", "name": "id", "required": true, "schema": { "description": "The ID of this attribute", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "array": false, "emoji": "fire", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "schema": { "$ref": "#/components/schemas/AlertAttributesUpdatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "alert_attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" } }, "schema": { "$ref": "#/components/schemas/AlertAttributesUpdateResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Alert Attributes V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Alert Attributes V2", "x-docs-resource-type": "AlertAttributeV2", "x-mint": { "content": "🔑 Requires the `alert_schema.update` scope." }, "x-rbac-scopes": [ "alert_schema.update" ] } }, "/v2/alert_events/http/{alert_source_config_id}": { "post": { "description": "Create an alert event using an HTTP source.", "operationId": "Alert Events V2_CreateHTTP", "parameters": [ { "allowEmptyValue": true, "description": "Token used to authenticate the request, generated when configuring the alert source. Will be consumed via a URL query string parameter", "example": "some-random-string", "in": "query", "name": "token", "schema": { "description": "Token used to authenticate the request, generated when configuring the alert source. Will be consumed via a URL query string parameter", "example": "some-random-string", "type": "string" } }, { "description": "Which alert source config produced this alert", "examples": { "default": { "summary": "default", "value": "01GW2G3V0S59R238FAHPDS1R66" } }, "in": "path", "name": "alert_source_config_id", "required": true, "schema": { "description": "Which alert source config produced this alert", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" } }, { "allowEmptyValue": true, "description": "Whatever is provided in the Authorization header. We support either Basic or Bearer authorization with the secret provided on the alert source.", "example": "some-random-string", "in": "header", "name": "authorization", "schema": { "description": "Whatever is provided in the Authorization header. We support either Basic or Bearer authorization with the secret provided on the alert source.", "example": "some-random-string", "type": "string" } }, { "description": "Query parameters", "in": "query", "name": "query", "schema": { "additionalProperties": true, "type": "object" }, "style": "deepObject" } ], "requestBody": { "content": { "application/json": { "example": { "deduplication_key": "4293868629", "description": "We've detected a number of timeouts on hello.world.com, the service may be down. To fix...", "metadata": { "service": "hello.world.com", "team": [ "my-team" ] }, "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect" }, "schema": { "$ref": "#/components/schemas/AlertEventsCreateHTTPPayloadV2" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "example": { "deduplication_key": "unique-key", "message": "Event accepted for processing", "status": "success" }, "schema": { "$ref": "#/components/schemas/AlertEventsCreateHTTPResultV2" } } }, "description": "Accepted response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Alert Events V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Alert Events V2", "x-docs-resource-type": "AlertResultV2" } }, "/v1/alert_notes": { "get": { "description": "List alert notes attached to an alert.", "operationId": "Alert Notes V1_List", "parameters": [ { "allowEmptyValue": true, "description": "ID of the alert to list notes for. Provide exactly one of alert_id or alert_group_id.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "alert_id", "schema": { "description": "ID of the alert to list notes for. Provide exactly one of alert_id or alert_group_id.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "ID of the alert group to list notes for. Provide exactly one of alert_id or alert_group_id.", "example": "01HB9Z8WANK6P870EA6S7TK1DS", "in": "query", "name": "alert_group_id", "schema": { "description": "ID of the alert group to list notes for. Provide exactly one of alert_id or alert_group_id.", "example": "01HB9Z8WANK6P870EA6S7TK1DS", "type": "string" } }, { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "alert_notes": [ { "alert_group_id": "01HB9Z8WANK6P870EA6S7TK1DS", "alert_id": "01FCNDV6P870EA6S7TK1DSYDG0", "content": "Customer reports **checkout 500s** starting ~14:32 UTC. Investigating `payments-api`.\n\n- Error rate: ~12% on `/checkout`\n- Region: `eu-west-1`\n- See [dashboard](https://grafana.example.com/d/abc)\n", "created_at": "2026-05-28T15:30:00Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01J1X9J85C7Y12G8P8W8K55Q5Y", "images": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "url": "https://storage.googleapis.com/incident-io/images/..." } ], "last_edited_at": "2026-05-28T15:35:00Z", "updated_at": "2026-05-28T15:35:00Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/AlertNotesListResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Alert Notes V1" ], "x-docs-display-name": "List", "x-docs-group-name": "Alert Notes V1", "x-docs-resource-type": "AlertNoteV1", "x-mint": { "content": "🔑 Requires the `alerts.view` scope." }, "x-rbac-scopes": [ "alerts.view" ] }, "post": { "description": "Add a note to an alert.", "operationId": "Alert Notes V1_Create", "requestBody": { "content": { "application/json": { "example": { "alert_group_id": "01HB9Z8WANK6P870EA6S7TK1DS", "alert_id": "01FCNDV6P870EA6S7TK1DSYDG0", "content": "Customer reports **checkout 500s** starting ~14:32 UTC. Investigating `payments-api`.\n\n- Error rate: ~12% on `/checkout`\n- Region: `eu-west-1`\n- See [dashboard](https://grafana.example.com/d/abc)\n" }, "schema": { "$ref": "#/components/schemas/AlertNotesCreatePayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "alert_note": { "alert_group_id": "01HB9Z8WANK6P870EA6S7TK1DS", "alert_id": "01FCNDV6P870EA6S7TK1DSYDG0", "content": "Customer reports **checkout 500s** starting ~14:32 UTC. Investigating `payments-api`.\n\n- Error rate: ~12% on `/checkout`\n- Region: `eu-west-1`\n- See [dashboard](https://grafana.example.com/d/abc)\n", "created_at": "2026-05-28T15:30:00Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01J1X9J85C7Y12G8P8W8K55Q5Y", "images": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "url": "https://storage.googleapis.com/incident-io/images/..." } ], "last_edited_at": "2026-05-28T15:35:00Z", "updated_at": "2026-05-28T15:35:00Z" } }, "schema": { "$ref": "#/components/schemas/AlertNotesCreateResultV1" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Alert Notes V1" ], "x-docs-display-name": "Create", "x-docs-group-name": "Alert Notes V1", "x-docs-resource-type": "AlertNoteV1", "x-mint": { "content": "🔑 Requires the `alerts.edit` scope." }, "x-rbac-scopes": [ "alerts.edit" ] } }, "/v1/alert_notes/{id}": { "delete": { "description": "Delete an alert note.", "operationId": "Alert Notes V1_Delete", "parameters": [ { "description": "Unique identifier for the alert note", "example": "01J1X9J85C7Y12G8P8W8K55Q5Y", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the alert note", "example": "01J1X9J85C7Y12G8P8W8K55Q5Y", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Alert Notes V1" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Alert Notes V1", "x-docs-resource-type": "AlertNoteV1", "x-mint": { "content": "🔑 Requires the `alerts.edit` scope." }, "x-rbac-scopes": [ "alerts.edit" ] }, "get": { "description": "Get a single alert note.", "operationId": "Alert Notes V1_Show", "parameters": [ { "description": "Unique identifier for the alert note", "example": "01J1X9J85C7Y12G8P8W8K55Q5Y", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the alert note", "example": "01J1X9J85C7Y12G8P8W8K55Q5Y", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "alert_note": { "alert_group_id": "01HB9Z8WANK6P870EA6S7TK1DS", "alert_id": "01FCNDV6P870EA6S7TK1DSYDG0", "content": "Customer reports **checkout 500s** starting ~14:32 UTC. Investigating `payments-api`.\n\n- Error rate: ~12% on `/checkout`\n- Region: `eu-west-1`\n- See [dashboard](https://grafana.example.com/d/abc)\n", "created_at": "2026-05-28T15:30:00Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01J1X9J85C7Y12G8P8W8K55Q5Y", "images": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "url": "https://storage.googleapis.com/incident-io/images/..." } ], "last_edited_at": "2026-05-28T15:35:00Z", "updated_at": "2026-05-28T15:35:00Z" } }, "schema": { "$ref": "#/components/schemas/AlertNotesShowResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Alert Notes V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "Alert Notes V1", "x-docs-resource-type": "AlertNoteV1", "x-mint": { "content": "🔑 Requires the `alerts.view` scope." }, "x-rbac-scopes": [ "alerts.view" ] }, "put": { "description": "Replace the content of an alert note.", "operationId": "Alert Notes V1_Update", "parameters": [ { "description": "ID of the alert note", "example": "01J1X9J85C7Y12G8P8W8K55Q5Y", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of the alert note", "example": "01J1X9J85C7Y12G8P8W8K55Q5Y", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "content": "Customer reports **checkout 500s** starting ~14:32 UTC. Investigating `payments-api`.\n\n- Error rate: ~12% on `/checkout`\n- Region: `eu-west-1`\n- See [dashboard](https://grafana.example.com/d/abc)\n" }, "schema": { "$ref": "#/components/schemas/AlertNotesUpdatePayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "alert_note": { "alert_group_id": "01HB9Z8WANK6P870EA6S7TK1DS", "alert_id": "01FCNDV6P870EA6S7TK1DSYDG0", "content": "Customer reports **checkout 500s** starting ~14:32 UTC. Investigating `payments-api`.\n\n- Error rate: ~12% on `/checkout`\n- Region: `eu-west-1`\n- See [dashboard](https://grafana.example.com/d/abc)\n", "created_at": "2026-05-28T15:30:00Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01J1X9J85C7Y12G8P8W8K55Q5Y", "images": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "url": "https://storage.googleapis.com/incident-io/images/..." } ], "last_edited_at": "2026-05-28T15:35:00Z", "updated_at": "2026-05-28T15:35:00Z" } }, "schema": { "$ref": "#/components/schemas/AlertNotesUpdateResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Alert Notes V1" ], "x-docs-display-name": "Update", "x-docs-group-name": "Alert Notes V1", "x-docs-resource-type": "AlertNoteV1", "x-mint": { "content": "🔑 Requires the `alerts.edit` scope." }, "x-rbac-scopes": [ "alerts.edit" ] } }, "/v3/alert_routes": { "get": { "description": "List all alert routes in your account.", "operationId": "Alert Routes V3_List", "parameters": [ { "allowEmptyValue": true, "description": "Number of alert routes to return per page", "example": 2, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Number of alert routes to return per page", "example": 2, "format": "int64", "maximum": 50, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "The ID of the last alert route on the previous page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "after", "schema": { "description": "The ID of the last alert route on the previous page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "alert_routes": [ { "enabled": false, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Production incidents" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/AlertRoutesListResultV3" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Alert Routes V3" ], "x-docs-display-name": "List", "x-docs-group-name": "Alert Routes V3", "x-docs-resource-type": "AlertRouteV3", "x-mint": { "content": "🔑 Requires the `alert_routes.view` scope." }, "x-rbac-scopes": [ "alert_routes.view" ] }, "post": { "description": "Create a new alert route in your account.", "operationId": "Alert Routes V3_Create", "requestBody": { "content": { "application/json": { "example": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] } ], "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "when_alert_joins_group": { "grace_period_seconds": 60, "mode": "on_each_new_alert" } }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "grouping_config": { "default": { "enabled": true, "grouping_keys": [ { "reference": "alert.title" } ], "window_seconds": 1800, "window_type": "rolling" } }, "incident_config": { "auto_decline_enabled": false, "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "enabled": false, "incident_template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "membership_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } } }, "is_private": false, "message_config": { "destinations": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "public", "group_alerts_summary": false }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "public", "group_alerts_summary": false } } ], "template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ] }, "schema": { "$ref": "#/components/schemas/AlertRoutesCreatePayloadV3" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "alert_route": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] } ], "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "when_alert_joins_group": { "grace_period_seconds": 60, "mode": "on_each_new_alert" } }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "grouping_config": { "default": { "enabled": true, "grouping_keys": [ { "reference": "alert.title" } ], "window_seconds": 1800, "window_type": "rolling" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_config": { "auto_decline_enabled": false, "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "enabled": false, "incident_template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "membership_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } } }, "is_private": false, "message_config": { "destinations": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123", "group_alerts_summary": false }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123", "group_alerts_summary": false } } ], "template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "schema": { "$ref": "#/components/schemas/AlertRoutesCreateResultV3" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Alert Routes V3" ], "x-docs-display-name": "Create", "x-docs-group-name": "Alert Routes V3", "x-docs-resource-type": "AlertRouteV3", "x-mint": { "content": "🔑 Requires the `alert_route.create` scope." }, "x-rbac-scopes": [ "alert_route.create" ] } }, "/v3/alert_routes/{id}": { "delete": { "description": "Delete an existing alert route in your account.", "operationId": "Alert Routes V3_Delete", "parameters": [ { "description": "Unique identifier of the alert route", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the alert route", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Alert Routes V3" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Alert Routes V3", "x-docs-resource-type": "AlertRouteV3", "x-mint": { "content": "🔑 Requires the `alert_route.destroy` scope." }, "x-rbac-scopes": [ "alert_route.destroy" ] }, "get": { "description": "Load details about a specific alert route in your account.", "operationId": "Alert Routes V3_Show", "parameters": [ { "description": "Unique identifier of the alert route", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the alert route", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "alert_route": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] } ], "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "when_alert_joins_group": { "grace_period_seconds": 60, "mode": "on_each_new_alert" } }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "grouping_config": { "default": { "enabled": true, "grouping_keys": [ { "reference": "alert.title" } ], "window_seconds": 1800, "window_type": "rolling" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_config": { "auto_decline_enabled": false, "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "enabled": false, "incident_template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "membership_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } } }, "is_private": false, "message_config": { "destinations": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123", "group_alerts_summary": false }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123", "group_alerts_summary": false } } ], "template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "schema": { "$ref": "#/components/schemas/AlertRoutesShowResultV3" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Alert Routes V3" ], "x-docs-display-name": "Show", "x-docs-group-name": "Alert Routes V3", "x-docs-resource-type": "AlertRouteV3", "x-mint": { "content": "🔑 Requires the `alert_routes.view` scope." }, "x-rbac-scopes": [ "alert_routes.view" ] }, "put": { "description": "Update an existing alert route in your account.", "operationId": "Alert Routes V3_Update", "parameters": [ { "description": "Unique identifier of the alert route", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the alert route", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] } ], "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "when_alert_joins_group": { "grace_period_seconds": 60, "mode": "on_each_new_alert" } }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "grouping_config": { "default": { "enabled": true, "grouping_keys": [ { "reference": "alert.title" } ], "window_seconds": 1800, "window_type": "rolling" } }, "incident_config": { "auto_decline_enabled": false, "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "enabled": false, "incident_template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "membership_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } } }, "is_private": false, "message_config": { "destinations": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "public", "group_alerts_summary": false }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "public", "group_alerts_summary": false } } ], "template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "version": 1 }, "schema": { "$ref": "#/components/schemas/AlertRoutesUpdatePayloadV3" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "alert_route": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] } ], "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "when_alert_joins_group": { "grace_period_seconds": 60, "mode": "on_each_new_alert" } }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "grouping_config": { "default": { "enabled": true, "grouping_keys": [ { "reference": "alert.title" } ], "window_seconds": 1800, "window_type": "rolling" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_config": { "auto_decline_enabled": false, "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "enabled": false, "incident_template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "membership_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } } }, "is_private": false, "message_config": { "destinations": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123", "group_alerts_summary": false }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123", "group_alerts_summary": false } } ], "template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "schema": { "$ref": "#/components/schemas/AlertRoutesUpdateResultV3" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Alert Routes V3" ], "x-docs-display-name": "Update", "x-docs-group-name": "Alert Routes V3", "x-docs-resource-type": "AlertRouteV3", "x-mint": { "content": "🔑 Requires the `alert_route.update` scope." }, "x-rbac-scopes": [ "alert_route.update" ] } }, "/v2/alert_sources": { "get": { "description": "List all alert sources in your account.", "operationId": "Alert Sources V2_List", "responses": { "200": { "content": { "application/json": { "example": { "alert_sources": [ { "alert_events_url": "https://api.incident.io/v2/alert_events/http/01GW2G3V0S59R238FAHPDS1R66", "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "azure_devops_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "ba038695-f5f7-4490-a9ea-bf4ab3cbf483" ] }, "email_options": { "email_address": "lawrence@example.com", "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "filter_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "fixed_team_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60, "ping_url": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping" }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "id": "01GW2G3V0S59R238FAHPDS1R66", "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rate_limit_sharding": { "rate_limit_shard_key_path": "$.priority" }, "secret_token": "some-secret-token", "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "is_private": false, "title": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } } ] }, "schema": { "$ref": "#/components/schemas/AlertSourcesListResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Alert Sources V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Alert Sources V2", "x-docs-resource-type": "AlertSourceV2", "x-mint": { "content": "🔑 Requires the `alert_sources.view` scope." }, "x-rbac-scopes": [ "alert_sources.view" ] }, "post": { "description": "Create a new alert source in your account.", "operationId": "Alert Sources V2_Create", "requestBody": { "content": { "application/json": { "example": { "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "azure_devops_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "ba038695-f5f7-4490-a9ea-bf4ab3cbf483" ] }, "email_options": { "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "filter_condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "fixed_team_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60 }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rate_limit_sharding": { "rate_limit_shard_key_path": "$.priority" }, "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "is_private": false, "title": { "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "schema": { "$ref": "#/components/schemas/AlertSourcesCreatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "alert_source": { "alert_events_url": "https://api.incident.io/v2/alert_events/http/01GW2G3V0S59R238FAHPDS1R66", "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "azure_devops_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "ba038695-f5f7-4490-a9ea-bf4ab3cbf483" ] }, "email_options": { "email_address": "lawrence@example.com", "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "filter_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "fixed_team_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60, "ping_url": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping" }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "id": "01GW2G3V0S59R238FAHPDS1R66", "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rate_limit_sharding": { "rate_limit_shard_key_path": "$.priority" }, "secret_token": "some-secret-token", "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "is_private": false, "title": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } } }, "schema": { "$ref": "#/components/schemas/AlertSourcesCreateResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Alert Sources V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Alert Sources V2", "x-docs-resource-type": "AlertSourceV2", "x-mint": { "content": "🔑 Requires the `alert_source.create` scope." }, "x-rbac-scopes": [ "alert_source.create" ] } }, "/v2/alert_sources/{id}": { "delete": { "description": "Delete an existing alert source in your account.", "operationId": "Alert Sources V2_Delete", "parameters": [ { "description": "The ID of this alert source", "example": "01GW2G3V0S59R238FAHPDS1R66", "in": "path", "name": "id", "required": true, "schema": { "description": "The ID of this alert source", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Alert Sources V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Alert Sources V2", "x-docs-resource-type": "AlertSourceV2", "x-mint": { "content": "🔑 Requires the `alert_source.destroy` scope." }, "x-rbac-scopes": [ "alert_source.destroy" ] }, "get": { "description": "Load details about a specific alert source in your account.", "operationId": "Alert Sources V2_Show", "parameters": [ { "description": "The ID of this alert source", "example": "01GW2G3V0S59R238FAHPDS1R66", "in": "path", "name": "id", "required": true, "schema": { "description": "The ID of this alert source", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "alert_source": { "alert_events_url": "https://api.incident.io/v2/alert_events/http/01GW2G3V0S59R238FAHPDS1R66", "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "azure_devops_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "ba038695-f5f7-4490-a9ea-bf4ab3cbf483" ] }, "email_options": { "email_address": "lawrence@example.com", "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "filter_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "fixed_team_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60, "ping_url": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping" }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "id": "01GW2G3V0S59R238FAHPDS1R66", "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rate_limit_sharding": { "rate_limit_shard_key_path": "$.priority" }, "secret_token": "some-secret-token", "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "is_private": false, "title": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } } }, "schema": { "$ref": "#/components/schemas/AlertSourcesShowResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Alert Sources V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Alert Sources V2", "x-docs-resource-type": "AlertSourceV2", "x-mint": { "content": "🔑 Requires the `alert_sources.view` scope." }, "x-rbac-scopes": [ "alert_sources.view" ] }, "put": { "description": "Update an existing alert source in your account.", "operationId": "Alert Sources V2_Update", "parameters": [ { "description": "The ID of this alert source", "example": "01GW2G3V0S59R238FAHPDS1R66", "in": "path", "name": "id", "required": true, "schema": { "description": "The ID of this alert source", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "azure_devops_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "ba038695-f5f7-4490-a9ea-bf4ab3cbf483" ] }, "disabled": false, "email_options": { "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "filter_condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "fixed_team_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60 }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rate_limit_sharding": { "rate_limit_shard_key_path": "$.priority" }, "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "is_private": false, "title": { "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "schema": { "$ref": "#/components/schemas/AlertSourcesUpdatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "alert_source": { "alert_events_url": "https://api.incident.io/v2/alert_events/http/01GW2G3V0S59R238FAHPDS1R66", "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "azure_devops_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "ba038695-f5f7-4490-a9ea-bf4ab3cbf483" ] }, "email_options": { "email_address": "lawrence@example.com", "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "filter_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "fixed_team_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60, "ping_url": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping" }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "id": "01GW2G3V0S59R238FAHPDS1R66", "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rate_limit_sharding": { "rate_limit_shard_key_path": "$.priority" }, "secret_token": "some-secret-token", "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "is_private": false, "title": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } } }, "schema": { "$ref": "#/components/schemas/AlertSourcesUpdateResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Alert Sources V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Alert Sources V2", "x-docs-resource-type": "AlertSourceV2", "x-mint": { "content": "🔑 Requires the `alert_source.update` scope." }, "x-rbac-scopes": [ "alert_source.update" ] } }, "/v2/alert_sources/actions/validate": { "post": { "description": "Check whether an alert source template is valid, without creating or updating anything.\n\nThis validates the template in the same way a create or update would: expressions are\ncompiled and checked against your alert schema and catalog, and merge strategies are checked\nagainst the attributes they bind to. Values that are only known once an alert source exists\nare not validated.", "operationId": "Alert Sources V2_Validate", "requestBody": { "content": { "application/json": { "example": { "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "is_private": false, "title": { "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "schema": { "$ref": "#/components/schemas/AlertSourcesValidatePayloadV2" } } }, "required": true }, "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Validate", "tags": [ "Alert Sources V2" ], "x-docs-display-name": "Validate", "x-docs-group-name": "Alert Sources V2", "x-docs-resource-type": "AlertSourceV2", "x-mint": { "content": "🔑 Requires the `alert_sources.view` scope." }, "x-rbac-scopes": [ "alert_sources.view" ] } }, "/v2/alert_tags": { "get": { "description": "List the alert tags in your organisation's vocabulary.\n\nAlert tags are the reusable labels you can apply to alerts. This endpoint lists the\norganisation's active tags, ordered by name, and excludes archived tags.\n\nTo narrow the list, filter by search, which matches tags whose name contains the given\nvalue (case-insensitive):\n\n```bash\ncurl --get 'https://api.incident.io/v2/alert_tags' \\\n--data 'search=noisy'\n```\n", "operationId": "Alerts V2_ListAlertTags", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "A tag's ID. This endpoint will return a list of tags after this ID in relation to the API response order.", "examples": { "default": { "summary": "default", "value": "01GW2G3V0S59R238FAHPDS1R66" } }, "in": "query", "name": "after", "schema": { "description": "A tag's ID. This endpoint will return a list of tags after this ID in relation to the API response order.", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter to tags whose name contains this value (case-insensitive)", "example": "noisy", "in": "query", "name": "search", "schema": { "description": "Filter to tags whose name contains this value (case-insensitive)", "example": "noisy", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "alert_tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/AlertsListAlertTagsResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Alerts V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Alert Tags V2", "x-docs-resource-type": "AlertTagV2", "x-mint": { "content": "🔑 Requires the `alerts.view` scope." }, "x-rbac-scopes": [ "alerts.view" ] } }, "/v2/alerts": { "get": { "description": "List all alerts for your account.\n```bash\n\n```\nThis endpoint supports a number of filters, which can help find alerts matching certain\ncriteria. These filters work similarly to the filters on the incidents endpoint, where \na field is specified alongside a comparison operator in the query string.\n\nNote that:\n- Filters may be used together, and the result will be alerts that match all filters.\n- All query parameters must be URI encoded.\n\n### By deduplication_key\n\nFind all alerts with deduplication_key ABC:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'deduplication_key[is]=ABC'\n```\n\n### By status\n\nFind all alerts in a firing state:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'status[one_of]=firing'\n```\n\n### By alert_source\n\nFind all alerts from a specific alert source (by alert source ID):\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'alert_source[one_of]=01GBSQF3FHF7FWZQNWGHAVQ804'\n```\n\nFind all alerts not from a specific alert source:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'alert_source[not_in]=01GBSQF3FHF7FWZQNWGHAVQ804'\n```\n\n### By alert_group_id\n\nFind all alerts in a specific alert group:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'alert_group_id[one_of]=01GBSQF3FHF7FWZQNWGHAVQ804'\n```\n\n### By created_at\nFind all alerts that follow specified date parameters for created_at field.\nPossible values are \"gte\" (greater than or equal to), \"lte\" (less than or equal to), and \n\"date_range\" (between two dates). The following example finds all alerts created after \n2025-01-01:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'created_at[gte]=2025-01-01'\n```\n\nTo find alerts created within a specific date range, use the date_range option with \ntilde-separated dates:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'created_at[date_range]=2024-12-02~2024-12-08'\n```\n\n### By updated_at\nFind all alerts that follow specified date parameters for updated_at field, using the same\n\"gte\", \"lte\" and \"date_range\" operators as created_at. This is useful for incrementally\nsyncing alerts: poll with updated_at[gte] set to your last sync time instead of re-fetching\nthe full history. Note that updated_at moves whenever the alert row is written, which can\nhappen without a visible change to the alert payload, so treat matches as candidates to\nre-fetch rather than guaranteed changes — and overlap your sync window by a few minutes to\nallow for writes that commit out of timestamp order:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'updated_at[gte]=2025-01-01T00:00:00Z'\n```\n\n### By has_notes\n\nFind all alerts that have notes attached:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'has_notes[is]=true'\n```\n\nFind all alerts that have no notes attached:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'has_notes[is]=false'\n```\n\n### By tags\n\nFilter by tag name, matched case-insensitively.\n\nFind all alerts that have any of the given tags:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'tags[one_of]=known issue'\n```\n\nFind all alerts that have all of the given tags:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'tags[all_of]=known issue' \\\n--data 'tags[all_of]=customer impacting'\n```\n\nFind all alerts that do not have any of the given tags. Untagged alerts are included:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'tags[not_in]=known issue'\n```\n\n### By attributes\n\nAlerts can be filtered by their attribute values. Each filter is keyed by the alert\nattribute ID, followed by an operator and the values to match. The accepted operators\ndepend on the attribute's type.\n\nFind all alerts where attribute 01GBSQF3FHF7FWZQNWGHAVQ804 is one of two catalog entries:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'attributes[01GBSQF3FHF7FWZQNWGHAVQ804][one_of]=01GBSQF3FHF7FWZQNWGHAVQ804' \\\n--data 'attributes[01GBSQF3FHF7FWZQNWGHAVQ804][one_of]=01ET65M7ZARSFZ6TFDFVQDN9AA'\n```\n\nYou can filter on multiple attributes at once, and the result will be alerts that match\nall of them.\n\n### Maintenance windows\nBy default, all alerts are returned including those held by a maintenance window.\nTo exclude alerts that are held by a maintenance window:\n\n```bash\ncurl --get 'https://api.incident.io/v2/alerts' \\\n--data 'include_maintenance_window[is]=false'\n\n```", "operationId": "Alerts V2_List", "parameters": [ { "allowEmptyValue": true, "description": "Number of alerts to return per page", "example": 25, "in": "query", "name": "page_size", "required": true, "schema": { "default": 25, "description": "Number of alerts to return per page", "example": 25, "format": "int64", "maximum": 50, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "If provided, pass this as the 'after' param to load the next page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "after", "schema": { "description": "If provided, pass this as the 'after' param to load the next page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter on alert deduplication key. The accepted operator is 'is'.", "example": { "is": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "in": "query", "name": "deduplication_key", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on alert deduplication key. The accepted operator is 'is'.", "example": { "is": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on alert status. The accepted operators are 'one_of', or 'not_in'.", "example": { "one_of": [ "firing" ] }, "in": "query", "name": "status", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on alert status. The accepted operators are 'one_of', or 'not_in'.", "example": { "one_of": [ "firing" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on alert source by ID. The accepted operators are 'one_of', or 'not_in'.", "example": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "in": "query", "name": "alert_source", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on alert source by ID. The accepted operators are 'one_of', or 'not_in'.", "example": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on alert group ID. Returns alerts that belong to any of the specified groups. The accepted operator is 'one_of'.", "example": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "in": "query", "name": "alert_group_id", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on alert group ID. Returns alerts that belong to any of the specified groups. The accepted operator is 'one_of'.", "example": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on alert created at timestamp. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2025-01-01" ] }, "in": "query", "name": "created_at", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on alert created at timestamp. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2025-01-01" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on alert updated at timestamp. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2025-01-01" ] }, "in": "query", "name": "updated_at", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on alert updated at timestamp. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2025-01-01" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on an alerts attributes. Alert attribute ID should be sent, followed by the operator and values. Accepted operator will depend on the attribute type.", "example": { "01GBSQF3FHF7FWZQNWGHAVQ804": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "01ET65M7ZARSFZ6TFDFVQDN9AA" ] } }, "in": "query", "name": "attributes", "schema": { "additionalProperties": { "additionalProperties": { "example": [ "value" ], "items": { "example": "value", "type": "string" }, "type": "array" }, "example": { "abc123": [ "value" ] }, "type": "object" }, "description": "Filter on an alerts attributes. Alert attribute ID should be sent, followed by the operator and values. Accepted operator will depend on the attribute type.", "example": { "01GBSQF3FHF7FWZQNWGHAVQ804": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "01ET65M7ZARSFZ6TFDFVQDN9AA" ] } }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on whether an alert has notes. The accepted operator is 'is'.", "example": { "is": [ "true" ] }, "in": "query", "name": "has_notes", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on whether an alert has notes. The accepted operator is 'is'.", "example": { "is": [ "true" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on the tags applied to an alert, by tag name. The accepted operators are 'one_of', 'all_of' and 'not_in'.", "example": { "one_of": [ "known issue" ] }, "in": "query", "name": "tags", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on the tags applied to an alert, by tag name. The accepted operators are 'one_of', 'all_of' and 'not_in'.", "example": { "one_of": [ "known issue" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on whether to include maintenance window alerts. The accepted operator is 'is'.", "example": { "is": [ "true" ] }, "in": "query", "name": "include_maintenance_window", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on whether to include maintenance window alerts. The accepted operator is 'is'.", "example": { "is": [ "true" ] }, "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "example": { "alerts": [ { "alert_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", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/AlertsListResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Alerts V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Alerts V2", "x-docs-resource-type": "AlertV2", "x-mint": { "content": "🔑 Requires the `alerts.view` scope." }, "x-rbac-scopes": [ "alerts.view" ] } }, "/v2/alerts/{id}": { "get": { "description": "Show a single alert for your account", "operationId": "Alerts V2_Show", "parameters": [ { "description": "Unique identifier for the alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "alert": { "alert_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", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/AlertsShowResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Alerts V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Alerts V2", "x-docs-resource-type": "AlertV2", "x-mint": { "content": "🔑 Requires the `alerts.view` scope." }, "x-rbac-scopes": [ "alerts.view" ] } }, "/v2/alerts/{id}/actions/add_tags": { "post": { "description": "Add tags to an alert without changing its existing tags.\n\nEach tag is a name. A name that does not exist is created, except on private alerts,\nwhere only names already in the organisation's tag vocabulary can be used. Tags that are\nalready present are ignored.", "operationId": "Alerts V2_AddTags", "parameters": [ { "description": "Unique identifier for the alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "tags": [ "known issue", "customer impacting" ] }, "schema": { "$ref": "#/components/schemas/AlertsAddTagsPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "alert": { "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", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/AlertsAddTagsResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Add tags", "tags": [ "Alerts V2" ], "x-docs-display-name": "Add tags", "x-docs-group-name": "Alerts V2", "x-docs-resource-type": "AlertV2", "x-mint": { "content": "🔑 Requires the `alerts.edit` scope." }, "x-rbac-scopes": [ "alerts.edit" ] } }, "/v2/alerts/{id}/actions/remove_tags": { "post": { "description": "Remove tags from an alert without changing its other tags.\n\nEach tag is a name. Tags that are not present on the alert are ignored.", "operationId": "Alerts V2_RemoveTags", "parameters": [ { "description": "Unique identifier for the alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "tags": [ "known issue", "customer impacting" ] }, "schema": { "$ref": "#/components/schemas/AlertsRemoveTagsPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "alert": { "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", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/AlertsRemoveTagsResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Remove tags", "tags": [ "Alerts V2" ], "x-docs-display-name": "Remove tags", "x-docs-group-name": "Alerts V2", "x-docs-resource-type": "AlertV2", "x-mint": { "content": "🔑 Requires the `alerts.edit` scope." }, "x-rbac-scopes": [ "alerts.edit" ] } }, "/v2/alerts/{id}/actions/resolve": { "post": { "description": "Resolve a currently firing alert.\n\nThis marks the alert as resolved with the current time, attributing the resolution to the API key that made the request. Resolving an already-resolved alert is a no-op and returns the alert unchanged.\n\nSome alert sources are 'externally resolved' (for example, Datadog) — those alerts can only be resolved by the third-party system itself, and this endpoint will return a 422 explaining that.\n\nPrivate alerts: an API key without the 'view all alerts' scope can only resolve non-private alerts; private alerts will return a 404. Grant the API key a role that includes the global alerts access scope to resolve private alerts.\n", "operationId": "Alerts V2_Resolve", "parameters": [ { "description": "Unique identifier for the alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "alert": { "alert_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", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/AlertsResolveResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Resolve", "tags": [ "Alerts V2" ], "x-docs-display-name": "Resolve", "x-docs-group-name": "Alerts V2", "x-docs-resource-type": "AlertV2", "x-mint": { "content": "🔑 Requires the `alerts.resolve` scope." }, "x-rbac-scopes": [ "alerts.resolve" ] } }, "/v2/alerts/{id}/actions/set_tags": { "post": { "description": "Replace all tags on an alert.\n\nEach tag is a name. A name that does not exist is created, except on private alerts,\nwhere only names already in the organisation's tag vocabulary can be used. Passing an\nempty list removes every tag.", "operationId": "Alerts V2_SetTags", "parameters": [ { "description": "Unique identifier for the alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "tags": [ "known issue", "customer impacting" ] }, "schema": { "$ref": "#/components/schemas/AlertsSetTagsPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "alert": { "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", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/AlertsSetTagsResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Set tags", "tags": [ "Alerts V2" ], "x-docs-display-name": "Set tags", "x-docs-group-name": "Alerts V2", "x-docs-resource-type": "AlertV2", "x-mint": { "content": "🔑 Requires the `alerts.edit` scope." }, "x-rbac-scopes": [ "alerts.edit" ] } }, "/v2/incident_alerts": { "get": { "description": "List the connections between incidents and alerts", "operationId": "Alerts V2_ListIncidentAlerts", "parameters": [ { "allowEmptyValue": true, "description": "Number of incident alerts to return per page", "example": 25, "in": "query", "name": "page_size", "required": true, "schema": { "default": 25, "description": "Number of incident alerts to return per page", "example": 25, "format": "int64", "maximum": 50, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "If provided, pass this as the 'after' param to load the next page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "after", "schema": { "description": "If provided, pass this as the 'after' param to load the next page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Alert that this incident alert refers to", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "in": "query", "name": "alert_id", "schema": { "description": "Alert that this incident alert refers to", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } }, { "allowEmptyValue": true, "description": "Incident that this incident alert is attached to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "incident_id", "schema": { "description": "Incident that this incident alert is attached to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_alerts": [ { "alert": { "alert_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" }, "alert_route_id": "01GW2G3V0S59R238FAHPDS1R67", "id": "01GW2G3V0S59R238FAHPDS1R66", "incident": { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/AlertsListIncidentAlertsResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Alerts V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Incident Alerts V2", "x-docs-resource-type": "IncidentAlertV2", "x-mint": { "content": "🔑 Requires the `alerts.view` scope." }, "x-rbac-scopes": [ "alerts.view" ] }, "post": { "description": "Attach an alert to an incident, creating the connection between them.\n\nThe API key also needs the 'manage incident alerts' scope, which is what actually relates\nthe alert once the connection exists.\n\nIf the alert is already related to this incident, the existing connection is returned\nunchanged. If someone previously marked the alert as unrelated to this incident, that\ndecision is preserved and this endpoint returns a 422 — set re_relate to override it.\n\nPrivate alerts can only be attached to private incidents, including when re_relate is set.\nAn API key that cannot see the alert or the incident receives a 404.\n\nBusy incidents can be locked by another operation, in which case this endpoint returns a\n409 and the request can be retried.\n\nNote that this endpoint returns 201 even when it re-relates or returns an existing\nconnection rather than creating a new one.\n", "operationId": "Alerts V2_CreateIncidentAlert", "requestBody": { "content": { "application/json": { "example": { "alert_id": "01FCNDV6P870EA6S7TK1DSYDG1", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "re_relate": false }, "schema": { "$ref": "#/components/schemas/AlertsCreateIncidentAlertPayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "incident_alert": { "alert": { "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" }, "alert_route_id": "01GW2G3V0S59R238FAHPDS1R67", "id": "01GW2G3V0S59R238FAHPDS1R66", "incident": { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } } }, "schema": { "$ref": "#/components/schemas/AlertsCreateIncidentAlertResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Alerts V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Incident Alerts V2", "x-docs-resource-type": "IncidentAlertV2", "x-mint": { "content": "🔑 Requires the `alerts.attach_to_incident` scope." }, "x-rbac-scopes": [ "alerts.attach_to_incident" ] } }, "/v2/incident_alerts/{id}/actions/transition": { "post": { "description": "Confirm or detach the connection between an alert and an incident.\n\nSet state to 'related' to confirm the connection, or 'unrelated' to detach the alert from\nthe incident. The API key also needs the 'manage incident alerts' scope.\n\nA detached connection no longer appears in the list endpoint, which returns related\nconnections only.\n\nBusy incidents can be locked by another operation, in which case this endpoint returns a\n409 and the request can be retried.\n", "operationId": "Alerts V2_TransitionIncidentAlert", "parameters": [ { "description": "Unique identifier for the incident alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the incident alert", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "state": "related" }, "schema": { "$ref": "#/components/schemas/AlertsTransitionIncidentAlertPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "incident_alert": { "alert": { "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" }, "alert_route_id": "01GW2G3V0S59R238FAHPDS1R67", "id": "01GW2G3V0S59R238FAHPDS1R66", "incident": { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } } }, "schema": { "$ref": "#/components/schemas/AlertsTransitionIncidentAlertResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Transition", "tags": [ "Alerts V2" ], "x-docs-display-name": "Transition", "x-docs-group-name": "Incident Alerts V2", "x-docs-resource-type": "IncidentAlertV2", "x-mint": { "content": "🔑 Requires the `incident_alerts.transition` scope." }, "x-rbac-scopes": [ "incident_alerts.transition" ] } }, "/v1/api_keys": { "get": { "description": "List API keys visible to the calling API key, with pagination. An API key with account-level `api_keys_manage` access will see all keys, while a key with the `api_keys_manage` role scoped to specific teams will only see keys belonging to those teams.\n\nThis endpoint requires a valid API key with the `api_keys_manage` role at either the account level or team level.", "operationId": "API Keys V1_List", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "api_keys": [ { "comments": "Requested in https://example.slack.com/archives/C123/p456", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_used_at": "2021-08-17T13:28:57.801578Z", "name": "My test API key", "roles": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "team_ids": [ "abc123" ], "team_roles": [ { "description": "can view data, like public incidents and organization settings", "name": "catalog_editor" } ], "token_last_issued_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/APIKeysListResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "API Keys V1" ], "x-docs-display-name": "List", "x-docs-group-name": "API Keys V1", "x-docs-resource-type": "APIKeyV1", "x-mint": { "content": "🔑 Requires the `api_keys.view` scope." }, "x-rbac-scopes": [ "api_keys.view" ] }, "post": { "description": "Create a new API key. The calling API key can only assign roles whose scopes are a subset of its own. The `api_keys_manage` role cannot be assigned via the API. An organization can have a maximum of 5000 active API keys.\n\nThis endpoint requires a valid API key with the `api_keys_manage` role at either the account level or team level.", "operationId": "API Keys V1_Create", "requestBody": { "content": { "application/json": { "example": { "comments": "Requested in https://example.slack.com/archives/C123/p456", "name": "My test API key", "role_names": [ "viewer", "incident_creator" ], "team_ids": [ "01FCNDV6P870EA6S7TK1DSYDG0" ], "team_role_names": [ "schedules_editor" ] }, "schema": { "$ref": "#/components/schemas/APIKeysCreatePayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "api_key": { "comments": "Requested in https://example.slack.com/archives/C123/p456", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_used_at": "2021-08-17T13:28:57.801578Z", "name": "My test API key", "roles": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "team_ids": [ "abc123" ], "team_roles": [ { "description": "can view data, like public incidents and organization settings", "name": "catalog_editor" } ], "token_last_issued_at": "2021-08-17T13:28:57.801578Z" }, "token": "inc_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef" }, "schema": { "$ref": "#/components/schemas/APIKeysCreateResultV1" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "API Keys V1" ], "x-docs-display-name": "Create", "x-docs-group-name": "API Keys V1", "x-docs-resource-type": "APIKeyV1", "x-mint": { "content": "🔑 Requires the `api_keys.create` scope." }, "x-rbac-scopes": [ "api_keys.create" ] } }, "/v1/api_keys/{id}": { "delete": { "description": "Delete an existing API key. The calling API key does not need to hold the scopes of the key being deleted, but a team-scoped key can only delete keys belonging to its teams.\n\nThis endpoint requires a valid API key with the `api_keys_manage` role at either the account level or team level.", "operationId": "API Keys V1_Delete", "parameters": [ { "description": "Unique identifier of the API key to delete", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the API key to delete", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "API Keys V1" ], "x-docs-display-name": "Delete", "x-docs-group-name": "API Keys V1", "x-docs-resource-type": "APIKeyV1", "x-mint": { "content": "🔑 Requires the `api_keys.destroy` scope." }, "x-rbac-scopes": [ "api_keys.destroy" ] }, "get": { "description": "Show details of a specific API key, including its roles, team assignments and when its token was last issued.\n\nThis endpoint requires a valid API key with the `api_keys_manage` role at either the account level or team level.", "operationId": "API Keys V1_Show", "parameters": [ { "description": "Unique identifier of the API key to retrieve", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the API key to retrieve", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "api_key": { "comments": "Requested in https://example.slack.com/archives/C123/p456", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_used_at": "2021-08-17T13:28:57.801578Z", "name": "My test API key", "roles": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "team_ids": [ "abc123" ], "team_roles": [ { "description": "can view data, like public incidents and organization settings", "name": "catalog_editor" } ], "token_last_issued_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/APIKeysShowResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "API Keys V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "API Keys V1", "x-docs-resource-type": "APIKeyV1", "x-mint": { "content": "🔑 Requires the `api_keys.view` scope." }, "x-rbac-scopes": [ "api_keys.view" ] }, "put": { "description": "Update an existing API key's name, roles, or team assignments. All fields must be provided (PUT semantics). The calling API key can only assign roles whose scopes are a subset of its own. An API key cannot edit itself, and the `api_keys_manage` role cannot be assigned via the API.\n\nThis endpoint requires a valid API key with the `api_keys_manage` role at either the account level or team level.", "operationId": "API Keys V1_Update", "parameters": [ { "description": "Unique identifier of the API key to update", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the API key to update", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "comments": "Requested in https://example.slack.com/archives/C123/p456", "name": "My test API key", "role_names": [ "viewer", "incident_creator" ], "team_ids": [ "01FCNDV6P870EA6S7TK1DSYDG0" ], "team_role_names": [ "schedules_editor" ] }, "schema": { "$ref": "#/components/schemas/APIKeysUpdatePayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "api_key": { "comments": "Requested in https://example.slack.com/archives/C123/p456", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_used_at": "2021-08-17T13:28:57.801578Z", "name": "My test API key", "roles": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "team_ids": [ "abc123" ], "team_roles": [ { "description": "can view data, like public incidents and organization settings", "name": "catalog_editor" } ], "token_last_issued_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/APIKeysUpdateResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "API Keys V1" ], "x-docs-display-name": "Update", "x-docs-group-name": "API Keys V1", "x-docs-resource-type": "APIKeyV1", "x-mint": { "content": "🔑 Requires the `api_keys.update` scope." }, "x-rbac-scopes": [ "api_keys.update" ] } }, "/v1/api_keys/{id}/actions/rotate": { "post": { "description": "Rotate the access token for an API key. This generates a new bearer token and optionally keeps the old token valid for a configurable grace period (up to 60 minutes), allowing a seamless rollover without downtime. The calling API key must have all the scopes of the key being rotated.\n\nThis endpoint requires a valid API key with the `api_keys_manage` role at either the account level or team level.", "operationId": "API Keys V1_Rotate", "parameters": [ { "description": "Unique identifier of the API key to rotate", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the API key to rotate", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "grace_period_minutes": 30 }, "schema": { "$ref": "#/components/schemas/APIKeysRotatePayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "api_key": { "comments": "Requested in https://example.slack.com/archives/C123/p456", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_used_at": "2021-08-17T13:28:57.801578Z", "name": "My test API key", "roles": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "team_ids": [ "abc123" ], "team_roles": [ { "description": "can view data, like public incidents and organization settings", "name": "catalog_editor" } ], "token_last_issued_at": "2021-08-17T13:28:57.801578Z" }, "token": "inc_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef" }, "schema": { "$ref": "#/components/schemas/APIKeysRotateResultV1" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Rotate", "tags": [ "API Keys V1" ], "x-docs-display-name": "Rotate", "x-docs-group-name": "API Keys V1", "x-docs-resource-type": "APIKeyV1", "x-mint": { "content": "🔑 Requires the `api_keys.rotate` scope." }, "x-rbac-scopes": [ "api_keys.rotate" ] } }, "/v2/call_routes": { "get": { "description": "List all call routes for this organisation.", "operationId": "Call Routes V2_List", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "A call route's ID. This endpoint will return a list of call routes after this ID in relation to the API response order.", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "query", "name": "after", "schema": { "description": "A call route's ID. This endpoint will return a list of call routes after this ID in relation to the API response order.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "call_routes": [ { "allowed_callers": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator duty desk", "phone_number": "+15551234567" } ], "country_code": "US", "created_at": "2021-08-17T13:28:57.801578Z", "current_state": "active", "custom_language": "en-US", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator urgent request", "options": [ { "digit": "1", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "prompt": "For an urgent production outage, press 1" } ], "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "phone_number": "+15551234567", "phone_number_type": "toll_free", "responder_caller_id": "route_number", "updated_at": "2021-08-17T13:28:57.801578Z", "use_caller_allowlist": true } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/CallRoutesListResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Call Routes V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Call Routes V2", "x-docs-resource-type": "CallRouteV2", "x-mint": { "content": "🔑 Requires the `call_routes.view` scope." }, "x-rbac-scopes": [ "call_routes.view" ] } }, "/v2/call_routes/{call_route_id}/allowed_callers": { "get": { "description": "List the numbers allowed to call a route.", "operationId": "Call Routes V2_ListAllowedCallers", "parameters": [ { "description": "The call route's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "call_route_id", "required": true, "schema": { "description": "The call route's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "allowed_callers": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator duty desk", "phone_number": "+15551234567" } ] }, "schema": { "$ref": "#/components/schemas/CallRoutesListAllowedCallersResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Call Routes V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Call Route Allowed Callers V2", "x-docs-resource-type": "CallRouteAllowedCallerV2", "x-mint": { "content": "🔑 Requires the `call_routes.view` scope." }, "x-rbac-scopes": [ "call_routes.view" ] }, "post": { "description": "Allow a number to call this route.", "operationId": "Call Routes V2_CreateAllowedCaller", "parameters": [ { "description": "The call route to allow this number to call", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "call_route_id", "required": true, "schema": { "description": "The call route to allow this number to call", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "name": "Regulator duty desk", "phone_number": "+15551234567" }, "schema": { "$ref": "#/components/schemas/CallRoutesCreateAllowedCallerPayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "allowed_caller": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator duty desk", "phone_number": "+15551234567" } }, "schema": { "$ref": "#/components/schemas/CallRoutesCreateAllowedCallerResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Call Routes V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Call Route Allowed Callers V2", "x-docs-resource-type": "CallRouteAllowedCallerV2", "x-mint": { "content": "🔑 Requires the `call_routes.update` scope." }, "x-rbac-scopes": [ "call_routes.update" ] } }, "/v2/call_routes/{call_route_id}/allowed_callers/{id}": { "delete": { "description": "Stop allowing a number to call this route.\n\nA route that only answers its allowed callers must keep at least one, so turn\nuse_caller_allowlist off before removing the last number.", "operationId": "Call Routes V2_DestroyAllowedCaller", "parameters": [ { "description": "The call route's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "call_route_id", "required": true, "schema": { "description": "The call route's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "description": "The allowed caller's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "The allowed caller's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Call Routes V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Call Route Allowed Callers V2", "x-docs-resource-type": "CallRouteAllowedCallerV2", "x-mint": { "content": "🔑 Requires the `call_routes.update` scope." }, "x-rbac-scopes": [ "call_routes.update" ] }, "get": { "description": "Show a single allowed caller.", "operationId": "Call Routes V2_ShowAllowedCaller", "parameters": [ { "description": "The call route's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "call_route_id", "required": true, "schema": { "description": "The call route's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "description": "The allowed caller's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "The allowed caller's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "allowed_caller": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator duty desk", "phone_number": "+15551234567" } }, "schema": { "$ref": "#/components/schemas/CallRoutesShowAllowedCallerResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Call Routes V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Call Route Allowed Callers V2", "x-docs-resource-type": "CallRouteAllowedCallerV2", "x-mint": { "content": "🔑 Requires the `call_routes.view` scope." }, "x-rbac-scopes": [ "call_routes.view" ] }, "put": { "description": "Replace an allowed caller's number and label.", "operationId": "Call Routes V2_UpdateAllowedCaller", "parameters": [ { "description": "The call route's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "call_route_id", "required": true, "schema": { "description": "The call route's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "description": "The allowed caller's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "The allowed caller's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "name": "Regulator duty desk", "phone_number": "+15551234567" }, "schema": { "$ref": "#/components/schemas/CallRoutesUpdateAllowedCallerPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "allowed_caller": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator duty desk", "phone_number": "+15551234567" } }, "schema": { "$ref": "#/components/schemas/CallRoutesUpdateAllowedCallerResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Call Routes V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Call Route Allowed Callers V2", "x-docs-resource-type": "CallRouteAllowedCallerV2", "x-mint": { "content": "🔑 Requires the `call_routes.update` scope." }, "x-rbac-scopes": [ "call_routes.update" ] } }, "/v2/call_routes/{call_route_id}/options": { "get": { "description": "List a call route's phone-tree options, in the order callers hear them.", "operationId": "Call Routes V2_ListOptions", "parameters": [ { "description": "The call route's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "call_route_id", "required": true, "schema": { "description": "The call route's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "options": [ { "digit": "1", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "prompt": "For an urgent production outage, press 1" } ] }, "schema": { "$ref": "#/components/schemas/CallRoutesListOptionsResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Call Routes V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Call Route Options V2", "x-docs-resource-type": "CallRouteOptionV2", "x-mint": { "content": "🔑 Requires the `call_routes.view` scope." }, "x-rbac-scopes": [ "call_routes.view" ] }, "post": { "description": "Add an option to a call route's phone-tree menu.\n\nCallers hear the menu instead of being routed down the route's own path, so\nadding the first option clears that path. Every plan allows a single option. A\nmenu of two or more options is not on every plan, so get in touch if you need\none enabled.", "operationId": "Call Routes V2_CreateOption", "parameters": [ { "description": "The call route to add this option to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "call_route_id", "required": true, "schema": { "description": "The call route to add this option to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "digit": "1", "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "prompt": "For an urgent production outage, press 1" }, "schema": { "$ref": "#/components/schemas/CallRoutesCreateOptionPayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "option": { "digit": "1", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "prompt": "For an urgent production outage, press 1" } }, "schema": { "$ref": "#/components/schemas/CallRoutesCreateOptionResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Call Routes V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Call Route Options V2", "x-docs-resource-type": "CallRouteOptionV2", "x-mint": { "content": "🔑 Requires the `call_routes.update` scope." }, "x-rbac-scopes": [ "call_routes.update" ] } }, "/v2/call_routes/{call_route_id}/options/{id}": { "delete": { "description": "Remove an option from a call route's phone-tree menu.\n\nA route has to route calls somewhere, so give it a path before removing its last\noption.", "operationId": "Call Routes V2_DestroyOption", "parameters": [ { "description": "The call route's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "call_route_id", "required": true, "schema": { "description": "The call route's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "description": "The option's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "The option's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Call Routes V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Call Route Options V2", "x-docs-resource-type": "CallRouteOptionV2", "x-mint": { "content": "🔑 Requires the `call_routes.update` scope." }, "x-rbac-scopes": [ "call_routes.update" ] }, "get": { "description": "Show a single phone-tree option.", "operationId": "Call Routes V2_ShowOption", "parameters": [ { "description": "The call route's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "call_route_id", "required": true, "schema": { "description": "The call route's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "description": "The option's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "The option's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "option": { "digit": "1", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "prompt": "For an urgent production outage, press 1" } }, "schema": { "$ref": "#/components/schemas/CallRoutesShowOptionResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Call Routes V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Call Route Options V2", "x-docs-resource-type": "CallRouteOptionV2", "x-mint": { "content": "🔑 Requires the `call_routes.view` scope." }, "x-rbac-scopes": [ "call_routes.view" ] }, "put": { "description": "Replace a phone-tree option.\n\nTwo live options can't share a digit, so moving an option onto a digit the menu\nalready uses is rejected.", "operationId": "Call Routes V2_UpdateOption", "parameters": [ { "description": "The call route's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "call_route_id", "required": true, "schema": { "description": "The call route's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "description": "The option's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "The option's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "digit": "1", "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "prompt": "For an urgent production outage, press 1" }, "schema": { "$ref": "#/components/schemas/CallRoutesUpdateOptionPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "option": { "digit": "1", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "prompt": "For an urgent production outage, press 1" } }, "schema": { "$ref": "#/components/schemas/CallRoutesUpdateOptionResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Call Routes V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Call Route Options V2", "x-docs-resource-type": "CallRouteOptionV2", "x-mint": { "content": "🔑 Requires the `call_routes.update` scope." }, "x-rbac-scopes": [ "call_routes.update" ] } }, "/v2/call_routes/{id}": { "get": { "description": "Show a single call route.", "operationId": "Call Routes V2_Show", "parameters": [ { "description": "The call route's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "The call route's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "call_route": { "allowed_callers": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator duty desk", "phone_number": "+15551234567" } ], "country_code": "US", "created_at": "2021-08-17T13:28:57.801578Z", "current_state": "active", "custom_language": "en-US", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator urgent request", "options": [ { "digit": "1", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "prompt": "For an urgent production outage, press 1" } ], "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "phone_number": "+15551234567", "phone_number_type": "toll_free", "responder_caller_id": "route_number", "updated_at": "2021-08-17T13:28:57.801578Z", "use_caller_allowlist": true } }, "schema": { "$ref": "#/components/schemas/CallRoutesShowResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Call Routes V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Call Routes V2", "x-docs-resource-type": "CallRouteV2", "x-mint": { "content": "🔑 Requires the `call_routes.view` scope." }, "x-rbac-scopes": [ "call_routes.view" ] }, "put": { "description": "Replace a call route's configuration.\n\nSending a path retires any phone-tree menu on the route. Send an empty path to\nkeep the menu.", "operationId": "Call Routes V2_Update", "parameters": [ { "description": "The call route's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "The call route's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "custom_language": "en-US", "name": "Regulator urgent request", "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "responder_caller_id": "route_number", "use_caller_allowlist": true }, "schema": { "$ref": "#/components/schemas/CallRoutesUpdatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "call_route": { "allowed_callers": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator duty desk", "phone_number": "+15551234567" } ], "country_code": "US", "created_at": "2021-08-17T13:28:57.801578Z", "current_state": "active", "custom_language": "en-US", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator urgent request", "options": [ { "digit": "1", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "prompt": "For an urgent production outage, press 1" } ], "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "phone_number": "+15551234567", "phone_number_type": "toll_free", "responder_caller_id": "route_number", "updated_at": "2021-08-17T13:28:57.801578Z", "use_caller_allowlist": true } }, "schema": { "$ref": "#/components/schemas/CallRoutesUpdateResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Call Routes V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Call Routes V2", "x-docs-resource-type": "CallRouteV2", "x-mint": { "content": "🔑 Requires the `call_routes.update` scope." }, "x-rbac-scopes": [ "call_routes.update" ] } }, "/v2/call_sessions": { "get": { "description": "List Scribe call sessions, newest first, filtered by incident.", "operationId": "Call Sessions V2_List", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "A call session's ID. This endpoint will return a list of call sessions after this ID in relation to the API response order.", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "query", "name": "after", "schema": { "description": "A call session's ID. This endpoint will return a list of call sessions after this ID in relation to the API response order.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Incident whose call sessions you want to list", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "in": "query", "name": "incident_id", "required": true, "schema": { "description": "Incident whose call sessions you want to list", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "call_sessions": [ { "ended_at": "2021-08-17T14:28:57.801578Z", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "started_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/CallSessionsListResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Call Sessions V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Call Sessions V2", "x-docs-resource-type": "CallSessionV2", "x-mint": { "content": "🔑 Requires the `call_transcripts.view` scope." }, "x-rbac-scopes": [ "call_transcripts.view" ] } }, "/v2/call_transcript_entries": { "get": { "description": "List transcript entries for a call session, oldest first.\n\nReturns an empty list if your organisation has disabled viewing transcripts.", "operationId": "Call Transcript Entries V2_List", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "A transcript entry's ID. This endpoint will return a list of entries after this ID in relation to the API response order.", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "query", "name": "after", "schema": { "description": "A transcript entry's ID. This endpoint will return a list of entries after this ID in relation to the API response order.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Call session whose transcript entries you want to list", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "call_session_id", "required": true, "schema": { "description": "Call session whose transcript entries you want to list", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "call_transcript_entries": [ { "content": "I think we should roll back the deploy.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "medium": "spoken", "participant_name": "Alice Smith", "timestamp": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/CallTranscriptEntriesListResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Call Transcript Entries V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Call Transcript Entries V2", "x-docs-resource-type": "CallTranscriptEntryV2", "x-mint": { "content": "🔑 Requires the `call_transcripts.view` scope." }, "x-rbac-scopes": [ "call_transcripts.view" ] } }, "/v3/catalog_entries": { "get": { "description": "List entries for a catalog type.", "operationId": "Catalog V3_ListEntries", "parameters": [ { "allowEmptyValue": true, "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "catalog_type_id", "required": true, "schema": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "The integer number of records to return", "examples": { "default": { "summary": "default", "value": 25 } }, "in": "query", "name": "page_size", "required": true, "schema": { "default": 25, "description": "The integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "examples": { "default": { "summary": "default", "value": "01FDAG4SAP5TYPT98WGR2N7W91" } }, "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "allowEmptyValue": true, "description": "If specified, only entries with this identifier will be returned. This will search by ID, external ID, and aliases.\n\nIf 'use name as identifier' is enabled for the catalog type, this will also match on name.", "example": "abc123", "in": "query", "name": "identifier", "schema": { "description": "If specified, only entries with this identifier will be returned. This will search by ID, external ID, and aliases.\n\nIf 'use name as identifier' is enabled for the catalog type, this will also match on name.", "example": "abc123", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "catalog_entries": [ { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" } ], "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "engine_resource_type": "CatalogEntry[\"PagerDutyService\"]", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true }, "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 } }, "schema": { "$ref": "#/components/schemas/CatalogListEntriesResultV3" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List Entries", "tags": [ "Catalog V3" ], "x-docs-display-name": "List Entries", "x-docs-group-name": "Catalog Entries V3", "x-docs-resource-type": "CatalogEntryV3", "x-mint": { "content": "🔑 Requires the `catalog_entries.view` scope." }, "x-rbac-scopes": [ "catalog_entries.view" ] }, "post": { "description": "Create an entry within the catalog. We support a maximum of 50,000 entries per type.\n\nIf you call this API with a payload where the external_id and catalog_type_id match an existing entry, the existing entry will be updated.", "operationId": "Catalog V3_CreateEntry", "requestBody": { "content": { "application/json": { "example": { "aliases": [ "lawrence@incident.io", "lawrence" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "name": "Primary On-call", "rank": 3 }, "schema": { "$ref": "#/components/schemas/CatalogCreateEntryPayloadV3" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CatalogCreateEntryResultV3" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create Entry", "tags": [ "Catalog V3" ], "x-docs-display-name": "Create Entry", "x-docs-group-name": "Catalog Entries V3", "x-docs-resource-type": "CatalogEntryV3", "x-mint": { "content": "🔑 Requires the `catalog_entries.create` scope." }, "x-rbac-scopes": [ "catalog_entries.create" ] } }, "/v3/catalog_entries/{id}": { "delete": { "description": "Archives a catalog entry.", "operationId": "Catalog V3_DestroyEntry", "parameters": [ { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete Entry", "tags": [ "Catalog V3" ], "x-docs-display-name": "Delete Entry", "x-docs-group-name": "Catalog Entries V3", "x-docs-resource-type": "CatalogEntryV3", "x-mint": { "content": "🔑 Requires the `catalog_entries.destroy` scope." }, "x-rbac-scopes": [ "catalog_entries.destroy" ] }, "get": { "description": "Show a single catalog entry.", "operationId": "Catalog V3_ShowEntry", "parameters": [ { "allowEmptyValue": true, "description": "Whether to include details of all attribute links (forwards and backwards) within the response. Default behaviour (no query param) is to include only forward links. When expand is false, we only show attributes of the catalog entry itself.When expand is true, we show forward and backward links", "example": true, "in": "query", "name": "expand", "schema": { "description": "Whether to include details of all attribute links (forwards and backwards) within the response. Default behaviour (no query param) is to include only forward links. When expand is false, we only show attributes of the catalog entry itself.When expand is true, we show forward and backward links", "example": true, "type": "boolean" } }, { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" }, "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "engine_resource_type": "CatalogEntry[\"PagerDutyService\"]", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "schema": { "$ref": "#/components/schemas/CatalogShowEntryResultV3" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show Entry", "tags": [ "Catalog V3" ], "x-docs-display-name": "Show Entry", "x-docs-group-name": "Catalog Entries V3", "x-docs-resource-type": "CatalogEntryV3", "x-mint": { "content": "🔑 Requires the `catalog_entries.view` scope." }, "x-rbac-scopes": [ "catalog_entries.view" ] }, "put": { "description": "Updates an existing catalog entry.", "operationId": "Catalog V3_UpdateEntry", "parameters": [ { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "aliases": [ "lawrence@incident.io", "lawrence" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "name": "Primary On-call", "rank": 3, "update_attributes": [ "abc123" ] }, "schema": { "$ref": "#/components/schemas/CatalogUpdateEntryPayloadV3" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" }, "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "engine_resource_type": "CatalogEntry[\"PagerDutyService\"]", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "schema": { "$ref": "#/components/schemas/CatalogUpdateEntryResultV3" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update Entry", "tags": [ "Catalog V3" ], "x-docs-display-name": "Update Entry", "x-docs-group-name": "Catalog Entries V3", "x-docs-resource-type": "CatalogEntryV3", "x-mint": { "content": "🔑 Requires the `catalog_entries.edit` scope." }, "x-rbac-scopes": [ "catalog_entries.edit" ] } }, "/v3/catalog_entries/actions/bulk_update": { "post": { "description": "Update multiple catalog entries in a single operation. You can update up to 250 entries at once. This operation is atomic - either all entries are updated successfully, or none are updated.", "operationId": "Catalog V3_BulkUpdateEntries", "requestBody": { "content": { "application/json": { "example": { "catalog_type_id": "01GW2G3V0S59R238FAHPDS1R66", "entries": [ { "aliases": [ "abc123" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "entry_id": "abc123", "external_id": "abc123", "name": "abc123", "rank": 1 }, { "aliases": [ "abc123" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "entry_id": "abc123", "external_id": "abc123", "name": "abc123", "rank": 1 } ], "update_attributes": [ "01GW2G3V0S59R238FAHPDS1R66", "01GW2G3V0S59R238FAHPDS1R67" ] }, "schema": { "$ref": "#/components/schemas/CatalogBulkUpdateEntriesPayloadV3" } } }, "required": true }, "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Bulk Update Entries", "tags": [ "Catalog V3" ], "x-docs-display-name": "Bulk Update Entries", "x-docs-group-name": "Catalog Entries V3", "x-docs-resource-type": "CatalogEntryV3", "x-mint": { "content": "🔑 Requires the `catalog_entries.edit` scope." }, "x-rbac-scopes": [ "catalog_entries.edit" ] } }, "/v3/catalog_resources": { "get": { "description": "List available engine resources for the catalog.\n\nA resource represents a type of data that can be held within the catalog, so this\nendpoint can be used to see what attribute types can be used when updating the\nschema of a catalog type.\n", "operationId": "Catalog V3_ListResources", "responses": { "200": { "content": { "application/json": { "example": { "resources": [ { "category": "custom", "description": "Boolean true or false value", "engine_resource_type": "CatalogEntry[\"01GVGYJSD39FRKVDWACK9NDS4E\"]", "label": "GitHub Repository", "type": "Custom[\"Team\"]", "value_docstring": "Either the GraphQL node ID of the repository or a string of /, e.g. incident-io/website" } ] }, "schema": { "$ref": "#/components/schemas/CatalogListResourcesResultV3" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List Resources", "tags": [ "Catalog V3" ], "x-docs-display-name": "List Resources", "x-docs-group-name": "Catalog Resources V3", "x-docs-resource-type": "CatalogResourceV3", "x-mint": { "content": "🔑 Requires the `catalog_types.view` scope." }, "x-rbac-scopes": [ "catalog_types.view" ] } }, "/v3/catalog_types": { "get": { "description": "List all catalog types for an organisation, including those synced from external resources.", "operationId": "Catalog V3_ListTypes", "responses": { "200": { "content": { "application/json": { "example": { "catalog_types": [ { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "engine_resource_type": "CatalogEntry[\"PagerDutyService\"]", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } ] }, "schema": { "$ref": "#/components/schemas/CatalogListTypesResultV3" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List Types", "tags": [ "Catalog V3" ], "x-docs-display-name": "List Types", "x-docs-group-name": "Catalog Types V3", "x-docs-resource-type": "CatalogTypeV3", "x-mint": { "content": "🔑 Requires the `catalog_types.view` scope." }, "x-rbac-scopes": [ "catalog_types.view" ] }, "post": { "description": "Create a catalog type. The schema must be updated using the UpdateTypeSchema endpoint.", "operationId": "Catalog V3_CreateType", "requestBody": { "content": { "application/json": { "example": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "description": "Represents Kubernetes clusters that we run inside of GKE.", "icon": "alert", "name": "Kubernetes Cluster", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "ranked": true, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "use_name_as_identifier": true }, "schema": { "$ref": "#/components/schemas/CatalogCreateTypePayloadV3" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "engine_resource_type": "CatalogEntry[\"PagerDutyService\"]", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "schema": { "$ref": "#/components/schemas/CatalogCreateTypeResultV3" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create Type", "tags": [ "Catalog V3" ], "x-docs-display-name": "Create Type", "x-docs-group-name": "Catalog Types V3", "x-docs-resource-type": "CatalogTypeV3", "x-mint": { "content": "🔑 Requires the `catalog_types.create` scope." }, "x-rbac-scopes": [ "catalog_types.create" ] } }, "/v3/catalog_types/{id}": { "delete": { "description": "Archives a catalog type and associated entries.", "operationId": "Catalog V3_DestroyType", "parameters": [ { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete Type", "tags": [ "Catalog V3" ], "x-docs-display-name": "Delete Type", "x-docs-group-name": "Catalog Types V3", "x-docs-resource-type": "CatalogTypeV3", "x-mint": { "content": "🔑 Requires the `catalog_types.destroy` scope." }, "x-rbac-scopes": [ "catalog_types.destroy" ] }, "get": { "description": "Show a single catalog type.", "operationId": "Catalog V3_ShowType", "parameters": [ { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "engine_resource_type": "CatalogEntry[\"PagerDutyService\"]", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "schema": { "$ref": "#/components/schemas/CatalogShowTypeResultV3" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show Type", "tags": [ "Catalog V3" ], "x-docs-display-name": "Show Type", "x-docs-group-name": "Catalog Types V3", "x-docs-resource-type": "CatalogTypeV3", "x-mint": { "content": "🔑 Requires the `catalog_types.view` scope." }, "x-rbac-scopes": [ "catalog_types.view" ] }, "put": { "description": "Updates an existing catalog type. The schema must be updated using the UpdateTypeSchema endpoint.", "operationId": "Catalog V3_UpdateType", "parameters": [ { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "description": "Represents Kubernetes clusters that we run inside of GKE.", "icon": "alert", "name": "Kubernetes Cluster", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "ranked": true, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "use_name_as_identifier": true }, "schema": { "$ref": "#/components/schemas/CatalogUpdateTypePayloadV3" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "engine_resource_type": "CatalogEntry[\"PagerDutyService\"]", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "schema": { "$ref": "#/components/schemas/CatalogUpdateTypeResultV3" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update Type", "tags": [ "Catalog V3" ], "x-docs-display-name": "Update Type", "x-docs-group-name": "Catalog Types V3", "x-docs-resource-type": "CatalogTypeV3", "x-mint": { "content": "🔑 Requires the `catalog_types.edit` scope." }, "x-rbac-scopes": [ "catalog_types.edit" ] } }, "/v3/catalog_types/{id}/actions/update_schema": { "post": { "description": "Update an existing catalog types schema, adding or removing attributes.\n\nUpdating the schema is handled separately from creating and updating types, so that you don't\nhave to worry about dependencies between types. For example, if type A has an attribute that\nrelies on type B, you would have to create type B first.\n\nBy allowing the creation of types without a schema, they can be created in any order, but it\nmeans that you need to make a separate call to this endpoint to update the schema.", "operationId": "Catalog V3_UpdateTypeSchema", "parameters": [ { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "schema": { "$ref": "#/components/schemas/CatalogUpdateTypeSchemaPayloadV3" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "engine_resource_type": "CatalogEntry[\"PagerDutyService\"]", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "schema": { "$ref": "#/components/schemas/CatalogUpdateTypeSchemaResultV3" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update Type Schema", "tags": [ "Catalog V3" ], "x-docs-display-name": "Update Type Schema", "x-docs-group-name": "Catalog Types V3", "x-docs-resource-type": "CatalogTypeV3", "x-mint": { "content": "🔑 Requires the `catalog_types.edit` scope." }, "x-rbac-scopes": [ "catalog_types.edit" ] } }, "/v1/custom_field_options": { "get": { "description": "Show custom field options for a custom field", "operationId": "Custom Field Options V1_List", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "A custom field option's ID. This endpoint will return a list of custom field options created after this option.", "examples": { "default": { "summary": "default", "value": "01G0J1EXE7AXZ2C93K61WBPYEH" } }, "in": "query", "name": "after", "schema": { "description": "A custom field option's ID. This endpoint will return a list of custom field options created after this option.", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } }, { "allowEmptyValue": true, "description": "The custom field to list options for.", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "in": "query", "name": "custom_field_id", "required": true, "schema": { "description": "The custom field to list options for.", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "custom_field_options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/CustomFieldOptionsListResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Custom Field Options V1" ], "x-docs-display-name": "List", "x-docs-group-name": "Custom Field Options V1", "x-docs-resource-type": "CustomFieldOptionV1", "x-mint": { "content": "🔑 Requires the `custom_fields.view` scope." }, "x-rbac-scopes": [ "custom_fields.view" ] }, "post": { "description": "Create a custom field option. If the sort key is not supplied, it'll default to 1000, so the option appears near the end of the list.", "operationId": "Custom Field Options V1_Create", "requestBody": { "content": { "application/json": { "example": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "schema": { "$ref": "#/components/schemas/CustomFieldOptionsCreatePayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "custom_field_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } }, "schema": { "$ref": "#/components/schemas/CustomFieldOptionsCreateResultV1" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Custom Field Options V1" ], "x-docs-display-name": "Create", "x-docs-group-name": "Custom Field Options V1", "x-docs-resource-type": "CustomFieldOptionV1", "x-mint": { "content": "🔑 Requires the `organisation_settings.update` scope." }, "x-rbac-scopes": [ "organisation_settings.update" ] } }, "/v1/custom_field_options/{id}": { "delete": { "description": "Delete a custom field option", "operationId": "Custom Field Options V1_Delete", "parameters": [ { "description": "Unique identifier for the custom field option", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the custom field option", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Custom Field Options V1" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Custom Field Options V1", "x-docs-resource-type": "CustomFieldOptionV1", "x-mint": { "content": "🔑 Requires the `organisation_settings.update` scope." }, "x-rbac-scopes": [ "organisation_settings.update" ] }, "get": { "description": "Get a single custom field option", "operationId": "Custom Field Options V1_Show", "parameters": [ { "description": "Unique identifier for the custom field option", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the custom field option", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "custom_field_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } }, "schema": { "$ref": "#/components/schemas/CustomFieldOptionsShowResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Custom Field Options V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "Custom Field Options V1", "x-docs-resource-type": "CustomFieldOptionV1", "x-mint": { "content": "🔑 Requires the `custom_fields.view` scope." }, "x-rbac-scopes": [ "custom_fields.view" ] }, "put": { "description": "Update a custom field option", "operationId": "Custom Field Options V1_Update", "parameters": [ { "description": "Unique identifier for the custom field option", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the custom field option", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "sort_key": 10, "value": "Product" }, "schema": { "$ref": "#/components/schemas/CustomFieldOptionsUpdatePayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "custom_field_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } }, "schema": { "$ref": "#/components/schemas/CustomFieldOptionsUpdateResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Custom Field Options V1" ], "x-docs-display-name": "Update", "x-docs-group-name": "Custom Field Options V1", "x-docs-resource-type": "CustomFieldOptionV1", "x-mint": { "content": "🔑 Requires the `organisation_settings.update` scope." }, "x-rbac-scopes": [ "organisation_settings.update" ] } }, "/v2/custom_fields": { "get": { "description": "List all custom fields for an organisation.", "operationId": "Custom Fields V2_List", "responses": { "200": { "content": { "application/json": { "example": { "custom_fields": [ { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "fixed_filter": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "values": [ "01H2FW182TAH0NHEVBY34SCAK0", "01H2FW182TAH0NHEVBY34SCAK1" ] }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/CustomFieldsListResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Custom Fields V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Custom Fields V2", "x-docs-resource-type": "CustomFieldV2", "x-mint": { "content": "🔑 Requires the `custom_fields.view` scope." }, "x-rbac-scopes": [ "custom_fields.view" ] }, "post": { "description": "Create a new custom field", "operationId": "Custom Fields V2_Create", "requestBody": { "content": { "application/json": { "example": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "description": "Which team is impacted by this issue", "field_type": "single_select", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "fixed_filter": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "values": [ "01H2FW182TAH0NHEVBY34SCAK0", "01H2FW182TAH0NHEVBY34SCAK1" ] }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "name": "Affected Team" }, "schema": { "$ref": "#/components/schemas/CustomFieldsCreatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "fixed_filter": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "values": [ "01H2FW182TAH0NHEVBY34SCAK0", "01H2FW182TAH0NHEVBY34SCAK1" ] }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CustomFieldsCreateResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Custom Fields V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Custom Fields V2", "x-docs-resource-type": "CustomFieldV2", "x-mint": { "content": "🔑 Requires the `organisation_settings.update` scope." }, "x-rbac-scopes": [ "organisation_settings.update" ] } }, "/v2/custom_fields/{id}": { "delete": { "description": "Delete a custom field", "operationId": "Custom Fields V2_Delete", "parameters": [ { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Custom Fields V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Custom Fields V2", "x-docs-resource-type": "CustomFieldV2", "x-mint": { "content": "🔑 Requires the `organisation_settings.update` scope." }, "x-rbac-scopes": [ "organisation_settings.update" ] }, "get": { "description": "Get a single custom field.", "operationId": "Custom Fields V2_Show", "parameters": [ { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "fixed_filter": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "values": [ "01H2FW182TAH0NHEVBY34SCAK0", "01H2FW182TAH0NHEVBY34SCAK1" ] }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CustomFieldsShowResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Custom Fields V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Custom Fields V2", "x-docs-resource-type": "CustomFieldV2", "x-mint": { "content": "🔑 Requires the `custom_fields.view` scope." }, "x-rbac-scopes": [ "custom_fields.view" ] }, "put": { "description": "Update the details of a custom field", "operationId": "Custom Fields V2_Update", "parameters": [ { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "Which team is impacted by this issue", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "fixed_filter": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "values": [ "01H2FW182TAH0NHEVBY34SCAK0", "01H2FW182TAH0NHEVBY34SCAK1" ] }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "name": "Affected Team" }, "schema": { "$ref": "#/components/schemas/CustomFieldsUpdatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "fixed_filter": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "values": [ "01H2FW182TAH0NHEVBY34SCAK0", "01H2FW182TAH0NHEVBY34SCAK1" ] }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/CustomFieldsUpdateResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Custom Fields V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Custom Fields V2", "x-docs-resource-type": "CustomFieldV2", "x-mint": { "content": "🔑 Requires the `organisation_settings.update` scope." }, "x-rbac-scopes": [ "organisation_settings.update" ] } }, "/v2/escalation_path_templates": { "get": { "description": "List active escalation path templates.", "operationId": "Escalation Path Templates V2_List", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 25, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "allowEmptyValue": true, "description": "Search query to filter results by name.", "example": "Team on-call", "in": "query", "name": "search", "schema": { "description": "Search query to filter results by name.", "example": "Team on-call", "pattern": "^[^\u0000]*$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "escalation_path_templates": [ { "description": "abc123", "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "has_historical_escalation_path_versions": false, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Team on-call", "params": [ { "allowed_value_types": [ "literal" ], "array": true, "default_value": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "description": "What slack channel should we send the message to?", "label": "To date", "name": "severity", "optional": true, "type": "IncidentSeverity" } ], "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/EscalationPathTemplatesListResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Escalation Path Templates V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Escalation Path Templates V2", "x-docs-resource-type": "EscalationPathTemplateV2", "x-mint": { "content": "🔑 Requires the `escalation_path_templates.view` scope." }, "x-rbac-scopes": [ "escalation_path_templates.view" ] }, "post": { "description": "Create a new escalation path template.", "operationId": "Escalation Path Templates V2_Create", "requestBody": { "content": { "application/json": { "example": { "description": "Pages the team on-call, then a fallback user", "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "name": "Team on-call", "params": [ { "allowed_value_types": [ "literal" ], "array": true, "default_value": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "description": "What slack channel should we send the message to?", "label": "To date", "name": "severity", "optional": true, "type": "IncidentSeverity" } ], "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "schema": { "$ref": "#/components/schemas/EscalationPathTemplatesCreatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "escalation_path_template": { "description": "abc123", "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "has_historical_escalation_path_versions": false, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Team on-call", "params": [ { "allowed_value_types": [ "literal" ], "array": true, "default_value": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "description": "What slack channel should we send the message to?", "label": "To date", "name": "severity", "optional": true, "type": "IncidentSeverity" } ], "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } }, "schema": { "$ref": "#/components/schemas/EscalationPathTemplatesCreateResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Escalation Path Templates V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Escalation Path Templates V2", "x-docs-resource-type": "EscalationPathTemplateV2", "x-mint": { "content": "🔑 Requires the `escalation_path_templates.create` scope." }, "x-rbac-scopes": [ "escalation_path_templates.create" ] } }, "/v2/escalation_path_templates/{id}": { "delete": { "description": "Archives a particular escalation path template.", "operationId": "Escalation Path Templates V2_Destroy", "parameters": [ { "description": "Unique identifier for this template.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for this template.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Escalation Path Templates V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Escalation Path Templates V2", "x-docs-resource-type": "EscalationPathTemplateV2", "x-mint": { "content": "🔑 Requires the `escalation_path_templates.destroy` scope." }, "x-rbac-scopes": [ "escalation_path_templates.destroy" ] }, "get": { "description": "Show a particular escalation path template.", "operationId": "Escalation Path Templates V2_Show", "parameters": [ { "description": "Unique identifier for this template.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for this template.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "escalation_path_template": { "description": "abc123", "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "has_historical_escalation_path_versions": false, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Team on-call", "params": [ { "allowed_value_types": [ "literal" ], "array": true, "default_value": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "description": "What slack channel should we send the message to?", "label": "To date", "name": "severity", "optional": true, "type": "IncidentSeverity" } ], "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } }, "schema": { "$ref": "#/components/schemas/EscalationPathTemplatesShowResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Escalation Path Templates V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Escalation Path Templates V2", "x-docs-resource-type": "EscalationPathTemplateV2", "x-mint": { "content": "🔑 Requires the `escalation_path_templates.view` scope." }, "x-rbac-scopes": [ "escalation_path_templates.view" ] }, "put": { "description": "Update a particular escalation path template.", "operationId": "Escalation Path Templates V2_Update", "parameters": [ { "description": "Unique identifier for this template.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for this template.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "Pages the team on-call, then a fallback user", "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "name": "Team on-call", "params": [ { "allowed_value_types": [ "literal" ], "array": true, "default_value": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "description": "What slack channel should we send the message to?", "label": "To date", "name": "severity", "optional": true, "type": "IncidentSeverity" } ], "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "schema": { "$ref": "#/components/schemas/EscalationPathTemplatesUpdatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "escalation_path_template": { "description": "abc123", "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "has_historical_escalation_path_versions": false, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Team on-call", "params": [ { "allowed_value_types": [ "literal" ], "array": true, "default_value": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "description": "What slack channel should we send the message to?", "label": "To date", "name": "severity", "optional": true, "type": "IncidentSeverity" } ], "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } }, "schema": { "$ref": "#/components/schemas/EscalationPathTemplatesUpdateResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Escalation Path Templates V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Escalation Path Templates V2", "x-docs-resource-type": "EscalationPathTemplateV2", "x-mint": { "content": "🔑 Requires the `escalation_path_templates.update` scope." }, "x-rbac-scopes": [ "escalation_path_templates.update" ] } }, "/v2/escalation_paths": { "get": { "description": "List all escalation paths in your account.\n\nAn escalation path is a series of steps that describe how a page should be escalated,\nrepresented as a graph, supporting conditional branches based on alert priority and\nworking intervals.\n", "operationId": "Escalations V2_ListPaths", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 25, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "escalation_paths": [ { "current_responders": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "kind": "templated", "name": "Urgent Support", "param_bindings": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "template_id": "01FCNDV6P870EA6S7TK1DSYDG0", "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/EscalationsListPathsResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Escalations V2" ], "x-display-name": "List", "x-docs-display-name": "List", "x-docs-group-name": "Escalation Paths V2", "x-docs-resource-type": "EscalationPathV2", "x-mint": { "content": "🔑 Requires the `escalation_paths.view` scope." }, "x-rbac-scopes": [ "escalation_paths.view" ] }, "post": { "description": "Create an escalation path.\n\nAn escalation path is a series of steps that describe how a page should be escalated,\nrepresented as graph, supporting conditional branches based on alert priority and working\nintervals.\n\nWe recommend you create escalation paths in the incident.io dashboard where our path\nbuilder makes it easy to use conditions and visualise the path.\n", "operationId": "Escalations V2_CreatePath", "requestBody": { "content": { "application/json": { "example": { "kind": "templated", "name": "Urgent Support", "param_bindings": { "abc123": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "template_id": "01FCNDV6P870EA6S7TK1DSYDG0", "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "schema": { "$ref": "#/components/schemas/EscalationsCreatePathPayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "escalation_path": { "current_responders": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "kind": "templated", "name": "Urgent Support", "param_bindings": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "template_id": "01FCNDV6P870EA6S7TK1DSYDG0", "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } }, "schema": { "$ref": "#/components/schemas/EscalationsCreatePathResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Escalations V2" ], "x-display-name": "Create", "x-docs-display-name": "Create", "x-docs-group-name": "Escalation Paths V2", "x-docs-resource-type": "EscalationPathV2", "x-mint": { "content": "🔑 Requires the `escalation_paths.create` scope." }, "x-rbac-scopes": [ "escalation_paths.create" ] } }, "/v2/escalation_paths/{id}": { "delete": { "description": "Archives an escalation path.\n\nWe recommend you create escalation paths in the incident.io dashboard where our path\nbuilder makes it easy to use conditions and visualise the path.\n", "operationId": "Escalations V2_DestroyPath", "parameters": [ { "description": "Unique identifier for this escalation path.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for this escalation path.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Escalations V2" ], "x-display-name": "Destroy", "x-docs-display-name": "Delete", "x-docs-group-name": "Escalation Paths V2", "x-docs-resource-type": "EscalationPathV2", "x-mint": { "content": "🔑 Requires the `escalation_paths.destroy` scope." }, "x-rbac-scopes": [ "escalation_paths.destroy" ] }, "get": { "description": "Show an escalation path.\n\nWe recommend you create escalation paths in the incident.io dashboard where our path\nbuilder makes it easy to use conditions and visualise the path.\n", "operationId": "Escalations V2_ShowPath", "parameters": [ { "description": "Unique identifier for this escalation path.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for this escalation path.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "escalation_path": { "current_responders": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "kind": "templated", "name": "Urgent Support", "param_bindings": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "template_id": "01FCNDV6P870EA6S7TK1DSYDG0", "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } }, "schema": { "$ref": "#/components/schemas/EscalationsShowPathResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Escalations V2" ], "x-display-name": "Show", "x-docs-display-name": "Show", "x-docs-group-name": "Escalation Paths V2", "x-docs-resource-type": "EscalationPathV2", "x-mint": { "content": "🔑 Requires the `escalation_paths.view` scope." }, "x-rbac-scopes": [ "escalation_paths.view" ] }, "put": { "description": "Updates an escalation path.\n\nWe recommend you create escalation paths in the incident.io dashboard where our path\nbuilder makes it easy to use conditions and visualise the path.\n", "operationId": "Escalations V2_UpdatePath", "parameters": [ { "description": "Unique identifier for this escalation path.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for this escalation path.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "kind": "templated", "name": "Urgent Support", "param_bindings": { "abc123": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "template_id": "01FCNDV6P870EA6S7TK1DSYDG0", "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "schema": { "$ref": "#/components/schemas/EscalationsUpdatePathPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "escalation_path": { "current_responders": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "kind": "templated", "name": "Urgent Support", "param_bindings": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "template_id": "01FCNDV6P870EA6S7TK1DSYDG0", "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } }, "schema": { "$ref": "#/components/schemas/EscalationsUpdatePathResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Escalations V2" ], "x-display-name": "Update", "x-docs-display-name": "Update", "x-docs-group-name": "Escalation Paths V2", "x-docs-resource-type": "EscalationPathV2", "x-mint": { "content": "🔑 Requires the `escalation_paths.update` scope." }, "x-rbac-scopes": [ "escalation_paths.update" ] } }, "/v2/escalations": { "get": { "description": "List all escalations for your account.\n\nThis endpoint supports a number of filters, which can help find escalations matching certain\ncriteria.\n\nNote that:\n- Filters may be used together, and the result will be escalations that match all filters.\n- All query parameters must be URI encoded.\n\nTo use this API, you will need an API key with the \"View data\" or \"Create and manage on-call resources\" permission.\n\n### By escalation_path\n\nFind all escalations that escalated to escalation path with id=ABC:\n\n```bash\ncurl --get 'https://api.incident.io/v2/escalations' \\\n--data 'escalation_path[one_of]=ABC'\n```\n\n### By status\n\nFind all escalations with a current status of \"triggered\":\n\n```bash\ncurl --get 'https://api.incident.io/v2/escalations' \\\n--data 'status[one_of]=triggered'\n```\n\nPossible values are \"pending\", \"triggered\", \"acked\", \"resolved\", \"expired\" and \"cancelled\".\nEscalations are in \"pending\" when they are in a grace period when the related alert has\nbeen grouped in an incident.\n\n### By alert\n\nFind all escalations that were created by alert with id=ABC:\n\n```bash\ncurl --get 'https://api.incident.io/v2/escalations' \\\n--data 'alert[one_of]=ABC'\n```\n\n### By incident\n\nFind all escalations related to incident with id=ABC:\n\n```bash\ncurl --get 'https://api.incident.io/v2/escalations' \\\n--data 'incident[one_of]=ABC'\n```\n\nAn escalation is related to an incident if it is linked to that incident directly, if it is\nattached to one of the incident's alerts, or if it triggered one of those alerts (which is\nwhat happens when someone pages by calling in, and that call raises the alert).\n\nTo find everything that is not related to an incident, use \"not_in\":\n\n```bash\ncurl --get 'https://api.incident.io/v2/escalations' \\\n--data 'incident[not_in]=ABC'\n```\n\n### By created_at and updated_at\nFind all escalations that follow specified date parameters for created_at and updated_at fields.\nPossible values are \"gte\" (greater than or equal to), \"lte\" (less than or equal to), and\n\"date_range\" (between two dates).\nFor example, to find all escalations updated after 2025-01-01:\n\n```bash\ncurl --get 'https://api.incident.io/v2/escalations' \\\n--data 'updated_at[gte]=2025-01-01'\n```\n\nTo find all escalations created between 2025-01-01 and 2025-01-31:\n\n```bash\ncurl --get 'https://api.incident.io/v2/escalations' \\\n```\n --data 'created_at[date_range]=2025-01-01~2025-01-31'\n", "operationId": "Escalations V2_List", "parameters": [ { "allowEmptyValue": true, "description": "Number of escalations to return per page", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Number of escalations to return per page", "example": 25, "format": "int64", "maximum": 50, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "An escalation's ID. This endpoint will return a list of escalations after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An escalation's ID. This endpoint will return a list of escalations after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter on the escalation path for which the escalation was triggered. Accepted operators are 'one_of' and 'not_in'.", "example": { "one_of": [ "01J479052SSQAA4531ASFPR3BF" ] }, "in": "query", "name": "escalation_path", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on the escalation path for which the escalation was triggered. Accepted operators are 'one_of' and 'not_in'.", "example": { "one_of": [ "01J479052SSQAA4531ASFPR3BF" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on the status of the escalation. Accepted operators are 'one_of' and 'not_in'.", "example": { "one_of": [ "triggered" ] }, "in": "query", "name": "status", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on the status of the escalation. Accepted operators are 'one_of' and 'not_in'.", "example": { "one_of": [ "triggered" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on the alert that created an escalation. Accepted operators are 'one_of' and 'not_in'.", "example": { "one_of": [ "01J479052SSQAA4531ASFPR3BF" ] }, "in": "query", "name": "alert", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on the alert that created an escalation. Accepted operators are 'one_of' and 'not_in'.", "example": { "one_of": [ "01J479052SSQAA4531ASFPR3BF" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on the incident that the escalation is connected to. Accepted operators are 'one_of' and 'not_in'.", "example": { "one_of": [ "01J479052SSQAA4531ASFPR3BF" ] }, "in": "query", "name": "incident", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on the incident that the escalation is connected to. Accepted operators are 'one_of' and 'not_in'.", "example": { "one_of": [ "01J479052SSQAA4531ASFPR3BF" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on the created_at timestamp of the escalation. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2021-08-17" ] }, "in": "query", "name": "created_at", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on the created_at timestamp of the escalation. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2021-08-17" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on the updated_at timestamp of the escalation. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2021-08-17" ] }, "in": "query", "name": "updated_at", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on the updated_at timestamp of the escalation. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2021-08-17" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on the idempotency key of the escalation. This is the key set when creating escalations via the API, and is distinct from alert deduplication keys. Accepted operators are 'is' for exact matches and 'starts_with' for prefix matching.", "example": { "starts_with": [ "team-a:" ] }, "in": "query", "name": "idempotency_key", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on the idempotency key of the escalation. This is the key set when creating escalations via the API, and is distinct from alert deduplication keys. Accepted operators are 'is' for exact matches and 'starts_with' for prefix matching.", "example": { "starts_with": [ "team-a:" ] }, "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "example": { "escalations": [ { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Database CPU has been above 90% for 5 minutes", "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" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/EscalationsListResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Escalations V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Escalations V2", "x-docs-resource-type": "EscalationV2", "x-mint": { "content": "🔑 Requires the `escalations.view` scope." }, "x-rbac-scopes": [ "escalations.view" ] }, "post": { "description": "Create an escalation.\n\nAn escalation pages people, either according to an escalation path, or directly to\nspecific users. You must provide either an escalation_path_id OR user_ids, but not both.\n\nWhen escalating via an escalation path, the escalation will follow the configured path\nwith its levels and timeouts, using your default [alert\npriority](https://app.incident.io/~/settings/alerts/configuration/priorities).\n\nWhen escalating directly to users, they will receive a high-urgency\nnotification, based on their notification rules.\n\nThis endpoint is rate-limited to 60 requests per minute, since it is intended for\ninteractive use cases (for example someone clicking a \"escalate to team\" button\nin your internal developer platform). To escalate based on automated alerts, we\nrecommend sending events to an alert source instead.\n\nIf your API key's permissions are scoped to teams, you can only escalate via an\nescalation path that one of those teams owns. Escalating directly to user_ids\nneeds the permission at the account level, because an escalation aimed at a\nperson has no owning team.\n", "operationId": "Escalations V2_Create", "requestBody": { "content": { "application/json": { "example": { "description": "Database CPU has been above 90% for 5 minutes", "escalation_path_id": "01H0J1EXE7AXZ2C93K61WBPYEH", "idempotency_key": "2024-01-15-abc123", "incident_id": "01H0J1EXE7AXZ2C93K61WBPYEH", "title": "Production database experiencing high CPU", "user_ids": [ "01H0J1EXE7AXZ2C93K61WBPYEH", "01H0J1EXE7AXZ2C93K61WBPYEI" ] }, "schema": { "$ref": "#/components/schemas/EscalationsCreatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "escalation": { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Database CPU has been above 90% for 5 minutes", "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/EscalationsCreateResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Escalations V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Escalations V2", "x-docs-resource-type": "EscalationV2", "x-mint": { "content": "🔑 Requires the `escalations.create` scope." }, "x-rbac-scopes": [ "escalations.create" ] } }, "/v2/escalations/{escalation_id}/actions/check_permissions": { "post": { "description": "Check whether the given users can currently acknowledge, decline, or snooze an escalation.\n\nThis is a read-only projection of the escalation's current state, intended for deciding\nwhich response actions to surface to each user in a custom integration.\n\nTo use this API, you will need an API key that can view escalations and users.", "operationId": "Escalations V2_CheckEscalationPermissions", "parameters": [ { "description": "The ID of the escalation", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "in": "path", "name": "escalation_id", "required": true, "schema": { "description": "The ID of the escalation", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "user_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ] }, "schema": { "$ref": "#/components/schemas/EscalationsCheckEscalationPermissionsPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "response_options": [ { "available_actions": [ "ack", "nack", "snooze" ], "user_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ] }, "schema": { "$ref": "#/components/schemas/EscalationsCheckEscalationPermissionsResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Check permissions", "tags": [ "Escalations V2" ], "x-docs-display-name": "Check permissions", "x-docs-group-name": "Escalations V2", "x-docs-resource-type": "EscalationV2", "x-mint": { "content": "🔑 Requires the `escalations.view` and `users.view` scopes." }, "x-rbac-scopes": [ "escalations.view", "users.view" ] } }, "/v2/escalations/{escalation_id}/actions/reassign": { "post": { "description": "Reassign an escalation to a different escalation path or set of users.\n\nUse this when a page reached the wrong people. Reassigning creates a new escalation\naimed at the targets you give, linked back to the original, and carries over the\noriginal's title, description, priority, incident and alert so the page stays attached\nto the same alert and acknowledgements keep grouping under it.\n\nYou must provide either an escalation_path_id OR user_ids, but not both. Both name\nincident.io escalation paths and users, so an escalation cannot be reassigned to an\nexternal escalator such as PagerDuty or Opsgenie.\n\nBy default the original escalation is resolved, so the first targets stop being paged.\nPass resolve_original=false to leave it running alongside the new one. Resolving the\noriginal additionally needs the \"escalations.respond\" permission, since it stops a page\nsomeone else may be responding to.\n\nAn escalation can only be reassigned once: calling this again for the same escalation\nis rejected. Retrying a request whose response you never saw is safe in the sense that\nmatters — a reassignment that already happened is never repeated, so nobody is paged\ntwice — but the retry is rejected rather than returning the escalation the first call\ncreated, so keep the ID from the original response.\n\nTo use this API, you will need an API key with the \"Create and manage escalations\"\npermission. The reassignment is attributed to the key; to attribute it to one of your\nusers instead, set the X-Incident-User header, which needs the\n\"api_keys.act_on_behalf_of_users\" scope.\n\nIf your API key's permissions are scoped to teams, the escalation you're reassigning\nmust be owned by one of those teams, and you can only reassign via an escalation path\none of them owns. Reassigning directly to user_ids needs the permission at the account\nlevel, because an escalation aimed at a person has no owning team.", "operationId": "Escalations V2_ReassignEscalation", "parameters": [ { "description": "The ID of the escalation to reassign", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "in": "path", "name": "escalation_id", "required": true, "schema": { "description": "The ID of the escalation to reassign", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "Database CPU has been above 90% for 5 minutes", "escalation_path_id": "01H0J1EXE7AXZ2C93K61WBPYEH", "resolve_original": true, "title": "Production database experiencing high CPU", "user_ids": [ "01H0J1EXE7AXZ2C93K61WBPYEH", "01H0J1EXE7AXZ2C93K61WBPYEI" ] }, "schema": { "$ref": "#/components/schemas/EscalationsReassignEscalationPayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "escalation": { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Database CPU has been above 90% for 5 minutes", "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/EscalationsReassignEscalationResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Reassign", "tags": [ "Escalations V2" ], "x-docs-display-name": "Reassign", "x-docs-group-name": "Escalations V2", "x-docs-resource-type": "EscalationV2", "x-mint": { "content": "🔑 Requires the `escalations.create` scope." }, "x-rbac-scopes": [ "escalations.create" ] } }, "/v2/escalations/{escalation_id}/actions/respond": { "post": { "description": "Respond to an escalation.\n\nAn API key can acknowledge or snooze an escalation on its own, and the response is\nattributed to the key.\n\nDeclining (\"nack\") means \"I personally can't take this page\", so it isn't available to\nan API key responding in its own right.\n\nTo use this API, you will need an API key with the \"Create and manage escalations\" permission.", "operationId": "Escalations V2_RespondEscalation", "parameters": [ { "description": "The ID of the escalation", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "in": "path", "name": "escalation_id", "required": true, "schema": { "description": "The ID of the escalation", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "response": "ack", "snooze_details": { "reason": "Waiting for deployment to complete", "snooze_until": "2025-01-01T12:00:00Z" } }, "schema": { "$ref": "#/components/schemas/EscalationsRespondEscalationPayloadV2" } } }, "required": true }, "responses": { "200": { "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Respond", "tags": [ "Escalations V2" ], "x-docs-display-name": "Respond", "x-docs-group-name": "Escalations V2", "x-docs-resource-type": "EscalationV2", "x-mint": { "content": "🔑 Requires the `escalations.respond` scope." }, "x-rbac-scopes": [ "escalations.respond" ] } }, "/v2/escalations/{id}": { "get": { "description": "Show a specific escalation.", "operationId": "Escalations V2_Show", "parameters": [ { "description": "Unique ID of the escalation", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique ID of the escalation", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "escalation": { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Database CPU has been above 90% for 5 minutes", "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/EscalationsShowResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Escalations V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Escalations V2", "x-docs-resource-type": "EscalationV2", "x-mint": { "content": "🔑 Requires the `escalations.view` scope." }, "x-rbac-scopes": [ "escalations.view" ] } }, "/v2/escalations/{id}/actions/cancel": { "post": { "description": "Cancel an escalation.\n\nCancelling an escalation stops any further paging: notifications cease and the\nescalation will not advance to further levels or repeat. This works on escalations\nthat are still paging (for example to silence a page when an incident is resolved\nbefore anyone acknowledges it) as well as snoozed ones. Escalations that have already\nresolved or expired cannot be cancelled, and cancelling an already-cancelled\nescalation is a no-op.\n\nTo use this API, you will need an API key with the \"Create and manage escalations\" permission.", "operationId": "Escalations V2_CancelEscalation", "parameters": [ { "description": "Unique ID of the escalation", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique ID of the escalation", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } } ], "responses": { "200": { "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Cancel", "tags": [ "Escalations V2" ], "x-docs-display-name": "Cancel", "x-docs-group-name": "Escalations V2", "x-docs-resource-type": "EscalationV2", "x-mint": { "content": "🔑 Requires the `escalations.cancel` scope." }, "x-rbac-scopes": [ "escalations.cancel" ] } }, "/v3/follow_ups": { "get": { "description": "List follow-ups for an organisation.\n\nResults are paginated and ordered by follow-up ID, oldest first. Use the after\nvalue from pagination_meta to fetch the next page; it is only set when there\nmay be more results.\n\n### By created_at and updated_at\n\nBoth timestamp filters accept the operators \"gte\" (greater than or equal to), \"lte\" (less\nthan or equal to) and \"date_range\" (between two dates). The following example finds all\nfollow-ups updated after 2025-01-01:\n\n```bash\ncurl --get 'https://api.incident.io/v3/follow_ups' \\\n--data 'updated_at[gte]=2025-01-01T00:00:00Z'\n```\n\nTo find follow-ups created within a specific date range, use the date_range operator with\ntilde-separated dates:\n\n```bash\ncurl --get 'https://api.incident.io/v3/follow_ups' \\\n--data 'created_at[date_range]=2024-12-02~2024-12-08'\n```\n\nFiltering on updated_at is useful for incrementally syncing follow-ups: poll with\nupdated_at[gte] set to your last sync time instead of re-fetching the full history. Two\ncaveats: updated_at moves whenever the follow-up row itself is written, but changes to\nembedded objects (e.g. an assignee being renamed, or an external issue's status text) can\nalter the payload without bumping it. And timestamps are stamped before commit, so a\nfollow-up can become visible with an older updated_at than rows you have already seen —\noverlap your sync window by a few minutes to allow for writes that commit out of\ntimestamp order.\n", "operationId": "Follow-ups V3_List", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "A follow-up's ID. This endpoint will return a list of follow-ups after this ID in relation to the API response order.", "examples": { "default": { "summary": "default", "value": "01FDAG4SAP5TYPT98WGR2N7W91" } }, "in": "query", "name": "after", "schema": { "description": "A follow-up's ID. This endpoint will return a list of follow-ups after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "allowEmptyValue": true, "description": "Find follow-ups related to this incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "incident_id", "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter to follow-ups from incidents of the given mode. If not set, only follow-ups from `standard` and `retrospective` incidents are returned", "example": "standard", "in": "query", "name": "incident_mode", "schema": { "description": "Filter to follow-ups from incidents of the given mode. If not set, only follow-ups from `standard` and `retrospective` incidents are returned", "enum": [ "standard", "retrospective", "test", "tutorial", "stream" ], "example": "standard", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter follow-ups that are assigned to the given team", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "assignee_team_id", "schema": { "description": "Filter follow-ups that are assigned to the given team", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter on follow-up created at timestamp. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2025-01-01" ] }, "in": "query", "name": "created_at", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on follow-up created at timestamp. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2025-01-01" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on follow-up updated at timestamp. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2025-01-01" ] }, "in": "query", "name": "updated_at", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on follow-up updated at timestamp. Accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "gte": [ "2025-01-01" ] }, "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "example": { "follow_ups": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "category": { "description": "Follow-ups related to infrastructure changes.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Infrastructure", "rank": 10 }, "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" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/FollowUpsListResultV3" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Follow-ups V3" ], "x-docs-display-name": "List", "x-docs-group-name": "Follow-ups V3", "x-docs-resource-type": "FollowUpV3", "x-mint": { "content": "🔑 Requires the `actions.view` scope." }, "x-rbac-scopes": [ "actions.view" ] }, "post": { "description": "Create a new incident follow-up.", "operationId": "Follow-ups V3_Create", "requestBody": { "content": { "application/json": { "example": { "assignee_id": "01FCNDV6P870EA6S7TK1DSYDG0", "assignee_team_id": "01FCNDV6P870EA6S7TK1DSYDG0", "description": "Call the fire brigade", "external_issue_reference_id": "01FCNDV6P870EA6S7TK1DSYDG0", "follow_up_category_id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "follow_up_priority_option_id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "labels": [ "bug", "urgent" ], "title": "Add alerting on replica lag" }, "schema": { "$ref": "#/components/schemas/FollowUpsCreatePayloadV3" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "follow_up": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "category": { "description": "Follow-ups related to infrastructure changes.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Infrastructure", "rank": 10 }, "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/FollowUpsCreateResultV3" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Follow-ups V3" ], "x-docs-display-name": "Create", "x-docs-group-name": "Follow-ups V3", "x-docs-resource-type": "FollowUpV3", "x-mint": { "content": "🔑 Requires the `follow_ups.create` scope." }, "x-rbac-scopes": [ "follow_ups.create" ] } }, "/v3/follow_ups/{id}": { "delete": { "description": "Delete an incident follow-up.", "operationId": "Follow-ups V3_Delete", "parameters": [ { "description": "Unique identifier for the follow-up", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "path", "name": "id", "required": true, "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Follow-ups V3" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Follow-ups V3", "x-docs-resource-type": "FollowUpV3", "x-mint": { "content": "🔑 Requires the `follow_ups.destroy` scope." }, "x-rbac-scopes": [ "follow_ups.destroy" ] }, "get": { "description": "Get a single incident follow-up.", "operationId": "Follow-ups V3_Show", "parameters": [ { "description": "Unique identifier for the follow-up", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "path", "name": "id", "required": true, "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "follow_up": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "category": { "description": "Follow-ups related to infrastructure changes.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Infrastructure", "rank": 10 }, "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/FollowUpsShowResultV3" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Follow-ups V3" ], "x-docs-display-name": "Show", "x-docs-group-name": "Follow-ups V3", "x-docs-resource-type": "FollowUpV3", "x-mint": { "content": "🔑 Requires the `actions.view` scope." }, "x-rbac-scopes": [ "actions.view" ] }, "put": { "description": "Update an existing incident follow-up.", "operationId": "Follow-ups V3_Update", "parameters": [ { "description": "Unique identifier for the follow-up", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "assignee_id": "01FCNDV6P870EA6S7TK1DSYDG0", "assignee_team_id": "01FCNDV6P870EA6S7TK1DSYDG0", "description": "Call the fire brigade", "follow_up_category_id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "follow_up_priority_option_id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "labels": [ "bug", "urgent" ], "status": "outstanding", "title": "Add alerting on replica lag" }, "schema": { "$ref": "#/components/schemas/FollowUpsUpdatePayloadV3" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "follow_up": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "category": { "description": "Follow-ups related to infrastructure changes.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Infrastructure", "rank": 10 }, "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/FollowUpsUpdateResultV3" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Follow-ups V3" ], "x-docs-display-name": "Update", "x-docs-group-name": "Follow-ups V3", "x-docs-resource-type": "FollowUpV3", "x-mint": { "content": "🔑 Requires the `follow_ups.update` scope." }, "x-rbac-scopes": [ "follow_ups.update" ] } }, "/v3/follow_ups/{id}/actions/connect_external_issue": { "post": { "description": "Connect a follow-up to an existing issue in an issue tracker, using the URL of the issue.\n\nThis will not work if the follow-up is already connected to an external issue.\n", "operationId": "Follow-ups V3_ConnectExternalIssue", "parameters": [ { "description": "Unique identifier for the follow-up", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "path", "name": "id", "required": true, "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "provider": "linear", "url": "https://linear.app/incident/issue/INC-123" }, "schema": { "$ref": "#/components/schemas/FollowUpsConnectExternalIssuePayloadV3" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "follow_up": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "category": { "description": "Follow-ups related to infrastructure changes.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Infrastructure", "rank": 10 }, "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/FollowUpsConnectExternalIssueResultV3" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Connect external issue", "tags": [ "Follow-ups V3" ], "x-docs-display-name": "Connect external issue", "x-docs-group-name": "Follow-ups V3", "x-docs-resource-type": "FollowUpV3", "x-mint": { "content": "🔑 Requires the `follow_ups.connect_external_issue` scope." }, "x-rbac-scopes": [ "follow_ups.connect_external_issue" ] } }, "/v2/heartbeat/{alert_source_config_id}/ping": { "get": { "description": "Send a heartbeat ping for the specified alert source.\n\nRecords a ping, indicating that the monitored job or service is healthy. The\nheartbeat monitor uses these pings to detect missed heartbeats and fire alerts.\nBoth GET and POST are accepted\n", "operationId": "Heartbeat V2_Ping#1", "parameters": [ { "allowEmptyValue": true, "description": "Token provided via the token query parameter", "example": "some-random-string", "in": "query", "name": "token", "schema": { "description": "Token provided via the token query parameter", "example": "some-random-string", "type": "string" } }, { "description": "The alert source config this heartbeat ping is for", "example": "01GW2G3V0S59R238FAHPDS1R66", "in": "path", "name": "alert_source_config_id", "required": true, "schema": { "description": "The alert source config this heartbeat ping is for", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" } }, { "allowEmptyValue": true, "description": "Bearer token provided via the Authorization header", "example": "Bearer some-random-string", "in": "header", "name": "authorization", "schema": { "description": "Bearer token provided via the Authorization header", "example": "Bearer some-random-string", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Ping (GET)", "tags": [ "Heartbeat V2" ], "x-docs-display-name": "Ping", "x-docs-group-name": "Heartbeat V2" }, "post": { "description": "Send a heartbeat ping for the specified alert source.\n\nRecords a ping, indicating that the monitored job or service is healthy. The\nheartbeat monitor uses these pings to detect missed heartbeats and fire alerts.\nBoth GET and POST are accepted\n", "operationId": "Heartbeat V2_Ping", "parameters": [ { "allowEmptyValue": true, "description": "Token provided via the token query parameter", "example": "some-random-string", "in": "query", "name": "token", "schema": { "description": "Token provided via the token query parameter", "example": "some-random-string", "type": "string" } }, { "description": "The alert source config this heartbeat ping is for", "example": "01GW2G3V0S59R238FAHPDS1R66", "in": "path", "name": "alert_source_config_id", "required": true, "schema": { "description": "The alert source config this heartbeat ping is for", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" } }, { "allowEmptyValue": true, "description": "Bearer token provided via the Authorization header", "example": "Bearer some-random-string", "in": "header", "name": "authorization", "schema": { "description": "Bearer token provided via the Authorization header", "example": "Bearer some-random-string", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Ping (POST)", "tags": [ "Heartbeat V2" ], "x-docs-display-name": "Ping", "x-docs-group-name": "Heartbeat V2" } }, "/v2/incident_activity_log_entries": { "get": { "description": "List the activity log entries for an incident, oldest first.\n\nIf the incident has streams, this returns their entries too, and incident_id on each entry\ntells you which stream it came from.\n\nPlatform noise is left out: channel joins and leaves, chat messages and call transcript\nfragments are recorded internally but never returned here.\n", "operationId": "Incident Activity Log Entries V2_List", "parameters": [ { "allowEmptyValue": true, "description": "Incident whose activity you want to list", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "in": "query", "name": "incident_id", "required": true, "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } }, { "allowEmptyValue": true, "description": "Return only the entries with these IDs", "example": [ "01FCNDV6P870EA6S7TK1DSYDG0", "01FCNDV6P870EA6S7TK1DSYDG1" ], "in": "query", "name": "id", "schema": { "description": "Return only the entries with these IDs", "example": [ "01FCNDV6P870EA6S7TK1DSYDG0", "01FCNDV6P870EA6S7TK1DSYDG1" ], "items": { "example": "abc123", "type": "string" }, "maxItems": 100, "type": "array" } }, { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "An entry's ID. This endpoint returns the entries that follow it.", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "query", "name": "after", "schema": { "description": "An entry's ID. This endpoint returns the entries that follow it.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_activity_log_entries": [ { "content": { "action_created": { "action_id": "01FCNDV6P870EA6S7TK1DSYDG0", "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" } } }, "action_updated": { "action_id": "01FCNDV6P870EA6S7TK1DSYDG0", "new_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "new_status": "completed", "previous_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "previous_status": "outstanding", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "alert_attached_to_incident": { "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" } }, "alert_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "custom_field_value_update": { "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" } ] }, "new_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" } ], "new_values_count": 4, "previous_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" } ], "previous_values_count": 3, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "escalation_acknowledged": { "acknowledger": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "escalation_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_created": { "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" } }, "escalated_to_users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "escalation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG1" }, "follow_up_created": { "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" } }, "follow_up_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "follow_up_updated": { "follow_up_id": "01FCNDV6P870EA6S7TK1DSYDG0", "new_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "new_status": "completed", "new_title": "Add a payments-api rollback runbook", "previous_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "previous_status": "outstanding", "previous_title": "Add a runbook", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "incident_merged": { "incident_update_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merger": { "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" } }, "source_incident": { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } }, "incident_rename": { "new_name": "EU checkout failing after 14:02 deploy", "previous_name": "Checkout errors", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "incident_timestamp_set": { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "new_value": "2026-09-01T13:42:00Z", "previous_value": "2026-09-01T14:00:00Z", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "incident_type_changed": { "new_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" }, "previous_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" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "incident_update": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "message": "Rolled back **payments-api** to v411, error rate recovering.", "new_severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "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" }, "next_update_in_minutes": 30, "previous_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" }, "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" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "incident_visibility_changed": { "new_visibility": "private", "previous_visibility": "public", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "role_update": { "new_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "previous_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", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "status_change": { "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" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "summary_update": { "new_summary": "Checkout is failing for all EU customers since the 14:02 deploy.", "previous_summary": "Checkout is failing for some customers.", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "workflow_ran": { "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" } }, "event_description": "Stopped the synthetic load test in staging.", "event_title": "Load test halted" } }, "created_at": "2026-09-01T15:30:01Z", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "occurred_at": "2026-09-01T15:30:00Z", "title": "Status changed from Investigating to Monitoring", "type": "incident_update" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/IncidentActivityLogEntriesListResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Incident Activity Log Entries V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Incident Activity Log Entries V2", "x-docs-resource-type": "IncidentActivityLogEntryV2", "x-mint": { "content": "🔑 Requires the `incidents.view` scope." }, "x-rbac-scopes": [ "incidents.view" ] } }, "/v1/incident_attachments": { "get": { "description": "List all incident attachments for a given external resource or incident. You must provide either a specific incident ID or a specific external resource type and external ID.", "operationId": "Incident Attachments V1_List", "parameters": [ { "allowEmptyValue": true, "description": "Incident that this attachment is against", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "in": "query", "name": "incident_id", "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } }, { "allowEmptyValue": true, "description": "ID of the resource in the external system", "example": "123", "in": "query", "name": "external_id", "schema": { "description": "ID of the resource in the external system", "example": "123", "type": "string" } }, { "allowEmptyValue": true, "description": "E.g. PagerDuty: the external system that holds the resource", "examples": { "default": { "summary": "default", "value": "pager_duty_incident" } }, "in": "query", "name": "resource_type", "schema": { "description": "E.g. PagerDuty: the external system that holds the resource", "enum": [ "pager_duty_incident", "opsgenie_alert", "datadog_monitor_alert", "github_pull_request", "gitlab_merge_request", "sentry_issue", "jira_issue", "jsm_alert", "atlassian_statuspage_incident", "zendesk_ticket", "google_calendar_event", "outlook_calendar_event", "slack_file", "salesforce_case", "arbitrary_url", "scrubbed", "statuspage_incident" ], "example": "pager_duty_incident", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_attachments": [ { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "resource": { "external_id": "123", "permalink": "https://my.pagerduty.com/incidents/ABC", "resource_type": "pager_duty_incident", "title": "The database has gone down" } } ] }, "schema": { "$ref": "#/components/schemas/IncidentAttachmentsListResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Incident Attachments V1" ], "x-docs-display-name": "List", "x-docs-group-name": "Incident Attachments V1", "x-docs-resource-type": "IncidentAttachmentV1", "x-mint": { "content": "🔑 Requires the `attachments.view` scope." }, "x-rbac-scopes": [ "attachments.view" ] }, "post": { "description": "Attaches an external resource to an incident.\n\nYou must provide a resource with resource_type and either external_id or url, but not both.\n\nWhen providing a url, the server will create the attachment from that link for the given resource type if the integration is installed and the link is valid.\n\nTo attach an arbitrary link that isn't backed by an integration, use the arbitrary_url resource type with a url, and optionally a title and emoji.", "operationId": "Incident Attachments V1_Create", "requestBody": { "content": { "application/json": { "example": { "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "resource": { "emoji": "rocket", "external_id": "123", "resource_type": "pager_duty_incident", "title": "Impact tracking spreadsheet", "url": "https://github.com/company/repo/pull/123" } }, "schema": { "$ref": "#/components/schemas/IncidentAttachmentsCreatePayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "incident_attachment": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "resource": { "external_id": "123", "permalink": "https://my.pagerduty.com/incidents/ABC", "resource_type": "pager_duty_incident", "title": "The database has gone down" } } }, "schema": { "$ref": "#/components/schemas/IncidentAttachmentsCreateResultV1" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Incident Attachments V1" ], "x-docs-display-name": "Create", "x-docs-group-name": "Incident Attachments V1", "x-docs-resource-type": "IncidentAttachmentV1", "x-mint": { "content": "🔑 Requires the `attachments.create` scope." }, "x-rbac-scopes": [ "attachments.create" ] } }, "/v1/incident_attachments/{id}": { "delete": { "description": "Unattaches an external resource from an incident", "operationId": "Incident Attachments V1_Delete", "parameters": [ { "description": "Unique identifier of this incident membership", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYD5H" } }, "in": "path", "name": "id", "required": true, "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Incident Attachments V1" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Incident Attachments V1", "x-docs-resource-type": "IncidentAttachmentV1", "x-mint": { "content": "🔑 Requires the `attachments.destroy` scope." }, "x-rbac-scopes": [ "attachments.destroy" ] } }, "/v1/incident_memberships": { "post": { "description": "Makes a user a member of a private incident", "operationId": "Incident Memberships V1_Create", "requestBody": { "content": { "application/json": { "example": { "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "user_id": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "schema": { "$ref": "#/components/schemas/IncidentMembershipsCreatePayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "incident_membership": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "updated_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } } }, "schema": { "$ref": "#/components/schemas/IncidentMembershipsCreateResultV1" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Incident Memberships V1" ], "x-docs-display-name": "Create", "x-docs-group-name": "Incident Memberships V1", "x-docs-resource-type": "IncidentMembershipV1", "x-mint": { "content": "🔑 Requires the `incident_memberships.grant` scope." }, "x-rbac-scopes": [ "incident_memberships.grant" ] } }, "/v1/incident_memberships/actions/revoke": { "post": { "description": "Revoke a user's membership of a private incident", "operationId": "Incident Memberships V1_Revoke", "requestBody": { "content": { "application/json": { "example": { "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "user_id": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "schema": { "$ref": "#/components/schemas/IncidentMembershipsRevokePayloadV1" } } }, "required": true }, "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Revoke", "tags": [ "Incident Memberships V1" ], "x-docs-display-name": "Revoke", "x-docs-group-name": "Incident Memberships V1", "x-docs-resource-type": "IncidentMembershipV1", "x-mint": { "content": "🔑 Requires the `incident_memberships.revoke` scope." }, "x-rbac-scopes": [ "incident_memberships.revoke" ] } }, "/v1/incident_relationships": { "get": { "description": "List related incidents for a specific incident.", "operationId": "Incident Relationships V1_List", "parameters": [ { "allowEmptyValue": true, "description": "ID of the incident to find relationships for", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "in": "query", "name": "incident_id", "required": true, "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } }, { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_relationships": [ { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "incident": { "external_id": 123, "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "The database is down" } } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/IncidentRelationshipsListResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Incident Relationships V1" ], "x-docs-display-name": "List", "x-docs-group-name": "Incident Relationships V1", "x-docs-resource-type": "IncidentRelationshipV1", "x-mint": { "content": "🔑 Requires the `incidents.view` scope." }, "x-rbac-scopes": [ "incidents.view" ] } }, "/v2/incident_roles": { "get": { "description": "List all incident roles for an organisation.", "operationId": "Incident Roles V2_List", "responses": { "200": { "content": { "application/json": { "example": { "incident_roles": [ { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/IncidentRolesListResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Incident Roles V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Incident Roles V2", "x-docs-resource-type": "IncidentRoleV2", "x-mint": { "content": "🔑 Requires the `incident_roles.view` scope." }, "x-rbac-scopes": [ "incident_roles.view" ] }, "post": { "description": "Create a new incident role", "operationId": "Incident Roles V2_Create", "requestBody": { "content": { "application/json": { "example": { "description": "The person currently coordinating the incident", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "shortform": "lead" }, "schema": { "$ref": "#/components/schemas/IncidentRolesCreatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/IncidentRolesCreateResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Incident Roles V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Incident Roles V2", "x-docs-resource-type": "IncidentRoleV2", "x-mint": { "content": "🔑 Requires the `organisation_settings.update` scope." }, "x-rbac-scopes": [ "organisation_settings.update" ] } }, "/v2/incident_roles/{id}": { "delete": { "description": "Removes an existing role", "operationId": "Incident Roles V2_Delete", "parameters": [ { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Incident Roles V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Incident Roles V2", "x-docs-resource-type": "IncidentRoleV2", "x-mint": { "content": "🔑 Requires the `organisation_settings.update` scope." }, "x-rbac-scopes": [ "organisation_settings.update" ] }, "get": { "description": "Get a single incident role.", "operationId": "Incident Roles V2_Show", "parameters": [ { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/IncidentRolesShowResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Incident Roles V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Incident Roles V2", "x-docs-resource-type": "IncidentRoleV2", "x-mint": { "content": "🔑 Requires the `incident_roles.view` scope." }, "x-rbac-scopes": [ "incident_roles.view" ] }, "put": { "description": "Update an existing incident role", "operationId": "Incident Roles V2_Update", "parameters": [ { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "The person currently coordinating the incident", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "shortform": "lead" }, "schema": { "$ref": "#/components/schemas/IncidentRolesUpdatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/IncidentRolesUpdateResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Incident Roles V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Incident Roles V2", "x-docs-resource-type": "IncidentRoleV2", "x-mint": { "content": "🔑 Requires the `organisation_settings.update` scope." }, "x-rbac-scopes": [ "organisation_settings.update" ] } }, "/v1/incident_statuses": { "get": { "description": "List all incident statuses for an organisation.", "operationId": "Incident Statuses V1_List", "responses": { "200": { "content": { "application/json": { "example": { "incident_statuses": [ { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/IncidentStatusesListResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Incident Statuses V1" ], "x-docs-display-name": "List", "x-docs-group-name": "Incident Statuses V1", "x-docs-resource-type": "IncidentStatusV1", "x-mint": { "content": "🔑 Requires the `incident_statuses.view` scope." }, "x-rbac-scopes": [ "incident_statuses.view" ] }, "post": { "description": "Create a new incident status", "operationId": "Incident Statuses V1_Create", "requestBody": { "content": { "application/json": { "example": { "category": "live", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "name": "Closed", "rank": 4 }, "schema": { "$ref": "#/components/schemas/IncidentStatusesCreatePayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/IncidentStatusesCreateResultV1" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Incident Statuses V1" ], "x-docs-display-name": "Create", "x-docs-group-name": "Incident Statuses V1", "x-docs-resource-type": "IncidentStatusV1", "x-mint": { "content": "🔑 Requires the `incident_lifecycles.update` scope." }, "x-rbac-scopes": [ "incident_lifecycles.update" ] } }, "/v1/incident_statuses/{id}": { "delete": { "description": "Delete an incident status", "operationId": "Incident Statuses V1_Delete", "parameters": [ { "description": "Unique ID of this incident status", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique ID of this incident status", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "responses": { "202": { "description": "Accepted response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Incident Statuses V1" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Incident Statuses V1", "x-docs-resource-type": "IncidentStatusV1", "x-mint": { "content": "🔑 Requires the `incident_lifecycles.update` scope." }, "x-rbac-scopes": [ "incident_lifecycles.update" ] }, "get": { "description": "Get a single incident status.", "operationId": "Incident Statuses V1_Show", "parameters": [ { "description": "Unique ID of this incident status", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique ID of this incident status", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/IncidentStatusesShowResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Incident Statuses V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "Incident Statuses V1", "x-docs-resource-type": "IncidentStatusV1", "x-mint": { "content": "🔑 Requires the `incident_statuses.view` scope." }, "x-rbac-scopes": [ "incident_statuses.view" ] }, "put": { "description": "Update an existing incident status", "operationId": "Incident Statuses V1_Update", "parameters": [ { "description": "Unique ID of this incident status", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique ID of this incident status", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "name": "Closed", "rank": 4 }, "schema": { "$ref": "#/components/schemas/IncidentStatusesUpdatePayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/IncidentStatusesUpdateResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Incident Statuses V1" ], "x-docs-display-name": "Update", "x-docs-group-name": "Incident Statuses V1", "x-docs-resource-type": "IncidentStatusV1", "x-mint": { "content": "🔑 Requires the `incident_lifecycles.update` scope." }, "x-rbac-scopes": [ "incident_lifecycles.update" ] } }, "/v1/incident_templates": { "get": { "description": "List all incident templates for this organisation.", "operationId": "Incident Templates V1_List", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "An incident template's ID. This endpoint returns a list of templates after this ID in relation to the API response order.", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "query", "name": "after", "schema": { "description": "An incident template's ID. This endpoint returns a list of templates after this ID in relation to the API response order.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_templates": [ { "created_at": "2021-08-17T13:28:57.801578Z", "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Payments incidents", "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "updated_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/IncidentTemplatesListResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Incident Templates V1" ], "x-docs-display-name": "List", "x-docs-group-name": "Incident Templates V1", "x-docs-resource-type": "IncidentTemplateV1", "x-mint": { "content": "🔑 Requires the `incident_templates.view` scope." }, "x-rbac-scopes": [ "incident_templates.view" ] }, "post": { "description": "Create an incident template.", "operationId": "Incident Templates V1_Create", "requestBody": { "content": { "application/json": { "example": { "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "name": "Payments incidents", "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } } }, "schema": { "$ref": "#/components/schemas/IncidentTemplatesCreatePayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "incident_template": { "created_at": "2021-08-17T13:28:57.801578Z", "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Payments incidents", "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/IncidentTemplatesCreateResultV1" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Incident Templates V1" ], "x-docs-display-name": "Create", "x-docs-group-name": "Incident Templates V1", "x-docs-resource-type": "IncidentTemplateV1", "x-mint": { "content": "🔑 Requires the `incident_template.create` scope." }, "x-rbac-scopes": [ "incident_template.create" ] } }, "/v1/incident_templates/{id}": { "delete": { "description": "Archive an incident template. Fails if the template is still referenced by an alert route.", "operationId": "Incident Templates V1_Destroy", "parameters": [ { "description": "The incident template's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "The incident template's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Incident Templates V1" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Incident Templates V1", "x-docs-resource-type": "IncidentTemplateV1", "x-mint": { "content": "🔑 Requires the `incident_template.destroy` scope." }, "x-rbac-scopes": [ "incident_template.destroy" ] }, "get": { "description": "Show a single incident template.", "operationId": "Incident Templates V1_Show", "parameters": [ { "description": "The incident template's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "The incident template's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_template": { "created_at": "2021-08-17T13:28:57.801578Z", "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Payments incidents", "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/IncidentTemplatesShowResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Incident Templates V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "Incident Templates V1", "x-docs-resource-type": "IncidentTemplateV1", "x-mint": { "content": "🔑 Requires the `incident_templates.view` scope." }, "x-rbac-scopes": [ "incident_templates.view" ] }, "put": { "description": "Update an incident template. This is a full replacement: any field not supplied is cleared.", "operationId": "Incident Templates V1_Update", "parameters": [ { "description": "The incident template's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "The incident template's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "name": "Payments incidents", "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } } }, "schema": { "$ref": "#/components/schemas/IncidentTemplatesUpdatePayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "incident_template": { "created_at": "2021-08-17T13:28:57.801578Z", "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Payments incidents", "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/IncidentTemplatesUpdateResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Incident Templates V1" ], "x-docs-display-name": "Update", "x-docs-group-name": "Incident Templates V1", "x-docs-resource-type": "IncidentTemplateV1", "x-mint": { "content": "🔑 Requires the `incident_template.update` scope." }, "x-rbac-scopes": [ "incident_template.update" ] } }, "/v1/incident_templates/actions/validate": { "post": { "description": "Check whether an incident template's config is valid, without creating or updating anything.\n\nThis validates in the same way a create or update would: expressions are compiled and checked\nagainst your catalog. An invalid config is an error. A config that is valid but probably not\nwhat you meant — such as a name that's already taken — comes back as a warning on a successful\nresponse, so a client can show it without blocking.", "operationId": "Incident Templates V1_Validate", "requestBody": { "content": { "application/json": { "example": { "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "name": "Payments incidents", "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } } }, "schema": { "$ref": "#/components/schemas/IncidentTemplatesValidatePayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "warnings": [ { "detail": "Creating a new template with this name will fail. Updating the template that already has it keeps working.", "summary": "An incident template with this name already exists" } ] }, "schema": { "$ref": "#/components/schemas/IncidentTemplatesValidateResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Validate", "tags": [ "Incident Templates V1" ], "x-docs-display-name": "Validate", "x-docs-group-name": "Incident Templates V1", "x-docs-resource-type": "IncidentTemplateV1", "x-mint": { "content": "🔑 Requires the `incident_templates.view` scope." }, "x-rbac-scopes": [ "incident_templates.view" ] } }, "/v2/incident_timeline_items": { "get": { "description": "List the timeline items for an incident, oldest first.\n\nItems are ordered by timestamp, then by ID to break ties, which is the order the dashboard\nshows them in. If the incident has streams, this returns the items on its streams too -\nthey're part of the same narrative - and incident_id on each item tells you which stream it\ncame from.\n\nItems can be edited after they're written, and this endpoint always returns their current\nstate, so listing an incident again gives you the timeline as it stands today.\n", "operationId": "Incident Timeline Items V2_List", "parameters": [ { "allowEmptyValue": true, "description": "Incident whose timeline you want to list", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "in": "query", "name": "incident_id", "required": true, "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } }, { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "A timeline item's ID. This endpoint returns the items that follow it.", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "query", "name": "after", "schema": { "description": "A timeline item's ID. This endpoint returns the items that follow it.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_timeline_items": [ { "activity_log_id": "01FCNDV6P870EA6S7TK1DSYDG1", "created_at": "2026-09-01T15:31:04Z", "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": "Rolled back **payments-api** to v411 after error rate hit 12%.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "timestamp": "2026-09-01T15:30:00Z", "title": "Rolled back payments-api", "updated_at": "2026-09-01T16:45:00Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/IncidentTimelineItemsListResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Incident Timeline Items V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Incident Timeline Items V2", "x-docs-resource-type": "IncidentTimelineItemV2", "x-mint": { "content": "🔑 Requires the `incidents.view` scope." }, "x-rbac-scopes": [ "incidents.view" ] }, "post": { "description": "Add a custom item to an incident's timeline.\n\nItems created here are custom, so they carry no activity_log_id and their timestamp stays\neditable. Set it to when the thing actually happened rather than when you're telling us about\nit - a deploy you shipped an hour ago belongs an hour back on the timeline.\n\nEvery request needs an idempotency_key. Retrying with a key we've already seen returns the\nitem the first request created rather than writing a second one, so an automation that\nretries on a timeout doesn't leave a duplicate behind.\n", "operationId": "Incident Timeline Items V2_Create", "requestBody": { "content": { "application/json": { "example": { "description": "Rolled back **payments-api** to v411 after error rate hit 12%.", "idempotency_key": "deploy-4f2c1b90", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "timestamp": "2026-09-01T15:30:00Z", "title": "Rolled back payments-api" }, "schema": { "$ref": "#/components/schemas/IncidentTimelineItemsCreatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "incident_timeline_item": { "activity_log_id": "01FCNDV6P870EA6S7TK1DSYDG1", "created_at": "2026-09-01T15:31:04Z", "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": "Rolled back **payments-api** to v411 after error rate hit 12%.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "timestamp": "2026-09-01T15:30:00Z", "title": "Rolled back payments-api", "updated_at": "2026-09-01T16:45:00Z" } }, "schema": { "$ref": "#/components/schemas/IncidentTimelineItemsCreateResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Incident Timeline Items V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Incident Timeline Items V2", "x-docs-resource-type": "IncidentTimelineItemV2", "x-mint": { "content": "🔑 Requires the `timeline_items.create` scope." }, "x-rbac-scopes": [ "timeline_items.create" ] } }, "/v2/incident_timeline_items/{id}": { "patch": { "description": "Edit a timeline item.\n\nFields you leave out are unchanged, and an empty description removes it. Timestamp can only\nbe changed on a custom item: a promoted one follows the activity it came from.\n", "operationId": "Incident Timeline Items V2_Update", "parameters": [ { "description": "Timeline item to edit", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "Rolled back **payments-api** to v411 after error rate hit 12%.", "timestamp": "2026-09-01T15:30:00Z", "title": "Rolled back payments-api" }, "schema": { "$ref": "#/components/schemas/IncidentTimelineItemsUpdatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "incident_timeline_item": { "activity_log_id": "01FCNDV6P870EA6S7TK1DSYDG1", "created_at": "2026-09-01T15:31:04Z", "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": "Rolled back **payments-api** to v411 after error rate hit 12%.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "timestamp": "2026-09-01T15:30:00Z", "title": "Rolled back payments-api", "updated_at": "2026-09-01T16:45:00Z" } }, "schema": { "$ref": "#/components/schemas/IncidentTimelineItemsUpdateResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Incident Timeline Items V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Incident Timeline Items V2", "x-docs-resource-type": "IncidentTimelineItemV2", "x-mint": { "content": "🔑 Requires the `timeline_items.update` scope." }, "x-rbac-scopes": [ "timeline_items.update" ] } }, "/v2/incident_timestamps": { "get": { "description": "List all incident timestamps for an organisation.", "operationId": "Incident Timestamps V2_List", "responses": { "200": { "content": { "application/json": { "example": { "incident_timestamps": [ { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 } ] }, "schema": { "$ref": "#/components/schemas/IncidentTimestampsListResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Incident Timestamps V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Incident Timestamps V2", "x-docs-resource-type": "IncidentTimestampV2" } }, "/v2/incident_timestamps/{id}": { "get": { "description": "Get a single incident timestamp.", "operationId": "Incident Timestamps V2_Show", "parameters": [ { "description": "Unique ID of this incident timestamp", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique ID of this incident timestamp", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 } }, "schema": { "$ref": "#/components/schemas/IncidentTimestampsShowResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Incident Timestamps V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Incident Timestamps V2", "x-docs-resource-type": "IncidentTimestampV2" } }, "/v1/incident_types": { "get": { "description": "List all incident types for an organisation.", "operationId": "Incident Types V1_List", "responses": { "200": { "content": { "application/json": { "example": { "incident_types": [ { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/IncidentTypesListResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Incident Types V1" ], "x-docs-display-name": "List", "x-docs-group-name": "Incident Types V1", "x-docs-resource-type": "IncidentTypeV1", "x-mint": { "content": "🔑 Requires the `incident_types.view` scope." }, "x-rbac-scopes": [ "incident_types.view" ] } }, "/v1/incident_types/{id}": { "get": { "description": "Get a single incident type.", "operationId": "Incident Types V1_Show", "parameters": [ { "description": "Unique identifier for this Incident Type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for this Incident Type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/IncidentTypesShowResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Incident Types V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "Incident Types V1", "x-docs-resource-type": "IncidentTypeV1", "x-mint": { "content": "🔑 Requires the `incident_types.view` scope." }, "x-rbac-scopes": [ "incident_types.view" ] } }, "/v2/incident_updates": { "get": { "description": "List all incident updates for an organisation, or for a specific incident.", "operationId": "Incident Updates V2_List", "parameters": [ { "allowEmptyValue": true, "description": "Incident whose updates you want to list", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "in": "query", "name": "incident_id", "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } }, { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_updates": [ { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merged_into_incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "message": "We're working on a fix, hoping to ship in the next 30 minutes", "new_incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "new_severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/IncidentUpdatesListResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Incident Updates V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Incident Updates V2", "x-docs-resource-type": "IncidentUpdateV2", "x-mint": { "content": "🔑 Requires the `incidents.view` scope." }, "x-rbac-scopes": [ "incidents.view" ] }, "post": { "description": "Share an update against an incident.\n\nAn update can carry a message, move the incident to a new status, change its severity,\nor any combination of the three. At least one of them must be provided.\n\nWhich permissions you need depends on what the update does: changing status requires\npermission to update an incident's status, and changing severity permission to update\nits severity.\n", "operationId": "Incident Updates V2_Create", "requestBody": { "content": { "application/json": { "example": { "idempotency_key": "alert-uuid", "incident_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "message": "We're working on a fix, hoping to ship in the next 30 minutes", "to_incident_status_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "to_severity_id": "01FH5TZRWMNAFB0DZ23FD1TV96" }, "schema": { "$ref": "#/components/schemas/IncidentUpdatesCreatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "incident_update": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merged_into_incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "message": "We're working on a fix, hoping to ship in the next 30 minutes", "new_incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "new_severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } } }, "schema": { "$ref": "#/components/schemas/IncidentUpdatesCreateResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Incident Updates V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Incident Updates V2", "x-docs-resource-type": "IncidentUpdateV2", "x-mint": { "content": "🔑 Requires the `incident_updates.create` scope." }, "x-rbac-scopes": [ "incident_updates.create" ] } }, "/v2/incident_participants": { "get": { "description": "List the participants of an incident with the role they took.\n\nParticipants are split into those who are actively helping with the incident and those who are\njust observing. Each participant is annotated with their participant type.", "operationId": "IncidentParticipants V2_List", "parameters": [ { "allowEmptyValue": true, "description": "Find participants of this incident", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "in": "query", "name": "incident_id", "required": true, "schema": { "description": "Find participants of this incident", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_participants": { "active": [ { "participant_type": "observer", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "passive": [ { "participant_type": "observer", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ] } }, "schema": { "$ref": "#/components/schemas/IncidentParticipantsListResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "IncidentParticipants V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Incident Participants V2", "x-docs-resource-type": "IncidentParticipantV2", "x-mint": { "content": "🔑 Requires the `incidents.view` scope." }, "x-rbac-scopes": [ "incidents.view" ] } }, "/v2/incident_participant_workloads": { "get": { "description": "List the participants of an incident with their workload.\n\nWe calculate how much time each participant has spent working on the incident, aggregated\nper participant. Each participant is annotated with their participant type and, if they have\nleft the incident, when they were archived.\n\nWorkload is calculated periodically, so values can lag real time and the most recent period\nmay still be filling. The metadata reports the time the figures are calculated up to.\n\nWorkload for private incidents is only returned to API keys with the\n`incident_workloads.view_private` scope.", "operationId": "IncidentParticipantWorkloads V2_List", "parameters": [ { "allowEmptyValue": true, "description": "Find participant workload for this incident", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "in": "query", "name": "incident_id", "required": true, "schema": { "description": "Find participant workload for this incident", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident_participant_workloads": [ { "archived_at": "2021-08-17T13:28:57.801578Z", "participant_type": "observer", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workload": { "minutes_spent_on_incident": 125.5, "minutes_spent_on_incident_in_late_hours": 20.5, "minutes_spent_on_incident_in_sleeping_hours": 15, "minutes_spent_on_incident_in_working_hours": 90 } } ], "metadata": { "data_synced_at": "2021-08-17T13:00:00Z" } }, "schema": { "$ref": "#/components/schemas/IncidentParticipantWorkloadsListResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "IncidentParticipantWorkloads V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Incident Participant Workloads V2", "x-docs-resource-type": "IncidentParticipantWorkloadV2", "x-mint": { "content": "🔑 Requires the `incident_workloads.view` scope." }, "x-rbac-scopes": [ "incident_workloads.view" ] } }, "/v2/incidents": { "get": { "description": "List all incidents for an organisation.\n\nThis endpoint supports a number of filters, which can help find incidents matching certain\ncriteria.\n\nFilters are provided as query parameters, but due to the dynamic nature of what you can\nquery by (different accounts have different custom fields, statuses, etc) they are more\ncomplex than most.\n\nThe maximum page size that can be requested is 250.\n\nTo help, here are some exemplar curl requests with a human description of what they search\nfor.\n\nNote that:\n- Filters may be combined using the filter_mode parameter: 'all' (default) requires all filters\nto match (AND logic), while 'any' requires at least one filter to match (OR logic).\n- IDs are normally in UUID format, but have been replaced with shorter strings to improve\nreadability.\n- All query parameters must be URI encoded.\n\n### By status\n\nWith status of id=ABC, find all incidents that are set to that status:\n\n```bash\ncurl --get 'https://api.incident.io/v2/incidents' \\\n--data 'status[one_of]=ABC'\n```\n\nOr all incidents that are not set to status with id=ABC:\n\n```bash\ncurl --get 'https://api.incident.io/v2/incidents' \\\n--data 'status[not_in]=ABC'\n```\n\n### By created_at or updated_at\n\nFind all incidents that follow specified date parameters for created_at and updated_at fields.\nPossible values are \"gte\" (greater than or equal to), \"lte\" (less than or equal to), and\n\"date_range\" (between two dates). The following example finds all incidents created before\nor on 2021-01-02T00:00:00Z:\n\n```bash\ncurl --get 'https://api.incident.io/v2/incidents' \\\n--data 'created_at[lte]=2021-01-02'\n```\n\nTo find incidents created within a specific date range, use the date_range option with\ntilde-separated dates:\n\n```bash\ncurl --get 'https://api.incident.io/v2/incidents' \\\n--data 'created_at[date_range]=2024-12-02~2024-12-08'\n```\n\n### By status category\n\nFind all incidents that are in a status category. Some categories use a different\nname in the API than the one shown in the dashboard — most notably \"live\" (shown as\n\"Active\") and \"learning\" (shown as \"Post-incident\"). The full mapping is:\n\n| API value | Shown in app as |\n| ---------- | --------------- |\n| triage | Triage |\n| live | Active |\n| learning | Post-incident |\n| paused | Paused |\n| closed | Closed |\n| declined | Declined |\n| canceled | Canceled |\n| merged | Merged |\n\nFor example, to find all incidents the dashboard shows as \"Active\", filter on the\n\"live\" category:\n\n```bash\ncurl --get 'https://api.incident.io/v2/incidents' \\\n--data 'status_category[one_of]=live'\n```\n\nOr all incidents that are not in a status category:\n\n```bash\ncurl --get 'https://api.incident.io/v2/incidents' \\\n--data 'status_category[not_in]=live'\n```\n\n\n### By severity\n\nWith severity of id=ABC, find all incidents that are set to that severity:\n\n```bash\ncurl --get 'https://api.incident.io/v2/incidents' \\\n--data 'severity[one_of]=ABC'\n```\n\nOr all incidents where severity rank is greater-than-or-equal-to the rank of severity\nid=ABC:\n\n```bash\ncurl --get 'https://api.incident.io/v2/incidents' \\\n--data 'severity[gte]=ABC'\n```\n\nOr all incidents where severity rank is less-than-or-equal-to the rank of severity id=ABC:\n\n```bash\ncurl --get 'https://api.incident.io/v2/incidents' \\\n--data 'severity[lte]=ABC'\n```\n\n### By incident type\n\nWith incident type of id=ABC, find all incidents that are of that type:\n\n```bash\ncurl --get 'https://api.incident.io/v2/incidents' \\\n--data 'incident_type[one_of]=ABC'\n```\n\nOr all incidents not of that type:\n\n```bash\ncurl --get 'https://api.incident.io/v2/incidents' \\\n--data 'incident_type[not_in]=ABC'\n```\n\n### By incident mode\n\nBy default, we return standard and retrospective incidents. This means that test and\ntutorial incidents are filtered out. To override this behaviour, you can use the\nmode filter to specify which modes you want to get.\n\nTo find incidents of all modes:\n\n```bash\ncurl --get 'https://api.incident.io/v2/incidents' \\\n--data 'mode[one_of]=standard&mode[one_of]=retrospective&mode[one_of]=test&mode[one_of]=tutorial'\n```\n\nTo find just test incidents:\n\n```bash\ncurl --get 'https://api.incident.io/v2/incidents' \\\n--data 'mode[one_of]=test'\n```\n\n\n### By incident role\n\nRoles and custom fields have another nested layer in the query parameter, to account for\noperations against any of the roles or custom fields created in the account.\n\nWith incident role id=ABC, find all incidents where that role is unset:\n\n```bash\ncurl --get 'https://api.incident.io/v2/incidents' \\\n--data 'incident_role[ABC][is_set]=true'\n```\n\nOr where the role has been set:\n\n```bash\ncurl --get 'https://api.incident.io/v2/incidents' \\\n--data 'incident_role[ABC][is_set]=false'\n```\n\n### By option custom fields\n\nWith an option custom field id=ABC, all incidents that have field ABC set to the custom\nfield option of id=XYZ:\n\n```bash\ncurl \\\n--get 'https://api.incident.io/v2/incidents' \\\n--data 'custom_field[ABC][one_of]=XYZ'\n```\n\nOr all incidents that do not have custom field id=ABC set to option id=XYZ:\n\n```bash\ncurl \\\n--get 'https://api.incident.io/v2/incidents' \\\n--data 'custom_field[ABC][not_in]=XYZ'\n```\n\n### Sorting\n\nBy default, results are ordered by their creation date. You can use the sort_by parameter\nto reverse this order:\n\n```bash\ncurl \\\n--get 'https://api.incident.io/v2/incidents' \\\n--data 'sort_by=created_at_oldest_first'\n```\n", "operationId": "Incidents V2_List", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 500, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "An incident's ID. This endpoint will return a list of incidents after this ID in relation to the API response order.", "examples": { "default": { "summary": "default", "value": "01FDAG4SAP5TYPT98WGR2N7W91" } }, "in": "query", "name": "after", "schema": { "description": "An incident's ID. This endpoint will return a list of incidents after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "allowEmptyValue": true, "description": "What order to return results in.", "example": "created_at_newest_first", "in": "query", "name": "sort_by", "schema": { "default": "created_at_newest_first", "description": "What order to return results in.", "enum": [ "created_at_newest_first", "created_at_oldest_first" ], "example": "created_at_newest_first", "type": "string" } }, { "allowEmptyValue": true, "description": "How to combine the filters: 'all' combines them with AND logic (all must match), 'any' combines them with OR logic (any can match). Defaults to 'all'.", "example": "all", "in": "query", "name": "filter_mode", "schema": { "description": "How to combine the filters: 'all' combines them with AND logic (all must match), 'any' combines them with OR logic (any can match). Defaults to 'all'.", "enum": [ "all", "any" ], "example": "all", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter on incident status. The accepted operators are 'one_of', or 'not_in'.", "example": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "in": "query", "name": "status", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on incident status. The accepted operators are 'one_of', or 'not_in'.", "example": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on the category of the incidents status. The accepted operators are 'one_of', or 'not_in'.", "example": { "one_of": [ "active" ] }, "in": "query", "name": "status_category", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on the category of the incidents status. The accepted operators are 'one_of', or 'not_in'.", "example": { "one_of": [ "active" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on incident created at timestamp. The accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "created_at[gte]": [ "2024-05-01" ] }, "in": "query", "name": "created_at", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on incident created at timestamp. The accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "created_at[gte]": [ "2024-05-01" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on incident updated at timestamp. The accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "updated_at[gte]": [ "2024-05-01" ] }, "in": "query", "name": "updated_at", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on incident updated at timestamp. The accepted operators are 'gte', 'lte' and 'date_range'.", "example": { "updated_at[gte]": [ "2024-05-01" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on incident severity. The accepted operators are 'one_of', 'not_in', 'gte', 'lte'.", "example": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "in": "query", "name": "severity", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on incident severity. The accepted operators are 'one_of', 'not_in', 'gte', 'lte'.", "example": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on incident type. The accepted operators are 'one_of, or 'not_in'.", "example": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "in": "query", "name": "incident_type", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on incident type. The accepted operators are 'one_of, or 'not_in'.", "example": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804" ] }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on an incident role. Role ID should be sent, along with backlink attribute ID (if needed) followed by the operator and values. The accepted operators are 'one_of', 'is_blank'.", "example": { "01GBSQF3FHF7FWZQNWGHAVQ804": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "01ET65M7ZARSFZ6TFDFVQDN9AA" ] } }, "in": "query", "name": "incident_role", "schema": { "additionalProperties": { "additionalProperties": { "example": [ "value" ], "items": { "example": "value", "type": "string" }, "type": "array" }, "example": { "abc123": [ "value" ] }, "type": "object" }, "description": "Filter on an incident role. Role ID should be sent, along with backlink attribute ID (if needed) followed by the operator and values. The accepted operators are 'one_of', 'is_blank'.", "example": { "01GBSQF3FHF7FWZQNWGHAVQ804": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "01ET65M7ZARSFZ6TFDFVQDN9AA" ] } }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on an incident custom field. Custom field ID should be sent, followed by the operator and values. Accepted operator will depend on the custom field type.", "example": { "01GBSQF3FHF7FWZQNWGHAVQ804": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "01ET65M7ZARSFZ6TFDFVQDN9AA" ] } }, "in": "query", "name": "custom_field", "schema": { "additionalProperties": { "additionalProperties": { "example": [ "value" ], "items": { "example": "value", "type": "string" }, "type": "array" }, "example": { "abc123": [ "value" ] }, "type": "object" }, "description": "Filter on an incident custom field. Custom field ID should be sent, followed by the operator and values. Accepted operator will depend on the custom field type.", "example": { "01GBSQF3FHF7FWZQNWGHAVQ804": { "one_of": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "01ET65M7ZARSFZ6TFDFVQDN9AA" ] } }, "type": "object" } }, { "allowEmptyValue": true, "description": "Filter on incident mode. The accepted operator is 'one_of'. If this is not provided, this value defaults to `{\"one_of\": [\"standard\", \"retrospective\"] }`, meaning that test and tutorial incidents are not included.", "example": { "one_of": [ "retrospective" ] }, "in": "query", "name": "mode", "schema": { "additionalProperties": { "example": [ "some_value" ], "items": { "example": "some_value", "type": "string" }, "type": "array" }, "description": "Filter on incident mode. The accepted operator is 'one_of'. If this is not provided, this value defaults to `{\"one_of\": [\"standard\", \"retrospective\"] }`, meaning that test and tutorial incidents are not included.", "example": { "one_of": [ "retrospective" ] }, "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incidents": [ { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "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" }, "last_activity_at": "2021-08-17T13:28:57.801578Z", "mode": "standard", "ms_teams_channel_url": "https://teams.microsoft.com/l/channel/19%some-hex%40thread.tacv2/inc-123-title?groupId=some-uuid&tenantId=another-uuid", "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_channel_url": "https://slack.com/app_redirect?team=T1234&channel=C5678", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 } }, "schema": { "$ref": "#/components/schemas/IncidentsListResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Incidents V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Incidents V2", "x-docs-resource-type": "IncidentV2", "x-mint": { "content": "🔑 Requires the `incidents.view` scope." }, "x-rbac-scopes": [ "incidents.view" ] }, "post": { "description": "Create a new incident.\n\nNote that if the incident mode is set to \"retrospective\" then the new incident\nwill not be announced in Slack.\n", "operationId": "Incidents V2_Create", "requestBody": { "content": { "application/json": { "example": { "custom_field_entries": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] } ], "idempotency_key": "alert-uuid", "incident_role_assignments": [ { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" } ], "incident_status_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "incident_timestamp_values": [ { "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYD5H", "value": "2021-08-17T13:28:57.801578Z" } ], "incident_type_id": "01FH5TZRWMNAFB0DZ23FD1TV96", "mode": "standard", "name": "Our database is sad", "retrospective_incident_options": { "external_id": 123, "postmortem_document_url": "https://docs.google.com/my_doc_id", "slack_channel_id": "abc123" }, "severity_id": "01FH5TZRWMNAFB0DZ23FD1TV96", "slack_channel_name_override": "inc-123-database-down", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" }, "schema": { "$ref": "#/components/schemas/IncidentsCreatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "incident": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "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" }, "last_activity_at": "2021-08-17T13:28:57.801578Z", "mode": "standard", "ms_teams_channel_url": "https://teams.microsoft.com/l/channel/19%some-hex%40thread.tacv2/inc-123-title?groupId=some-uuid&tenantId=another-uuid", "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_channel_url": "https://slack.com/app_redirect?team=T1234&channel=C5678", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 } }, "schema": { "$ref": "#/components/schemas/IncidentsCreateResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Incidents V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Incidents V2", "x-docs-resource-type": "IncidentV2", "x-mint": { "content": "🔑 Requires the `incidents.create` scope." }, "x-rbac-scopes": [ "incidents.create" ] } }, "/v2/incidents/{id}": { "get": { "description": "Get a single incident.\n\nThe ID supplied can be either the incident's full ID, or the numeric part of its\nreference. For example, to get INC-123, you could use either its full ID or:\n\n```bash\ncurl \\\n--get 'https://api.incident.io/v2/incidents/123\n```\n", "operationId": "Incidents V2_Show", "parameters": [ { "description": "Unique identifier for the incident", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the incident", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incident": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "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" }, "last_activity_at": "2021-08-17T13:28:57.801578Z", "mode": "standard", "ms_teams_channel_url": "https://teams.microsoft.com/l/channel/19%some-hex%40thread.tacv2/inc-123-title?groupId=some-uuid&tenantId=another-uuid", "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_channel_url": "https://slack.com/app_redirect?team=T1234&channel=C5678", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 } }, "schema": { "$ref": "#/components/schemas/IncidentsShowResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Incidents V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Incidents V2", "x-docs-resource-type": "IncidentV2", "x-mint": { "content": "🔑 Requires the `incidents.view` scope." }, "x-rbac-scopes": [ "incidents.view" ] } }, "/v2/incidents/{id}/actions/edit": { "post": { "description": "Edit an existing incident.\n\nThis endpoint allows you to edit the properties of an existing incident: e.g. set the severity or update custom fields.\n\nWhen using this endpoint, only fields that are provided will be edited (omitted fields\nwill be ignored).\n\nThe API key must have the scope corresponding to each property it changes:\n\n- `incidents.update_name` for the name\n- `incidents.update_summary` for the summary\n- `incidents.update_severity` for the severity\n- `incidents.update_status` for the status\n- `incidents.update_custom_fields` for custom fields\n- `incidents.update_timestamps` for timestamps\n- `incidents.update_role_assignments` for role assignments\n- `incident_calls.create` to set the call URL\n- `incident_calls.destroy` when replacing an existing call URL\n", "operationId": "Incidents V2_Edit", "parameters": [ { "description": "The unique identifier of the incident that you want to edit", "example": "01G18REBY9AYH6CMWCJ2CVCYCH", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the incident that you want to edit", "example": "01G18REBY9AYH6CMWCJ2CVCYCH", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "incident": { "call_url": "https://zoom.us/foo", "custom_field_entries": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] } ], "incident_role_assignments": [ { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" } ], "incident_status_id": "abc123", "incident_timestamp_values": [ { "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYD5H", "value": "2021-08-17T13:28:57.801578Z" } ], "name": "Our database is sad", "severity_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_channel_name_override": "inc-123-database-down", "summary": "Our database is really really sad, and we don't know why yet." }, "notify_incident_channel": true }, "schema": { "$ref": "#/components/schemas/IncidentsEditPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "incident": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "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" }, "last_activity_at": "2021-08-17T13:28:57.801578Z", "mode": "standard", "ms_teams_channel_url": "https://teams.microsoft.com/l/channel/19%some-hex%40thread.tacv2/inc-123-title?groupId=some-uuid&tenantId=another-uuid", "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_channel_url": "https://slack.com/app_redirect?team=T1234&channel=C5678", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 } }, "schema": { "$ref": "#/components/schemas/IncidentsEditResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Edit", "tags": [ "Incidents V2" ], "x-docs-display-name": "Edit", "x-docs-group-name": "Incidents V2", "x-docs-resource-type": "IncidentV2" } }, "/v2/incidents/{id}/actions/import_postmortem_document": { "post": { "description": "Import a postmortem document from markdown into an incident.\n\nThe document content should be provided as GitHub-Flavored Markdown. It will be\nparsed and converted into the collaborative editor format, and a new postmortem\ndocument will be created for the incident.\n\nIf no main postmortem document exists for the incident, the imported document\nwill become the main document.", "operationId": "Incidents V2_ImportPostmortemDocument", "parameters": [ { "description": "The unique identifier of the incident", "example": "01GBA8J19SMXQWPJMX3P2ESCVG", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the incident", "example": "01GBA8J19SMXQWPJMX3P2ESCVG", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "content": "## Summary\n\nA database migration caused increased latency...", "title": "INC-123: Post-incident review" }, "schema": { "$ref": "#/components/schemas/IncidentsImportPostmortemDocumentPayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "postmortem_document": { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" } }, "schema": { "$ref": "#/components/schemas/IncidentsImportPostmortemDocumentResultV2" } } }, "description": "Created response.", "headers": { "Location": { "description": "URL of the created postmortem document resource", "example": "abc123", "schema": { "description": "URL of the created postmortem document resource", "example": "abc123", "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Import postmortem document", "tags": [ "Incidents V2" ], "x-docs-display-name": "Import postmortem document", "x-docs-group-name": "Incidents V2", "x-docs-resource-type": "IncidentV2", "x-mint": { "content": "🔑 Requires the `in_app_postmortems.import` scope." }, "x-rbac-scopes": [ "in_app_postmortems.import" ] } }, "/v1/ip_allowlists": { "get": { "description": "Show the IP allowlist for your organisation", "operationId": "IPAllowlists V1_ShowIPAllowlist", "responses": { "200": { "content": { "application/json": { "example": { "ip_allowlist": { "allowlist": [ { "label": "London HQ", "value": "192.0.2.0" } ], "enabled": true, "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "schema": { "$ref": "#/components/schemas/IPAllowlistsShowIPAllowlistResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "IPAllowlists V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "IPAllowlists V1", "x-docs-resource-type": "IPAllowlistV1" }, "put": { "description": "Update the IP allowlist for your organisation", "operationId": "IPAllowlists V1_UpdateIPAllowlist", "requestBody": { "content": { "application/json": { "example": { "allowlist": [ { "label": "London HQ", "value": "192.0.2.0" } ], "enabled": true, "version": 1 }, "schema": { "$ref": "#/components/schemas/IPAllowlistsUpdateIPAllowlistPayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "ip_allowlist": { "allowlist": [ { "label": "London HQ", "value": "192.0.2.0" } ], "enabled": true, "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "schema": { "$ref": "#/components/schemas/IPAllowlistsUpdateIPAllowlistResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "IPAllowlists V1" ], "x-docs-display-name": "Update", "x-docs-group-name": "IPAllowlists V1", "x-docs-resource-type": "IPAllowlistV1", "x-mint": { "content": "🔑 Requires the `security_settings.update` scope." }, "x-rbac-scopes": [ "security_settings.update" ] } }, "/v1/maintenance_windows": { "get": { "description": "List maintenance windows for your organisation.", "operationId": "MaintenanceWindows V1_List", "parameters": [ { "allowEmptyValue": true, "description": "Number of maintenance windows to return per page", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Number of maintenance windows to return per page", "example": 25, "format": "int64", "maximum": 50, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "The ID of the last maintenance window on the previous page", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "query", "name": "after", "schema": { "description": "The ID of the last maintenance window on the previous page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter by window status: active (start_at <= now < end_at), upcoming (now < start_at), or past (end_at <= now)", "example": "active", "in": "query", "name": "status", "schema": { "description": "Filter by window status: active (start_at <= now < end_at), upcoming (now < start_at), or past (end_at <= now)", "enum": [ "active", "upcoming", "past" ], "example": "active", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "maintenance_windows": [ { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/MaintenanceWindowsListResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "MaintenanceWindows V1" ], "x-docs-display-name": "List", "x-docs-group-name": "MaintenanceWindows V1", "x-docs-resource-type": "MaintenanceWindowV1", "x-mint": { "content": "🔑 Requires the `maintenance_windows.view` scope." }, "x-rbac-scopes": [ "maintenance_windows.view" ] }, "post": { "description": "Create a new maintenance window.", "operationId": "MaintenanceWindows V1_Create", "requestBody": { "content": { "application/json": { "example": { "alert_condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public" } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z" }, "schema": { "$ref": "#/components/schemas/MaintenanceWindowsCreatePayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "maintenance_window": { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/MaintenanceWindowsCreateResultV1" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "MaintenanceWindows V1" ], "x-docs-display-name": "Create", "x-docs-group-name": "MaintenanceWindows V1", "x-docs-resource-type": "MaintenanceWindowV1", "x-mint": { "content": "🔑 Requires the `maintenance_window.create` scope." }, "x-rbac-scopes": [ "maintenance_window.create" ] } }, "/v1/maintenance_windows/{id}": { "delete": { "description": "Archives a maintenance window. Set force to archive an active window.", "operationId": "MaintenanceWindows V1_Delete", "parameters": [ { "allowEmptyValue": true, "description": "Archives the window even if it is active. This ends the window immediately. Its resolve_on_end and reroute_on_end actions do not run, so the alerts it is holding stay as they are. To run those actions, use Update to set end_at, then delete the window once it has ended.", "example": true, "in": "query", "name": "force", "schema": { "default": false, "description": "Archives the window even if it is active. This ends the window immediately. Its resolve_on_end and reroute_on_end actions do not run, so the alerts it is holding stay as they are. To run those actions, use Update to set end_at, then delete the window once it has ended.", "example": true, "type": "boolean" } }, { "description": "Unique identifier of the maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "MaintenanceWindows V1" ], "x-docs-display-name": "Delete", "x-docs-group-name": "MaintenanceWindows V1", "x-docs-resource-type": "MaintenanceWindowV1", "x-mint": { "content": "🔑 Requires the `maintenance_window.destroy` scope." }, "x-rbac-scopes": [ "maintenance_window.destroy" ] }, "get": { "description": "Show a particular maintenance window.", "operationId": "MaintenanceWindows V1_Show", "parameters": [ { "description": "Unique identifier of the maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "maintenance_window": { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/MaintenanceWindowsShowResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "MaintenanceWindows V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "MaintenanceWindows V1", "x-docs-resource-type": "MaintenanceWindowV1", "x-mint": { "content": "🔑 Requires the `maintenance_windows.view` scope." }, "x-rbac-scopes": [ "maintenance_windows.view" ] }, "put": { "description": "Update an existing maintenance window.", "operationId": "MaintenanceWindows V1_Update", "parameters": [ { "description": "Unique identifier of the maintenance window", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "alert_condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public" } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z" }, "schema": { "$ref": "#/components/schemas/MaintenanceWindowsUpdatePayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "maintenance_window": { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/MaintenanceWindowsUpdateResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "MaintenanceWindows V1" ], "x-docs-display-name": "Update", "x-docs-group-name": "MaintenanceWindows V1", "x-docs-resource-type": "MaintenanceWindowV1", "x-mint": { "content": "🔑 Requires the `maintenance_window.update` scope." }, "x-rbac-scopes": [ "maintenance_window.update" ] } }, "/v2/policies": { "get": { "description": "List all policies for an organisation.", "operationId": "Policies V2_List", "parameters": [ { "allowEmptyValue": true, "description": "Number of policies to return per page", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Number of policies to return per page", "example": 25, "format": "int64", "maximum": 50, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "The ID of the last policy on the previous page", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "query", "name": "after", "schema": { "description": "The ID of the last policy on the previous page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter to policies of this type", "examples": { "default": { "summary": "default", "value": "follow_up" } }, "in": "query", "name": "policy_type", "schema": { "description": "Filter to policies of this type", "enum": [ "debrief", "follow_up", "on_call_readiness", "post_mortem", "schedule", "vacation_conflict" ], "example": "follow_up", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "policies": [ { "assignment_rules": { "bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "reminder_cadence_after": { "interval": "daily" }, "reminder_cadence_before": { "interval": "daily" }, "reminder_detected_date_offset_hours": [ 0, 48 ], "reminder_due_date_offset_hours": [ -24, 0, 24 ] }, "conditions": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "debrief": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "description": "All critical incidents must export follow-ups to an external issue tracker before 7 days has passed since closure.", "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "follow_up": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Critical incidents must export follow-ups", "on_call_readiness": { "enforcement": "advisory", "high_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ] }, "policy_type": "follow_up", "post_mortem": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "schedule": { "evaluation_level": "schedule", "requirement_type": "contiguous" }, "status": "enabled", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/PoliciesListResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Policies V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Policies V2", "x-docs-resource-type": "PolicyV2", "x-mint": { "content": "🔑 Requires the `policies.view` scope." }, "x-rbac-scopes": [ "policies.view" ] }, "post": { "description": "Create a new policy.", "operationId": "Policies V2_Create", "requestBody": { "content": { "application/json": { "example": { "assignment_rules": { "bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "reminder_cadence_after": { "interval": "daily" }, "reminder_cadence_before": { "interval": "daily" }, "reminder_detected_date_offset_hours": [ 0, 48 ], "reminder_due_date_offset_hours": [ -24, 0, 24 ] }, "conditions": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "debrief": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "run_on_private_incidents": false }, "description": "All critical incidents must export follow-ups to an external issue tracker before 7 days has passed since closure.", "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "follow_up": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "run_on_private_incidents": false }, "name": "Critical incidents must export follow-ups", "on_call_readiness": { "enforcement": "advisory", "high_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ] }, "policy_type": "follow_up", "post_mortem": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "run_on_private_incidents": false }, "schedule": { "evaluation_level": "schedule", "requirement_type": "contiguous" }, "status": "enabled" }, "schema": { "$ref": "#/components/schemas/PoliciesCreatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "policy": { "assignment_rules": { "bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "reminder_cadence_after": { "interval": "daily" }, "reminder_cadence_before": { "interval": "daily" }, "reminder_detected_date_offset_hours": [ 0, 48 ], "reminder_due_date_offset_hours": [ -24, 0, 24 ] }, "conditions": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "debrief": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "description": "All critical incidents must export follow-ups to an external issue tracker before 7 days has passed since closure.", "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "follow_up": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Critical incidents must export follow-ups", "on_call_readiness": { "enforcement": "advisory", "high_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ] }, "policy_type": "follow_up", "post_mortem": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "schedule": { "evaluation_level": "schedule", "requirement_type": "contiguous" }, "status": "enabled", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/PoliciesCreateResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Policies V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Policies V2", "x-docs-resource-type": "PolicyV2", "x-mint": { "content": "🔑 Requires the `policies.create` scope." }, "x-rbac-scopes": [ "policies.create" ] } }, "/v2/policies/{id}": { "delete": { "description": "Archive a policy. Archived policies stop evaluating and no longer appear in the API.", "operationId": "Policies V2_Delete", "parameters": [ { "description": "Unique identifier for the policy", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the policy", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Policies V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Policies V2", "x-docs-resource-type": "PolicyV2", "x-mint": { "content": "🔑 Requires the `policies.destroy` scope." }, "x-rbac-scopes": [ "policies.destroy" ] }, "get": { "description": "Get a single policy.", "operationId": "Policies V2_Show", "parameters": [ { "description": "Unique identifier for the policy", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the policy", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "policy": { "assignment_rules": { "bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "reminder_cadence_after": { "interval": "daily" }, "reminder_cadence_before": { "interval": "daily" }, "reminder_detected_date_offset_hours": [ 0, 48 ], "reminder_due_date_offset_hours": [ -24, 0, 24 ] }, "conditions": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "debrief": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "description": "All critical incidents must export follow-ups to an external issue tracker before 7 days has passed since closure.", "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "follow_up": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Critical incidents must export follow-ups", "on_call_readiness": { "enforcement": "advisory", "high_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ] }, "policy_type": "follow_up", "post_mortem": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "schedule": { "evaluation_level": "schedule", "requirement_type": "contiguous" }, "status": "enabled", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/PoliciesShowResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Policies V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Policies V2", "x-docs-resource-type": "PolicyV2", "x-mint": { "content": "🔑 Requires the `policies.view` scope." }, "x-rbac-scopes": [ "policies.view" ] }, "put": { "description": "Update an existing policy.\n\nThe policy_type of an existing policy cannot be changed: sending a\ndifferent type is rejected. Create a new policy instead.\n", "operationId": "Policies V2_Update", "parameters": [ { "description": "Unique identifier for the policy", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the policy", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "assignment_rules": { "bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "reminder_cadence_after": { "interval": "daily" }, "reminder_cadence_before": { "interval": "daily" }, "reminder_detected_date_offset_hours": [ 0, 48 ], "reminder_due_date_offset_hours": [ -24, 0, 24 ] }, "conditions": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "debrief": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "run_on_private_incidents": false }, "description": "All critical incidents must export follow-ups to an external issue tracker before 7 days has passed since closure.", "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "follow_up": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "run_on_private_incidents": false }, "name": "Critical incidents must export follow-ups", "on_call_readiness": { "enforcement": "advisory", "high_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ] }, "policy_type": "follow_up", "post_mortem": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "run_on_private_incidents": false }, "schedule": { "evaluation_level": "schedule", "requirement_type": "contiguous" }, "status": "enabled" }, "schema": { "$ref": "#/components/schemas/PoliciesUpdatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "policy": { "assignment_rules": { "bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "reminder_cadence_after": { "interval": "daily" }, "reminder_cadence_before": { "interval": "daily" }, "reminder_detected_date_offset_hours": [ 0, 48 ], "reminder_due_date_offset_hours": [ -24, 0, 24 ] }, "conditions": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "debrief": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "description": "All critical incidents must export follow-ups to an external issue tracker before 7 days has passed since closure.", "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "follow_up": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Critical incidents must export follow-ups", "on_call_readiness": { "enforcement": "advisory", "high_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ] }, "policy_type": "follow_up", "post_mortem": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "schedule": { "evaluation_level": "schedule", "requirement_type": "contiguous" }, "status": "enabled", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/PoliciesUpdateResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Policies V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Policies V2", "x-docs-resource-type": "PolicyV2", "x-mint": { "content": "🔑 Requires the `policies.create` scope." }, "x-rbac-scopes": [ "policies.create" ] } }, "/v2/policy_findings": { "get": { "description": "List the findings your policies have raised, whatever state they are in.", "operationId": "Policy Findings V2_List", "parameters": [ { "allowEmptyValue": true, "description": "Number of findings to return per page", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Number of findings to return per page", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "The ID of the last finding on the previous page", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "query", "name": "after", "schema": { "description": "The ID of the last finding on the previous page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Only findings raised by this policy", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "policy_id", "schema": { "description": "Only findings raised by this policy", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "policy_findings": [ { "created_at": "2021-08-17T13:28:57.801578Z", "days": 3, "debrief": { "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "dismissal": { "dismissed_at": "2021-08-17T13:28:57.801578Z", "dismissed_by": { "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" } }, "reason": "This incident is special." }, "due_at": "2025-10-14T00:00:00.000000Z", "follow_up": { "follow_up_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_checked_at": "2021-08-17T13:28:57.801578Z", "on_call_readiness": { "high_urgency": [ { "max_delay_seconds": 300, "met": false, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "met": false, "method_types": [ "slack" ] } ], "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "policy_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "policy_type": "follow_up", "post_mortem": { "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "responsible_users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "schedule": { "cause": "nobody_scheduled", "end_at": "2021-08-17T13:28:57.801578Z", "has_unscheduled_time": true, "impacted_users": [ { "cause": "no_on_call_seat", "name": "Alice Green", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" } ], "rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0", "start_at": "2021-08-17T13:28:57.801578Z" }, "state": "active", "updated_at": "2021-08-17T13:28:57.801578Z", "vacation_conflict": { "end_at": "2021-08-17T13:28:57.801578Z", "holiday_name": "Joe Bloggs - Holiday", "rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0", "start_at": "2021-08-17T13:28:57.801578Z", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" } } ] }, "schema": { "$ref": "#/components/schemas/PolicyFindingsListResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Policy Findings V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Policy Findings V2", "x-docs-resource-type": "PolicyFindingV2", "x-mint": { "content": "🔑 Requires the `policies.view` scope." }, "x-rbac-scopes": [ "policies.view" ] } }, "/v2/policy_findings/{id}": { "get": { "description": "Get a single finding.", "operationId": "Policy Findings V2_Show", "parameters": [ { "description": "Unique identifier for the finding", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the finding", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "policy_finding": { "created_at": "2021-08-17T13:28:57.801578Z", "days": 3, "debrief": { "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "dismissal": { "dismissed_at": "2021-08-17T13:28:57.801578Z", "dismissed_by": { "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" } }, "reason": "This incident is special." }, "due_at": "2025-10-14T00:00:00.000000Z", "follow_up": { "follow_up_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_checked_at": "2021-08-17T13:28:57.801578Z", "on_call_readiness": { "high_urgency": [ { "max_delay_seconds": 300, "met": false, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "met": false, "method_types": [ "slack" ] } ], "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "policy_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "policy_type": "follow_up", "post_mortem": { "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "responsible_users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "schedule": { "cause": "nobody_scheduled", "end_at": "2021-08-17T13:28:57.801578Z", "has_unscheduled_time": true, "impacted_users": [ { "cause": "no_on_call_seat", "name": "Alice Green", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" } ], "rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0", "start_at": "2021-08-17T13:28:57.801578Z" }, "state": "active", "updated_at": "2021-08-17T13:28:57.801578Z", "vacation_conflict": { "end_at": "2021-08-17T13:28:57.801578Z", "holiday_name": "Joe Bloggs - Holiday", "rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0", "start_at": "2021-08-17T13:28:57.801578Z", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" } } }, "schema": { "$ref": "#/components/schemas/PolicyFindingsShowResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Policy Findings V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Policy Findings V2", "x-docs-resource-type": "PolicyFindingV2", "x-mint": { "content": "🔑 Requires the `policies.view` scope." }, "x-rbac-scopes": [ "policies.view" ] } }, "/v2/policy_findings/{id}/actions/dismiss": { "post": { "description": "Dismiss a finding, so it stops being counted as open.\n\nDismissing is a judgement that the finding doesn't need acting on, not that the\nresource now meets the policy. The finding stays queryable with a state of\ndismissed.\n", "operationId": "Policy Findings V2_Dismiss", "parameters": [ { "description": "Unique identifier for the finding", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the finding", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "reason": "This incident is special." }, "schema": { "$ref": "#/components/schemas/PolicyFindingsDismissPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "policy_finding": { "created_at": "2021-08-17T13:28:57.801578Z", "days": 3, "debrief": { "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "dismissal": { "dismissed_at": "2021-08-17T13:28:57.801578Z", "dismissed_by": { "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" } }, "reason": "This incident is special." }, "due_at": "2025-10-14T00:00:00.000000Z", "follow_up": { "follow_up_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_checked_at": "2021-08-17T13:28:57.801578Z", "on_call_readiness": { "high_urgency": [ { "max_delay_seconds": 300, "met": false, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "met": false, "method_types": [ "slack" ] } ], "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "policy_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "policy_type": "follow_up", "post_mortem": { "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "responsible_users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "schedule": { "cause": "nobody_scheduled", "end_at": "2021-08-17T13:28:57.801578Z", "has_unscheduled_time": true, "impacted_users": [ { "cause": "no_on_call_seat", "name": "Alice Green", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" } ], "rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0", "start_at": "2021-08-17T13:28:57.801578Z" }, "state": "active", "updated_at": "2021-08-17T13:28:57.801578Z", "vacation_conflict": { "end_at": "2021-08-17T13:28:57.801578Z", "holiday_name": "Joe Bloggs - Holiday", "rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0", "start_at": "2021-08-17T13:28:57.801578Z", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" } } }, "schema": { "$ref": "#/components/schemas/PolicyFindingsDismissResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Dismiss", "tags": [ "Policy Findings V2" ], "x-docs-display-name": "Dismiss", "x-docs-group-name": "Policy Findings V2", "x-docs-resource-type": "PolicyFindingV2", "x-mint": { "content": "🔑 Requires the `policy_findings.dismiss` scope." }, "x-rbac-scopes": [ "policy_findings.dismiss" ] } }, "/v2/policy_findings/{id}/actions/restore": { "post": { "description": "Undo a dismissal, returning the finding to its open state.", "operationId": "Policy Findings V2_Restore", "parameters": [ { "description": "Unique identifier for the finding", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the finding", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "policy_finding": { "created_at": "2021-08-17T13:28:57.801578Z", "days": 3, "debrief": { "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "dismissal": { "dismissed_at": "2021-08-17T13:28:57.801578Z", "dismissed_by": { "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" } }, "reason": "This incident is special." }, "due_at": "2025-10-14T00:00:00.000000Z", "follow_up": { "follow_up_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_checked_at": "2021-08-17T13:28:57.801578Z", "on_call_readiness": { "high_urgency": [ { "max_delay_seconds": 300, "met": false, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "met": false, "method_types": [ "slack" ] } ], "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "policy_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "policy_type": "follow_up", "post_mortem": { "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "responsible_users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "schedule": { "cause": "nobody_scheduled", "end_at": "2021-08-17T13:28:57.801578Z", "has_unscheduled_time": true, "impacted_users": [ { "cause": "no_on_call_seat", "name": "Alice Green", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" } ], "rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0", "start_at": "2021-08-17T13:28:57.801578Z" }, "state": "active", "updated_at": "2021-08-17T13:28:57.801578Z", "vacation_conflict": { "end_at": "2021-08-17T13:28:57.801578Z", "holiday_name": "Joe Bloggs - Holiday", "rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0", "start_at": "2021-08-17T13:28:57.801578Z", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" } } }, "schema": { "$ref": "#/components/schemas/PolicyFindingsRestoreResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Restore", "tags": [ "Policy Findings V2" ], "x-docs-display-name": "Restore", "x-docs-group-name": "Policy Findings V2", "x-docs-resource-type": "PolicyFindingV2", "x-mint": { "content": "🔑 Requires the `policy_findings.restore` scope." }, "x-rbac-scopes": [ "policy_findings.restore" ] } }, "/v1/postmortem_documents": { "get": { "description": "List post-mortem documents for the organisation.\n\nResults can be filtered by incident and sorted by creation date. This endpoint returns document\nmetadata only. If you want to fetch the content of the post-mortem, use the ShowContent endpoint.\n", "operationId": "PostmortemDocuments V1_List", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "A post-mortem document's ID. This endpoint will return a list of post-mortem documents after this ID.", "examples": { "default": { "summary": "default", "value": "01G0J1EXE7AXZ2C93K61WBPYEH" } }, "in": "query", "name": "after", "schema": { "description": "A post-mortem document's ID. This endpoint will return a list of post-mortem documents after this ID.", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter to only return post-mortem documents for the given incident", "example": "01GBA8J19SMXQWPJMX3P2ESCVG", "in": "query", "name": "incident_id", "schema": { "description": "Filter to only return post-mortem documents for the given incident", "example": "01GBA8J19SMXQWPJMX3P2ESCVG", "type": "string" } }, { "allowEmptyValue": true, "description": "Controls the order that results are returned in", "example": "created_at_oldest_first", "in": "query", "name": "sort_by", "schema": { "default": "created_at_newest_first", "description": "Controls the order that results are returned in", "enum": [ "created_at_newest_first", "created_at_oldest_first" ], "example": "created_at_oldest_first", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "postmortem_documents": [ { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" } ] }, "schema": { "$ref": "#/components/schemas/PostmortemDocumentsListResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "PostmortemDocuments V1" ], "x-docs-display-name": "List", "x-docs-group-name": "PostmortemDocuments V1", "x-docs-resource-type": "PostmortemDocumentV1", "x-mint": { "content": "🔑 Requires the `incidents.view` scope." }, "x-rbac-scopes": [ "incidents.view" ] } }, "/v1/postmortem_documents/{id}": { "get": { "description": "Get a single post-mortem document by ID.\n\nThis returns the document's metadata. To retrieve the content of the post-mortem, use the ShowContent endpoint.\n", "operationId": "PostmortemDocuments V1_Show", "parameters": [ { "description": "Unique identifier for the post-mortem document", "example": "01GDZEW57FDA1K4S63MGMQ5DS9", "in": "path", "name": "id", "required": true, "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "postmortem_document": { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" } }, "schema": { "$ref": "#/components/schemas/PostmortemDocumentsShowResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "PostmortemDocuments V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "PostmortemDocuments V1", "x-docs-resource-type": "PostmortemDocumentV1", "x-mint": { "content": "🔑 Requires the `incidents.view` scope." }, "x-rbac-scopes": [ "incidents.view" ] }, "put": { "description": "Update the status of a post-mortem document.", "operationId": "PostmortemDocuments V1_UpdateStatus", "parameters": [ { "description": "Unique identifier for the post-mortem document", "example": "01GDZEW57FDA1K4S63MGMQ5DS9", "in": "path", "name": "id", "required": true, "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "status": "completed" }, "schema": { "$ref": "#/components/schemas/PostmortemDocumentsUpdateStatusPayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "postmortem_document": { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" } }, "schema": { "$ref": "#/components/schemas/PostmortemDocumentsUpdateStatusResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "PostmortemDocuments V1" ], "x-docs-display-name": "Update", "x-docs-group-name": "PostmortemDocuments V1", "x-docs-resource-type": "PostmortemDocumentV1", "x-mint": { "content": "🔑 Requires the `in_app_postmortems.update_status` scope." }, "x-rbac-scopes": [ "in_app_postmortems.update_status" ] } }, "/v1/postmortem_documents/{id}/content": { "get": { "description": "Fetch the content of a post-mortem document, rendered as markdown.\n\nThe response contains the full document content as a single markdown string. The markdown\nfollows standard formatting and is structured to mirror the post-mortem as it appears in\nthe incident.io dashboard:\n\n- **Headings** (`#`, `##`, `###`) for document title and sections\n- **Bold** and *italic* text formatting\n- Bullet lists and numbered lists\n- [Links](url) to external resources, Slack threads, and pull requests\n- Mentions of users, incidents, and catalog entries resolved to their display names\n- Custom field values rendered as labelled bullet lists\n- Timeline entries grouped by date with timestamps\n- Follow-ups with assignees and descriptions\n\nTo preview what this markdown will look like for a given post-mortem, open the document\nin the incident.io dashboard and use the \"Copy to clipboard\" button. The copied content\nuses the same rendering pipeline as this endpoint.\n\nIf you only need document metadata, use the Show or List endpoints instead.\n", "operationId": "PostmortemDocuments V1_ShowContent", "parameters": [ { "description": "Unique identifier for the post-mortem document", "example": "01GDZEW57FDA1K4S63MGMQ5DS9", "in": "path", "name": "id", "required": true, "schema": { "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "markdown": "# Incident Postmortem\n\n## Summary\n\nThis incident was investigated by Alice Smith and affected the API Gateway service.\n\n## Timeline\n\n### 2024-06-15 (UTC)\n\n* [10:30] **Alert fired**\n\n* [10:35] **Incident declared**\n\n## Follow-ups\n\n* **Add monitoring** - Assignee: Alice Smith\n" }, "schema": { "$ref": "#/components/schemas/PostmortemDocumentsShowContentResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show Content", "tags": [ "PostmortemDocuments V1" ], "x-docs-display-name": "Show Content", "x-docs-group-name": "PostmortemDocuments V1", "x-docs-resource-type": "PostmortemDocumentV1", "x-mint": { "content": "🔑 Requires the `in_app_postmortems.copy_as_markdown` scope." }, "x-rbac-scopes": [ "in_app_postmortems.copy_as_markdown" ] } }, "/v1/postmortem_documents/actions/attach": { "post": { "description": "Link an externally-hosted post-mortem document to an incident.\n\nUse this to attach a retrospective document you've created in your own provider (for example\nConfluence, Notion, or Google Docs) to an existing incident. This is the API equivalent of\npasting a document link into the incident.io dashboard, and is useful for automating your\nretrospective workflow - for example, creating a document in the right space with the right\npermissions when an incident is opened, then linking it back to the incident.\n\nOnly one external post-mortem can be attached to an incident, and you cannot attach an external\ndocument to an incident that already has an in-app post-mortem. Re-attaching the same incident\nwith a new permalink updates the existing link.\n", "operationId": "PostmortemDocuments V1_Attach", "requestBody": { "content": { "application/json": { "example": { "document_provider": "notion", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "permalink": "https://www.notion.so/INC-123-database-is-sad" }, "schema": { "$ref": "#/components/schemas/PostmortemDocumentsAttachPayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "postmortem_document": { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" } }, "schema": { "$ref": "#/components/schemas/PostmortemDocumentsAttachResultV1" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Attach", "tags": [ "PostmortemDocuments V1" ], "x-docs-display-name": "Attach", "x-docs-group-name": "PostmortemDocuments V1", "x-docs-resource-type": "PostmortemDocumentV1", "x-mint": { "content": "🔑 Requires the `external_postmortems.create` scope." }, "x-rbac-scopes": [ "external_postmortems.create" ] } }, "/v2/schedule_sync_targets": { "get": { "description": "List all schedule sync targets for this organisation.", "operationId": "Schedule Sync Targets V2_List", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "A sync target's ID. This endpoint will return a list of sync targets after this ID in relation to the API response order.", "examples": { "default": { "summary": "default", "value": "01FDAG4SAP5TYPT98WGR2N7W91" } }, "in": "query", "name": "after", "schema": { "description": "A sync target's ID. This endpoint will return a list of sync targets after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "schedule_sync_targets": [ { "add_bot_to_group": true, "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000AB", "linked_schedules": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ] } ], "slack_team_id": "T02A1AZHG3J", "slack_user_group_id": "S06MNNU5BMK", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/ScheduleSyncTargetsListResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Schedule Sync Targets V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Schedule Sync Targets V2", "x-docs-resource-type": "ScheduleSyncTargetResourceV2", "x-mint": { "content": "🔑 Requires the `schedules.view` scope." }, "x-rbac-scopes": [ "schedules.view" ] }, "post": { "description": "Create a new schedule sync target for a Slack user group.", "operationId": "Schedule Sync Targets V2_Create", "requestBody": { "content": { "application/json": { "example": { "schedule_sync_target": { "add_bot_to_group": true, "annotations": { "incident.io/terraform/version": "3.0.0" }, "new_slack_user_group": { "description": "The team responsible for Project A", "handle": "project-team-a", "name": "Project Team A", "slack_team_id": "T01234567" }, "slack_user_group_id": "S06MNNU5BMK" } }, "schema": { "$ref": "#/components/schemas/ScheduleSyncTargetsCreatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "schedule_sync_target": { "add_bot_to_group": true, "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000AB", "linked_schedules": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ] } ], "slack_team_id": "T02A1AZHG3J", "slack_user_group_id": "S06MNNU5BMK", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/ScheduleSyncTargetsCreateResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Schedule Sync Targets V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Schedule Sync Targets V2", "x-docs-resource-type": "ScheduleSyncTargetResourceV2", "x-mint": { "content": "🔑 Requires the `schedule_sync_targets.create` scope." }, "x-rbac-scopes": [ "schedule_sync_targets.create" ] } }, "/v2/schedule_sync_targets/{id}": { "delete": { "description": "Archive a schedule sync target. Will fail if any active sync rules reference this target.", "operationId": "Schedule Sync Targets V2_Destroy", "parameters": [ { "description": "The sync target ID to archive", "example": "abc123", "in": "path", "name": "id", "required": true, "schema": { "description": "The sync target ID to archive", "example": "abc123", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Schedule Sync Targets V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Schedule Sync Targets V2", "x-docs-resource-type": "ScheduleSyncTargetResourceV2", "x-mint": { "content": "🔑 Requires the `schedule_sync_targets.destroy` scope." }, "x-rbac-scopes": [ "schedule_sync_targets.destroy" ] }, "get": { "description": "Get a single schedule sync target.", "operationId": "Schedule Sync Targets V2_Show", "parameters": [ { "description": "The sync target ID", "example": "abc123", "in": "path", "name": "id", "required": true, "schema": { "description": "The sync target ID", "example": "abc123", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "schedule_sync_target": { "add_bot_to_group": true, "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000AB", "linked_schedules": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ] } ], "slack_team_id": "T02A1AZHG3J", "slack_user_group_id": "S06MNNU5BMK", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/ScheduleSyncTargetsShowResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Schedule Sync Targets V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Schedule Sync Targets V2", "x-docs-resource-type": "ScheduleSyncTargetResourceV2", "x-mint": { "content": "🔑 Requires the `schedules.view` scope." }, "x-rbac-scopes": [ "schedules.view" ] }, "put": { "description": "Update the add_bot_to_group flag on a sync target. The change propagates to every schedule with an active sync rule pointing at this target; the entire operation aborts if the caller lacks edit permission on any of those schedules.", "operationId": "Schedule Sync Targets V2_Update", "parameters": [ { "description": "The sync target ID", "example": "abc123", "in": "path", "name": "id", "required": true, "schema": { "description": "The sync target ID", "example": "abc123", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "add_bot_to_group": true, "annotations": { "incident.io/terraform/version": "3.0.0" } }, "schema": { "$ref": "#/components/schemas/ScheduleSyncTargetsUpdatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "schedule_sync_target": { "add_bot_to_group": true, "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000AB", "linked_schedules": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ] } ], "slack_team_id": "T02A1AZHG3J", "slack_user_group_id": "S06MNNU5BMK", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/ScheduleSyncTargetsUpdateResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Schedule Sync Targets V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Schedule Sync Targets V2", "x-docs-resource-type": "ScheduleSyncTargetResourceV2", "x-mint": { "content": "🔑 Requires the `schedule_sync_targets.update` scope." }, "x-rbac-scopes": [ "schedule_sync_targets.update" ] } }, "/v2/schedule_entries": { "get": { "description": "List the schedule entries for a schedule over a window of time.\n\nUse this endpoint to find out who is on-call for a schedule, either right now or\nat any point in the future. Common uses include:\n\n- Building a calendar or timeline view of who is on-call.\n- Looking up who was on-call at a particular moment (for example, when an\n incident fired).\n- Exporting upcoming shifts into another system, such as a payroll or\n scheduling tool.\n\nThe response groups entries into three lists: `scheduled` (the entries the\nrotation rules produce, before any overrides), `overrides` (any one-off\noverrides that apply in the window) and `final` (the effective schedule\nafter overrides have been merged in — this is normally the list you want).\n\nEach entry includes the `rotation_id` and `layer_id` it belongs to.\nSchedules can be made up of multiple rotations (for example, a primary and\na secondary rotation) and each rotation can have several layers, and we\nreturn entries for every rotation and layer on the schedule.\n\nThe endpoint returns all entries that overlap with the given window. If no\nwindow is provided we default to a sensible range starting from now.\n\n## Pagination\n\nResponses are paginated. When more entries are available than fit on a single\npage, the response includes a `pagination_meta` block with two fields:\n\n- `after_url` — a fully-formed URL for the next page. The simplest way\n to paginate is to keep following this URL until it is no longer present.\n- `after` — an opaque cursor token. To fetch the next page manually,\n re-issue the request with `entry_window_start` set to this value and\n `entry_window_end` left unchanged from the original request. Treat\n the token as opaque — do not parse or modify it.\n\nKeep paginating until `pagination_meta` is absent from the response, at\nwhich point you have received every entry in the window.", "operationId": "Schedules V2_ListScheduleEntries", "parameters": [ { "allowEmptyValue": true, "description": "The ID of the schedule to get entries for.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "schedule_id", "required": true, "schema": { "description": "The ID of the schedule to get entries for.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "allowEmptyValue": true, "description": "The start of the window to get entries for. May also carry an opaque pagination cursor previously returned in `pagination_meta.after` — pass it back here unchanged to fetch the next page (leave `entry_window_end` unchanged from the original request).", "example": "2021-01-01T00:00:00Z", "in": "query", "name": "entry_window_start", "schema": { "description": "The start of the window to get entries for. May also carry an opaque pagination cursor previously returned in `pagination_meta.after` — pass it back here unchanged to fetch the next page (leave `entry_window_end` unchanged from the original request).", "example": "2021-01-01T00:00:00Z", "type": "string" } }, { "allowEmptyValue": true, "description": "The end of the window to get entries for.", "example": "2021-01-01T00:00:00Z", "in": "query", "name": "entry_window_end", "schema": { "description": "The end of the window to get entries for.", "example": "2021-01-01T00:00:00Z", "format": "date-time", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "abc123", "after_url": "abc123" }, "schedule_entries": { "final": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "overrides": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "scheduled": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ] } }, "schema": { "$ref": "#/components/schemas/SchedulesListScheduleEntriesResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Schedules V2" ], "x-display-name": "List", "x-docs-display-name": "List", "x-docs-group-name": "Schedule Entries V2", "x-docs-resource-type": "ScheduleEntryV2", "x-mint": { "content": "🔑 Requires the `schedules.view` scope." }, "x-rbac-scopes": [ "schedules.view" ] } }, "/v2/schedule_overrides": { "get": { "description": "List the overrides on a schedule.\n\nOverrides are one-off changes layered on top of the rotations, such as someone\ncovering a colleague's shift. This returns the overrides themselves: to see the\neffective schedule with overrides already merged in, use the schedule entries\nendpoint instead.\n\nOverrides belong to a specific layer of a specific rotation, so you can narrow the\nresults with `rotation_id` and `layer_id`.\n\nArchived overrides are not returned.", "operationId": "Schedules V2_ListOverrides", "parameters": [ { "allowEmptyValue": true, "description": "The ID of the schedule to get overrides for.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "schedule_id", "required": true, "schema": { "description": "The ID of the schedule to get overrides for.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "allowEmptyValue": true, "description": "If set, only return overrides on this rotation.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "rotation_id", "schema": { "description": "If set, only return overrides on this rotation.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "allowEmptyValue": true, "description": "If set, only return overrides on this layer.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "layer_id", "schema": { "description": "If set, only return overrides on this layer.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "An override's ID. This endpoint will return a list of overrides after this ID in relation to the API response order.", "examples": { "default": { "summary": "default", "value": "01FDAG4SAP5TYPT98WGR2N7W91" } }, "in": "query", "name": "after", "schema": { "description": "An override's ID. This endpoint will return a list of overrides after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "overrides": [ { "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "schedule_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "schema": { "$ref": "#/components/schemas/SchedulesListOverridesResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Schedules V2" ], "x-display-name": "List", "x-docs-display-name": "List", "x-docs-group-name": "Schedule Overrides V2", "x-docs-resource-type": "ScheduleOverrideV2", "x-mint": { "content": "🔑 Requires the `schedules.view` scope." }, "x-rbac-scopes": [ "schedules.view" ] }, "post": { "description": "Create a new schedule override.", "operationId": "Schedules V2_CreateOverride", "requestBody": { "content": { "application/json": { "example": { "end_at": "2021-08-17T14:00:00.000000Z", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "schedule_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:00:00.000000Z", "user": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } }, "schema": { "$ref": "#/components/schemas/SchedulesCreateOverridePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "override": { "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "schedule_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } }, "schema": { "$ref": "#/components/schemas/SchedulesCreateOverrideResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Schedules V2" ], "x-display-name": "Create", "x-docs-display-name": "Create", "x-docs-group-name": "Schedule Overrides V2", "x-docs-resource-type": "ScheduleOverrideV2", "x-mint": { "content": "🔑 Requires the `schedule_overrides.create` scope." }, "x-rbac-scopes": [ "schedule_overrides.create" ] } }, "/v2/schedule_overrides/{id}": { "delete": { "description": "Delete a schedule override, restoring whoever the rotations put on-call for that window.\n\nDeleting an override that has already been deleted succeeds, so it is safe to retry.", "operationId": "Schedules V2_DestroyOverride", "parameters": [ { "description": "The override ID to delete", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "The override ID to delete", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Schedules V2" ], "x-display-name": "Destroy", "x-docs-display-name": "Delete", "x-docs-group-name": "Schedule Overrides V2", "x-docs-resource-type": "ScheduleOverrideV2", "x-mint": { "content": "🔑 Requires the `schedule_overrides.destroy` scope." }, "x-rbac-scopes": [ "schedule_overrides.destroy" ] }, "get": { "description": "Get a single schedule override.\n\nOverrides that have been deleted are not returned.\n\nAn override's ID is not stable across edits: updating an override that overlaps its\nneighbours replaces them with new overrides, so an ID you are holding can stop\nresolving. List the schedule's overrides again to pick up the replacements.", "operationId": "Schedules V2_ShowOverride", "parameters": [ { "description": "The override ID to get", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "The override ID to get", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "override": { "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "schedule_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } }, "schema": { "$ref": "#/components/schemas/SchedulesShowOverrideResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Schedules V2" ], "x-display-name": "Show", "x-docs-display-name": "Show", "x-docs-group-name": "Schedule Overrides V2", "x-docs-resource-type": "ScheduleOverrideV2", "x-mint": { "content": "🔑 Requires the `schedules.view` scope." }, "x-rbac-scopes": [ "schedules.view" ] }, "put": { "description": "Update a schedule override, moving its window or the rotation and layer it sits on.\n\nAn override cannot be reassigned: send the user it already has, and delete and recreate\nit to put someone else on call for that window.\n\nOverrides on a layer cannot overlap, so widening one over its neighbour's window takes\nthat time over. The neighbour is deleted, and any of its time left outside the new\nwindow comes back as new overrides with new IDs, so other override IDs on this layer\nmay stop resolving — list the schedule's overrides again to pick up the replacements.", "operationId": "Schedules V2_UpdateOverride", "parameters": [ { "description": "The override ID to update", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "The override ID to update", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "end_at": "2021-08-17T14:00:00.000000Z", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:00:00.000000Z", "user": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } }, "schema": { "$ref": "#/components/schemas/SchedulesUpdateOverridePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "override": { "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "schedule_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } }, "schema": { "$ref": "#/components/schemas/SchedulesUpdateOverrideResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Schedules V2" ], "x-display-name": "Update", "x-docs-display-name": "Update", "x-docs-group-name": "Schedule Overrides V2", "x-docs-resource-type": "ScheduleOverrideV2", "x-mint": { "content": "🔑 Requires the `schedule_overrides.update` scope." }, "x-rbac-scopes": [ "schedule_overrides.update" ] } }, "/v2/schedules": { "get": { "description": "List configured schedules.", "operationId": "Schedules V2_List", "parameters": [ { "allowEmptyValue": true, "description": "Note that next_shifts will only be returned when the page size is 25 or lower.", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Note that next_shifts will only be returned when the page size is 25 or lower.", "example": 25, "format": "int64", "maximum": 10000, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "A schedule's ID. This endpoint will return a list of schedules after this ID in relation to the API response order.", "examples": { "default": { "summary": "default", "value": "01FDAG4SAP5TYPT98WGR2N7W91" } }, "in": "query", "name": "after", "schema": { "description": "A schedule's ID. This endpoint will return a list of schedules after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 }, "schedules": [ { "annotations": { "incident.io/terraform/version": "3.0.0" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "created_at": "2021-08-17T13:28:57.801578Z", "current_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "holidays_public_config": { "country_codes": [ "GB", "FR" ] }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "next_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "permalink": "https://app.incident.io/acme/on-call/schedules/01G0J1EXE7AXZ2C93K61WBPYEH", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/SchedulesListResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Schedules V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Schedules V2", "x-docs-resource-type": "ScheduleV2", "x-mint": { "content": "🔑 Requires the `schedules.view` scope." }, "x-rbac-scopes": [ "schedules.view" ] }, "post": { "description": "Create a new schedule.", "operationId": "Schedules V2_Create", "requestBody": { "content": { "application/json": { "example": { "schedule": { "annotations": { "incident.io/terraform/version": "version-of-terraform" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "holidays_public_config": { "country_codes": [ "abc123" ] }, "name": "Primary On-call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "America/Los_Angeles" } }, "schema": { "$ref": "#/components/schemas/SchedulesCreatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "schedule": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "created_at": "2021-08-17T13:28:57.801578Z", "current_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "holidays_public_config": { "country_codes": [ "GB", "FR" ] }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "next_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "permalink": "https://app.incident.io/acme/on-call/schedules/01G0J1EXE7AXZ2C93K61WBPYEH", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/SchedulesCreateResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Schedules V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Schedules V2", "x-docs-resource-type": "ScheduleV2", "x-mint": { "content": "🔑 Requires the `schedules.create` scope." }, "x-rbac-scopes": [ "schedules.create" ] } }, "/v2/schedules/{id}": { "delete": { "description": "Archives a single schedule. Will fail if the schedule has active replicas — remove all replicas before deleting.", "operationId": "Schedules V2_Destroy", "parameters": [ { "description": "Unique internal ID of the schedule", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique internal ID of the schedule", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } } ], "responses": { "202": { "description": "Accepted response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Schedules V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Schedules V2", "x-docs-resource-type": "ScheduleV2", "x-mint": { "content": "🔑 Requires the `schedules.destroy` scope." }, "x-rbac-scopes": [ "schedules.destroy" ] }, "get": { "description": "Get a single schedule.", "operationId": "Schedules V2_Show", "parameters": [ { "description": "Unique internal ID of the schedule", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique internal ID of the schedule", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "schedule": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "created_at": "2021-08-17T13:28:57.801578Z", "current_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "holidays_public_config": { "country_codes": [ "GB", "FR" ] }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "next_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "permalink": "https://app.incident.io/acme/on-call/schedules/01G0J1EXE7AXZ2C93K61WBPYEH", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/SchedulesShowResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Schedules V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Schedules V2", "x-docs-resource-type": "ScheduleV2", "x-mint": { "content": "🔑 Requires the `schedules.view` scope." }, "x-rbac-scopes": [ "schedules.view" ] }, "put": { "description": "Update a schedule.\n\nUpdating a schedule replaces its entire configuration with the one you send,\nincluding any scheduled future versions of its rotations — fetch the schedule\nfirst and include every version you want to keep.\n\nTo change who's in a rotation from a future date without affecting shifts\nbefore then, keep the current version unchanged and add another version of the\nsame rotation with `effective_from` set to when the change should land —\nideally an upcoming handover, so nobody is swapped mid-shift. You can check the\neffect of any configuration before saving it with Preview schedule entries.", "operationId": "Schedules V2_Update", "parameters": [ { "description": "The schedule ID to update.", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "in": "path", "name": "id", "required": true, "schema": { "description": "The schedule ID to update.", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "schedule": { "annotations": { "incident.io/terraform/version": "version-of-terraform" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "holidays_public_config": { "country_codes": [ "abc123" ] }, "name": "Primary On-call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "America/Los_Angeles" } }, "schema": { "$ref": "#/components/schemas/SchedulesUpdatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "schedule": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "created_at": "2021-08-17T13:28:57.801578Z", "current_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "holidays_public_config": { "country_codes": [ "GB", "FR" ] }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "next_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "permalink": "https://app.incident.io/acme/on-call/schedules/01G0J1EXE7AXZ2C93K61WBPYEH", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/SchedulesUpdateResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Schedules V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Schedules V2", "x-docs-resource-type": "ScheduleV2", "x-mint": { "content": "🔑 Requires the `schedules.update` scope." }, "x-rbac-scopes": [ "schedules.update" ] } }, "/v2/schedules/{id}/actions/preview_entries": { "post": { "description": "Preview the schedule entries that would be generated by a proposed schedule configuration.\n\nUse this endpoint before updating a schedule to see who would be on-call if you\nsaved the supplied schedule payload. The request body uses the same `schedule`\npayload shape as Update schedule, so you can send the configuration you intend\nto save without persisting it.\n\nThe response uses the same `schedule_entries` envelope as List schedule entries:\n`scheduled` contains entries produced by the rotation rules, `overrides`\ncontains matching overrides, and `final` contains the effective schedule after\noverrides are applied.\n\nThe preview window is bounded to keep requests predictable. If you ask for more\nthan 91 days, the response is capped to 91 days from `entry_window_start`.", "operationId": "Schedules V2_PreviewScheduleEntries", "parameters": [ { "description": "The ID of the schedule to preview entries for.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "The ID of the schedule to preview entries for.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "entry_window_end": "2021-01-08T00:00:00Z", "entry_window_start": "2021-01-01T00:00:00Z", "schedule": { "annotations": { "incident.io/terraform/version": "version-of-terraform" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "holidays_public_config": { "country_codes": [ "abc123" ] }, "name": "Primary On-call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "America/Los_Angeles" } }, "schema": { "$ref": "#/components/schemas/SchedulesPreviewScheduleEntriesPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "schedule_entries": { "final": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "overrides": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "scheduled": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ] } }, "schema": { "$ref": "#/components/schemas/SchedulesPreviewScheduleEntriesResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Preview", "tags": [ "Schedules V2" ], "x-docs-display-name": "Preview", "x-docs-group-name": "Schedule Entries V2", "x-docs-resource-type": "ScheduleEntryV2", "x-mint": { "content": "🔑 Requires the `schedules.view` scope." }, "x-rbac-scopes": [ "schedules.view" ] } }, "/v2/schedules/{schedule_id}/replicas": { "get": { "description": "List all replicas for a schedule.", "operationId": "Schedules V2_ListScheduleReplicas", "parameters": [ { "description": "The schedule to list replicas for", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "schedule_id", "required": true, "schema": { "description": "The schedule to list replicas for", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "schedule_replicas": [ { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_sync_error": "Failed to find external user for Milly", "last_synced_at": "2023-11-07T13:33:30Z", "mirror_window_days": 14, "replica_fallback_user_id": "PA7AXXN", "replica_provider": "pagerduty", "replica_provider_id": "PO8107X", "schedule_id": "01FDAG4SAP5TYPT98WGR2N7W91", "sources": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "user_statuses": [ { "external_user_id": "PJYTRGS", "user_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ] } ] }, "schema": { "$ref": "#/components/schemas/SchedulesListScheduleReplicasResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Schedules V2" ], "x-display-name": "List", "x-docs-display-name": "List", "x-docs-group-name": "Schedule Replicas V2", "x-docs-resource-type": "ScheduleReplicaV2", "x-mint": { "content": "🔑 Requires the `schedules.view` scope." }, "x-rbac-scopes": [ "schedules.view" ] }, "post": { "description": "Create a new schedule replica.", "operationId": "Schedules V2_CreateScheduleReplica", "parameters": [ { "description": "The schedule to create a replica for", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "schedule_id", "required": true, "schema": { "description": "The schedule to create a replica for", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "schedule_replica": { "mirror_window_days": 14, "replica_fallback_user_id": "PA7AXXN", "replica_provider": "pagerduty", "replica_provider_id": "PO8107X", "sources": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ] } }, "schema": { "$ref": "#/components/schemas/SchedulesCreateScheduleReplicaPayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "schedule_replica": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_sync_error": "Failed to find external user for Milly", "last_synced_at": "2023-11-07T13:33:30Z", "mirror_window_days": 14, "replica_fallback_user_id": "PA7AXXN", "replica_provider": "pagerduty", "replica_provider_id": "PO8107X", "schedule_id": "01FDAG4SAP5TYPT98WGR2N7W91", "sources": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "user_statuses": [ { "external_user_id": "PJYTRGS", "user_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ] } }, "schema": { "$ref": "#/components/schemas/SchedulesCreateScheduleReplicaResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Schedules V2" ], "x-display-name": "Create", "x-docs-display-name": "Create", "x-docs-group-name": "Schedule Replicas V2", "x-docs-resource-type": "ScheduleReplicaV2", "x-mint": { "content": "🔑 Requires the `schedules.update` scope." }, "x-rbac-scopes": [ "schedules.update" ] } }, "/v2/schedules/{schedule_id}/replicas/{id}": { "delete": { "description": "Archives a single schedule replica, stopping incident.io from syncing on-call shifts to the external provider.\n\nAs with disabling mirroring via the UI, this will remove any upcoming overrides that incident.io has created in the external schedule, restoring it to its original state. If multiple replicas target the same external schedule, overrides are only removed when the last replica pointing to that schedule is deleted.\n\nNote: override cleanup is supported for PagerDuty and Jira Service Management. Opsgenie does not support programmatic override deletion, so overrides must be removed manually.", "operationId": "Schedules V2_DestroyScheduleReplica", "parameters": [ { "description": "The parent schedule ID", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "schedule_id", "required": true, "schema": { "description": "The parent schedule ID", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "description": "The replica ID to archive", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "The replica ID to archive", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Schedules V2" ], "x-display-name": "Destroy", "x-docs-display-name": "Delete", "x-docs-group-name": "Schedule Replicas V2", "x-docs-resource-type": "ScheduleReplicaV2", "x-mint": { "content": "🔑 Requires the `schedules.update` scope." }, "x-rbac-scopes": [ "schedules.update" ] }, "get": { "description": "Get a single schedule replica.", "operationId": "Schedules V2_ShowScheduleReplica", "parameters": [ { "description": "The parent schedule ID", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "schedule_id", "required": true, "schema": { "description": "The parent schedule ID", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "description": "The replica ID to show", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "The replica ID to show", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "schedule_replica": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_sync_error": "Failed to find external user for Milly", "last_synced_at": "2023-11-07T13:33:30Z", "mirror_window_days": 14, "replica_fallback_user_id": "PA7AXXN", "replica_provider": "pagerduty", "replica_provider_id": "PO8107X", "schedule_id": "01FDAG4SAP5TYPT98WGR2N7W91", "sources": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "user_statuses": [ { "external_user_id": "PJYTRGS", "user_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ] } }, "schema": { "$ref": "#/components/schemas/SchedulesShowScheduleReplicaResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Schedules V2" ], "x-display-name": "Show", "x-docs-display-name": "Show", "x-docs-group-name": "Schedule Replicas V2", "x-docs-resource-type": "ScheduleReplicaV2", "x-mint": { "content": "🔑 Requires the `schedules.view` scope." }, "x-rbac-scopes": [ "schedules.view" ] } }, "/v2/schedules/{schedule_id}/sync_rules": { "get": { "description": "List the sync rules configured on this schedule.", "operationId": "Schedules V2_ListScheduleSyncRules", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "A sync rule's ID. This endpoint will return a list of sync rules after this ID in relation to the API response order.", "examples": { "default": { "summary": "default", "value": "01JXYZ000000000000000000CD" } }, "in": "query", "name": "after", "schema": { "description": "A sync rule's ID. This endpoint will return a list of sync rules after this ID in relation to the API response order.", "example": "01JXYZ000000000000000000CD", "type": "string" } }, { "description": "The schedule to list sync rules for", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "schedule_id", "required": true, "schema": { "description": "The schedule to list sync rules for", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "schedule_sync_rules": [ { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000CD", "permanent_member_user_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rotation_id": "01JXYZ000000000000000000RT", "schedule_id": "01JXYZ000000000000000000EF", "schedule_sync_target": { "add_bot_to_group": true, "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000AB", "linked_schedules": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ] } ], "slack_team_id": "T02A1AZHG3J", "slack_user_group_id": "S06MNNU5BMK", "updated_at": "2021-08-17T13:28:57.801578Z" }, "schedule_sync_target_id": "01JXYZ000000000000000000AB", "sync_type": "on_call", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/SchedulesListScheduleSyncRulesResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Schedules V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Schedule Sync Rules V2", "x-docs-resource-type": "ScheduleSyncRuleV2", "x-mint": { "content": "🔑 Requires the `schedules.view` scope." }, "x-rbac-scopes": [ "schedules.view" ] }, "post": { "description": "Create a new sync rule linking a schedule to a sync target.", "operationId": "Schedules V2_CreateScheduleSyncRule", "parameters": [ { "description": "The schedule to create a sync rule for", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "schedule_id", "required": true, "schema": { "description": "The schedule to create a sync rule for", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "schedule_sync_rule": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "permanent_member_user_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rotation_id": "01JXYZ000000000000000000RT", "schedule_sync_target_id": "01JXYZ000000000000000000AB", "sync_type": "on_call" } }, "schema": { "$ref": "#/components/schemas/SchedulesCreateScheduleSyncRulePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "schedule_sync_rule": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000CD", "permanent_member_user_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rotation_id": "01JXYZ000000000000000000RT", "schedule_id": "01JXYZ000000000000000000EF", "schedule_sync_target": { "add_bot_to_group": true, "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000AB", "linked_schedules": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ] } ], "slack_team_id": "T02A1AZHG3J", "slack_user_group_id": "S06MNNU5BMK", "updated_at": "2021-08-17T13:28:57.801578Z" }, "schedule_sync_target_id": "01JXYZ000000000000000000AB", "sync_type": "on_call", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/SchedulesCreateScheduleSyncRuleResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Schedules V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Schedule Sync Rules V2", "x-docs-resource-type": "ScheduleSyncRuleV2", "x-mint": { "content": "🔑 Requires the `schedule_sync_rules.create` scope." }, "x-rbac-scopes": [ "schedule_sync_rules.create" ] } }, "/v2/schedules/{schedule_id}/sync_rules/{id}": { "delete": { "description": "Archive a sync rule, unlinking the schedule from the sync target.", "operationId": "Schedules V2_DestroyScheduleSyncRule", "parameters": [ { "description": "The parent schedule ID", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "schedule_id", "required": true, "schema": { "description": "The parent schedule ID", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "description": "The sync rule ID to archive", "example": "01JXYZ000000000000000000CD", "in": "path", "name": "id", "required": true, "schema": { "description": "The sync rule ID to archive", "example": "01JXYZ000000000000000000CD", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Schedules V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Schedule Sync Rules V2", "x-docs-resource-type": "ScheduleSyncRuleV2", "x-mint": { "content": "🔑 Requires the `schedule_sync_rules.destroy` scope." }, "x-rbac-scopes": [ "schedule_sync_rules.destroy" ] }, "get": { "description": "Get a single sync rule for a schedule.", "operationId": "Schedules V2_ShowScheduleSyncRule", "parameters": [ { "description": "The parent schedule ID", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "schedule_id", "required": true, "schema": { "description": "The parent schedule ID", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "description": "The sync rule ID", "example": "01JXYZ000000000000000000CD", "in": "path", "name": "id", "required": true, "schema": { "description": "The sync rule ID", "example": "01JXYZ000000000000000000CD", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "schedule_sync_rule": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000CD", "permanent_member_user_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rotation_id": "01JXYZ000000000000000000RT", "schedule_id": "01JXYZ000000000000000000EF", "schedule_sync_target": { "add_bot_to_group": true, "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000AB", "linked_schedules": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ] } ], "slack_team_id": "T02A1AZHG3J", "slack_user_group_id": "S06MNNU5BMK", "updated_at": "2021-08-17T13:28:57.801578Z" }, "schedule_sync_target_id": "01JXYZ000000000000000000AB", "sync_type": "on_call", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/SchedulesShowScheduleSyncRuleResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Schedules V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Schedule Sync Rules V2", "x-docs-resource-type": "ScheduleSyncRuleV2", "x-mint": { "content": "🔑 Requires the `schedules.view` scope." }, "x-rbac-scopes": [ "schedules.view" ] }, "put": { "description": "Update a sync rule's sync_type and permanent members in place. If the rule's sync target is shared with other schedules, a sync_type change propagates to every linked schedule and the entire operation aborts if the caller lacks edit permission on any of them. Permanent members are scoped to this rule and never propagate.", "operationId": "Schedules V2_UpdateScheduleSyncRule", "parameters": [ { "description": "The parent schedule ID", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "schedule_id", "required": true, "schema": { "description": "The parent schedule ID", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "description": "The sync rule ID", "example": "01JXYZ000000000000000000CD", "in": "path", "name": "id", "required": true, "schema": { "description": "The sync rule ID", "example": "01JXYZ000000000000000000CD", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "permanent_member_user_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "sync_type": "on_call" }, "schema": { "$ref": "#/components/schemas/SchedulesUpdateScheduleSyncRulePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "schedule_sync_rule": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000CD", "permanent_member_user_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rotation_id": "01JXYZ000000000000000000RT", "schedule_id": "01JXYZ000000000000000000EF", "schedule_sync_target": { "add_bot_to_group": true, "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000AB", "linked_schedules": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ] } ], "slack_team_id": "T02A1AZHG3J", "slack_user_group_id": "S06MNNU5BMK", "updated_at": "2021-08-17T13:28:57.801578Z" }, "schedule_sync_target_id": "01JXYZ000000000000000000AB", "sync_type": "on_call", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/SchedulesUpdateScheduleSyncRuleResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Schedules V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Schedule Sync Rules V2", "x-docs-resource-type": "ScheduleSyncRuleV2", "x-mint": { "content": "🔑 Requires the `schedule_sync_rules.update` scope." }, "x-rbac-scopes": [ "schedule_sync_rules.update" ] } }, "/v2/secrets": { "get": { "description": "List all secrets for this organisation. Returns metadata only, never values.", "operationId": "Secrets V2_List", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "A secret's ID. This endpoint will return a list of secrets after this ID in relation to the API response order.", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "query", "name": "after", "schema": { "description": "A secret's ID. This endpoint will return a list of secrets after this ID in relation to the API response order.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter to secrets owned by any of these teams", "example": [ "abc123" ], "in": "query", "name": "team_ids", "schema": { "description": "Filter to secrets owned by any of these teams", "example": [ "abc123" ], "items": { "example": "abc123", "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "secrets": [ { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Auth token for the PagerDuty outgoing webhook", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_four_chars": "c123", "name": "PagerDuty webhook token", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 3 } ] }, "schema": { "$ref": "#/components/schemas/SecretsListResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Secrets V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Secrets V2", "x-docs-resource-type": "SecretV2", "x-mint": { "content": "🔑 Requires the `secrets.view_metadata` scope." }, "x-rbac-scopes": [ "secrets.view_metadata" ] }, "post": { "description": "Create a new secret with its initial value.", "operationId": "Secrets V2_Create", "requestBody": { "content": { "application/json": { "example": { "description": "Auth token for the PagerDuty outgoing webhook", "name": "PagerDuty webhook token", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "value": "sk_live_abc123" }, "schema": { "$ref": "#/components/schemas/SecretsCreatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "secret": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Auth token for the PagerDuty outgoing webhook", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_four_chars": "c123", "name": "PagerDuty webhook token", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 3 } }, "schema": { "$ref": "#/components/schemas/SecretsCreateResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Secrets V2" ], "x-docs-display-name": "Create", "x-docs-group-name": "Secrets V2", "x-docs-resource-type": "SecretV2", "x-mint": { "content": "🔑 Requires the `secrets.create` scope." }, "x-rbac-scopes": [ "secrets.create" ] } }, "/v2/secrets/{id}": { "delete": { "description": "Delete a secret, permanently removing its value. Fails if the secret is still referenced by a workflow.", "operationId": "Secrets V2_Destroy", "parameters": [ { "description": "The secret's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "The secret's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Secrets V2" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Secrets V2", "x-docs-resource-type": "SecretV2", "x-mint": { "content": "🔑 Requires the `secrets.delete` scope." }, "x-rbac-scopes": [ "secrets.delete" ] }, "get": { "description": "Show a single secret's metadata, including its version history. Never returns values.", "operationId": "Secrets V2_Show", "parameters": [ { "description": "The secret's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "The secret's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "secret": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Auth token for the PagerDuty outgoing webhook", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_four_chars": "c123", "name": "PagerDuty webhook token", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 3 }, "versions": [ { "created_at": "2021-08-17T13:28:57.801578Z", "created_by": { "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" } }, "last_four_chars": "c123", "version": 3 } ] }, "schema": { "$ref": "#/components/schemas/SecretsShowResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Secrets V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Secrets V2", "x-docs-resource-type": "SecretV2", "x-mint": { "content": "🔑 Requires the `secrets.view_metadata` scope." }, "x-rbac-scopes": [ "secrets.view_metadata" ] }, "put": { "description": "Update a secret's metadata. Does not change the value: use the rotate action for that.", "operationId": "Secrets V2_Update", "parameters": [ { "description": "The secret's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "The secret's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "Auth token for the PagerDuty outgoing webhook", "name": "PagerDuty webhook token", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ] }, "schema": { "$ref": "#/components/schemas/SecretsUpdatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "secret": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Auth token for the PagerDuty outgoing webhook", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_four_chars": "c123", "name": "PagerDuty webhook token", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 3 } }, "schema": { "$ref": "#/components/schemas/SecretsUpdateResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Secrets V2" ], "x-docs-display-name": "Update", "x-docs-group-name": "Secrets V2", "x-docs-resource-type": "SecretV2", "x-mint": { "content": "🔑 Requires the `secrets.update` scope." }, "x-rbac-scopes": [ "secrets.update" ] } }, "/v2/secrets/{id}/actions/rotate": { "post": { "description": "Rotate a secret's value, replacing the current value with a new one. The previous value is retired and can no longer be read.", "operationId": "Secrets V2_Rotate", "parameters": [ { "description": "The secret's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "The secret's ID", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "value": "sk_live_def456" }, "schema": { "$ref": "#/components/schemas/SecretsRotatePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "secret": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Auth token for the PagerDuty outgoing webhook", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_four_chars": "c123", "name": "PagerDuty webhook token", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 3 } }, "schema": { "$ref": "#/components/schemas/SecretsRotateResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Rotate", "tags": [ "Secrets V2" ], "x-docs-display-name": "Rotate", "x-docs-group-name": "Secrets V2", "x-docs-resource-type": "SecretV2", "x-mint": { "content": "🔑 Requires the `secrets.update` scope." }, "x-rbac-scopes": [ "secrets.update" ] } }, "/v1/severities": { "get": { "description": "List all incident severities for an organisation.", "operationId": "Severities V1_List", "responses": { "200": { "content": { "application/json": { "example": { "severities": [ { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/SeveritiesListResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Severities V1" ], "x-docs-display-name": "List", "x-docs-group-name": "Severities V1", "x-docs-resource-type": "SeverityV1", "x-mint": { "content": "🔑 Requires the `severities.view` scope." }, "x-rbac-scopes": [ "severities.view" ] }, "post": { "description": "Create a new severity", "operationId": "Severities V1_Create", "requestBody": { "content": { "application/json": { "example": { "description": "Issues with **low impact**.", "name": "Minor", "rank": 1 }, "schema": { "$ref": "#/components/schemas/SeveritiesCreatePayloadV1" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/SeveritiesCreateResultV1" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Severities V1" ], "x-docs-display-name": "Create", "x-docs-group-name": "Severities V1", "x-docs-resource-type": "SeverityV1", "x-mint": { "content": "🔑 Requires the `organisation_settings.update` scope." }, "x-rbac-scopes": [ "organisation_settings.update" ] } }, "/v1/severities/{id}": { "delete": { "description": "Delete a severity", "operationId": "Severities V1_Delete", "parameters": [ { "description": "Unique identifier of the severity", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the severity", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "202": { "description": "Accepted response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Severities V1" ], "x-docs-display-name": "Delete", "x-docs-group-name": "Severities V1", "x-docs-resource-type": "SeverityV1", "x-mint": { "content": "🔑 Requires the `organisation_settings.update` scope." }, "x-rbac-scopes": [ "organisation_settings.update" ] }, "get": { "description": "Get a single incident severity.", "operationId": "Severities V1_Show", "parameters": [ { "description": "Unique identifier of the severity", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the severity", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/SeveritiesShowResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Severities V1" ], "x-docs-display-name": "Show", "x-docs-group-name": "Severities V1", "x-docs-resource-type": "SeverityV1", "x-mint": { "content": "🔑 Requires the `severities.view` scope." }, "x-rbac-scopes": [ "severities.view" ] }, "put": { "description": "Update an existing severity", "operationId": "Severities V1_Update", "parameters": [ { "description": "Unique identifier of the severity", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the severity", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "description": "Issues with **low impact**.", "name": "Minor", "rank": 1 }, "schema": { "$ref": "#/components/schemas/SeveritiesUpdatePayloadV1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "schema": { "$ref": "#/components/schemas/SeveritiesUpdateResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Severities V1" ], "x-docs-display-name": "Update", "x-docs-group-name": "Severities V1", "x-docs-resource-type": "SeverityV1", "x-mint": { "content": "🔑 Requires the `organisation_settings.update` scope." }, "x-rbac-scopes": [ "organisation_settings.update" ] } }, "/v1/status-pages/{id}/incidents/{incident_id}/response-incidents": { "get": { "description": "List the linked Response incidents for a status page incident.", "operationId": "Status Pages V1_ListResponseIncidents", "parameters": [ { "description": "ID of the status page", "example": "abc123", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of the status page", "example": "abc123", "type": "string" } }, { "description": "ID of the status page incident", "example": "abc123", "in": "path", "name": "incident_id", "required": true, "schema": { "description": "ID of the status page incident", "example": "abc123", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "incidents": [ { "id": "01FDAG4SAH3GYPT98WGR2N7W91", "linked_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/StatusPagesListResponseIncidentsResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Status Pages V1" ], "x-display-name": "List", "x-docs-display-name": "List", "x-docs-group-name": "Status Page Response Incidents V1", "x-docs-resource-type": "StatusPageLinkedResponseIncidentV1" } }, "/v2/status_page_incident_updates": { "post": { "description": "Post an update on a Status Page incident.\n\nThis is the endpoint to use when resolving an incident - set incident_status to \"resolved\" to end the incident. There is a limit of 100 updates per incident.\n\nThis endpoint requires an API key with the \"Create status page incidents, status page maintenance windows, and publish status page updates\" scope.", "operationId": "Status Pages V2_CreateStatusPageIncidentUpdate", "requestBody": { "content": { "application/json": { "example": { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "incident_status": "investigating", "message": "The fix has been deployed and we are monitoring the situation. Some users may still experience intermittent issues.", "notify_subscribers": true, "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" }, "schema": { "$ref": "#/components/schemas/StatusPagesCreateStatusPageIncidentUpdatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "status_page_incident_update": { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } }, "schema": { "$ref": "#/components/schemas/StatusPagesCreateStatusPageIncidentUpdateResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Status Pages V2" ], "x-display-name": "Create", "x-docs-display-name": "Create", "x-docs-group-name": "Status Page Incident Updates V2", "x-docs-resource-type": "StatusPageIncidentUpdateV2", "x-mint": { "content": "🔑 Requires the `status_pages.publish_updates` scope." }, "x-rbac-scopes": [ "status_pages.publish_updates" ] } }, "/v2/status_page_incidents": { "get": { "description": "List status page incidents.\n\nThis endpoint requires a valid API key but no specific scopes.", "operationId": "Status Pages V2_ListStatusPageIncidents", "parameters": [ { "allowEmptyValue": true, "description": "ID of the status page. You can find this by calling the ListStatusPages endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "status_page_id", "required": true, "schema": { "description": "ID of the status page. You can find this by calling the ListStatusPages endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page incidents to only those that impacted the specified component. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "in": "query", "name": "component_id", "schema": { "description": "Filter status page incidents to only those that impacted the specified component. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page incidents to only those that impacted components in the specified group. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG2", "in": "query", "name": "group_id", "schema": { "description": "Filter status page incidents to only those that impacted components in the specified group. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG2", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page incidents to only those that impacted the specified sub-page. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG3", "in": "query", "name": "sub_page_id", "schema": { "description": "Filter status page incidents to only those that impacted the specified sub-page. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG3", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page incidents to only those that had impacts during or after this time.", "example": "2021-08-17T13:28:57.801578Z", "in": "query", "name": "start_at", "schema": { "description": "Filter status page incidents to only those that had impacts during or after this time.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page incidents to only those that had impacts during or before this time.", "example": "2021-08-17T13:28:57.801578Z", "in": "query", "name": "end_at", "schema": { "description": "Filter status page incidents to only those that had impacts during or before this time.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "status_page_incidents": [ { "component_impacts": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "name": "Elevated API latency", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } ] }, "schema": { "$ref": "#/components/schemas/StatusPagesListStatusPageIncidentsResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Status Pages V2" ], "x-display-name": "List", "x-docs-display-name": "List", "x-docs-group-name": "Status Page Incidents V2", "x-docs-resource-type": "StatusPageIncidentV2" }, "post": { "description": "Create a status page incident.\n\nThis endpoint requires an API key with the \"Create status page incidents, status page maintenance windows, and publish status page updates\" scope.", "operationId": "Status Pages V2_CreateStatusPageIncident", "requestBody": { "content": { "application/json": { "example": { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "idempotency_key": "alert-12345-abcde", "incident_status": "investigating", "message": "We are currently investigating reports of elevated error rates affecting our API.", "name": "Elevated API latency", "notify_subscribers": true, "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "schema": { "$ref": "#/components/schemas/StatusPagesCreateStatusPageIncidentPayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "status_page_incident": { "component_impacts": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "name": "Elevated API latency", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "schema": { "$ref": "#/components/schemas/StatusPagesCreateStatusPageIncidentResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Status Pages V2" ], "x-display-name": "Create", "x-docs-display-name": "Create", "x-docs-group-name": "Status Page Incidents V2", "x-docs-resource-type": "StatusPageIncidentV2", "x-mint": { "content": "🔑 Requires the `status_pages.publish_updates` scope." }, "x-rbac-scopes": [ "status_pages.publish_updates" ] } }, "/v2/status_page_incidents/{status_page_incident_id}": { "get": { "description": "Show a status page incident.\n\nThis endpoint requires a valid API key but no specific scopes.", "operationId": "Status Pages V2_ShowStatusPageIncident", "parameters": [ { "description": "ID of the status page incident", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "in": "path", "name": "status_page_incident_id", "required": true, "schema": { "description": "ID of the status page incident", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "status_page_incident": { "component_impacts": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "name": "Elevated API latency", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "schema": { "$ref": "#/components/schemas/StatusPagesShowStatusPageIncidentResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Status Pages V2" ], "x-display-name": "Show", "x-docs-display-name": "Show", "x-docs-group-name": "Status Page Incidents V2", "x-docs-resource-type": "StatusPageIncidentV2" }, "put": { "description": "Update a status page incident.\n\nThis endpoint requires an API key with the \"Create status page incidents, status page maintenance windows, and publish status page updates\" scope.", "operationId": "Status Pages V2_UpdateStatusPageIncident", "parameters": [ { "description": "ID of the status page incident", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "in": "path", "name": "status_page_incident_id", "required": true, "schema": { "description": "ID of the status page incident", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "name": "Elevated API latency" }, "schema": { "$ref": "#/components/schemas/StatusPagesUpdateStatusPageIncidentPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "status_page_incident": { "component_impacts": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "name": "Elevated API latency", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "schema": { "$ref": "#/components/schemas/StatusPagesUpdateStatusPageIncidentResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Status Pages V2" ], "x-display-name": "Update", "x-docs-display-name": "Update", "x-docs-group-name": "Status Page Incidents V2", "x-docs-resource-type": "StatusPageIncidentV2", "x-mint": { "content": "🔑 Requires the `status_pages.publish_updates` scope." }, "x-rbac-scopes": [ "status_pages.publish_updates" ] } }, "/v2/status_page_maintenance_updates": { "post": { "description": "Post an update on a Status Page maintenance window.\n\nThis is the endpoint to use when completing a maintenance window - set maintenance_status to \"maintenance_complete\" to end the maintenance. There is a limit of 100 updates per maintenance window.\n\nThis endpoint requires an API key with the \"Create status page incidents, status page maintenance windows, and publish status page updates\" scope.", "operationId": "Status Pages V2_CreateStatusPageMaintenanceUpdate", "requestBody": { "content": { "application/json": { "example": { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "maintenance_status": "maintenance_scheduled", "message": "Scheduled maintenance is underway for our database infrastructure. Some services may experience brief interruptions during this window.", "notify_subscribers": true, "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" }, "schema": { "$ref": "#/components/schemas/StatusPagesCreateStatusPageMaintenanceUpdatePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "status_page_maintenance_update": { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } }, "schema": { "$ref": "#/components/schemas/StatusPagesCreateStatusPageMaintenanceUpdateResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Status Pages V2" ], "x-display-name": "Create", "x-docs-display-name": "Create", "x-docs-group-name": "Status Page Maintenance Updates V2", "x-docs-resource-type": "StatusPageMaintenanceUpdateV2", "x-mint": { "content": "🔑 Requires the `status_pages.publish_updates` scope." }, "x-rbac-scopes": [ "status_pages.publish_updates" ] } }, "/v2/status_page_maintenances": { "get": { "description": "List status page maintenances.\n\nThis endpoint requires a valid API key but no specific scopes.", "operationId": "Status Pages V2_ListStatusPageMaintenances", "parameters": [ { "allowEmptyValue": true, "description": "ID of the status page. You can find this by calling the ListStatusPages endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "query", "name": "status_page_id", "required": true, "schema": { "description": "ID of the status page. You can find this by calling the ListStatusPages endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page maintenance windows to only those that impacted the specified component. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "in": "query", "name": "component_id", "schema": { "description": "Filter status page maintenance windows to only those that impacted the specified component. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page maintenance windows to only those that impacted components in the specified group. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG2", "in": "query", "name": "group_id", "schema": { "description": "Filter status page maintenance windows to only those that impacted components in the specified group. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG2", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page maintenance windows to only those that impacted the specified sub-page. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG3", "in": "query", "name": "sub_page_id", "schema": { "description": "Filter status page maintenance windows to only those that impacted the specified sub-page. This ID may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG3", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page maintenance windows to only those that had impacts during or after this time.", "example": "2021-08-17T13:28:57.801578Z", "in": "query", "name": "start_at", "schema": { "description": "Filter status page maintenance windows to only those that had impacts during or after this time.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter status page maintenance windows to only those that had impacts during or before this time.", "example": "2021-08-17T13:28:57.801578Z", "in": "query", "name": "end_at", "schema": { "description": "Filter status page maintenance windows to only those that had impacts during or before this time.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "status_page_maintenances": [ { "automate_maintenance_status": true, "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } ] }, "schema": { "$ref": "#/components/schemas/StatusPagesListStatusPageMaintenancesResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Status Pages V2" ], "x-display-name": "List", "x-docs-display-name": "List", "x-docs-group-name": "Status Page Maintenances V2", "x-docs-resource-type": "StatusPageMaintenanceV2" }, "post": { "description": "Schedule a Status Page maintenance window.\n\nThis endpoint requires an API key with the \"Create status page incidents, status page maintenance windows, and publish status page updates\" scope.", "operationId": "Status Pages V2_CreateStatusPageMaintenance", "requestBody": { "content": { "application/json": { "example": { "affected_component_ids": [ "01FCNDV6P870EA6S7TK1DSYDG2" ], "automate_maintenance_status": true, "end_at": "2025-01-28T12:00:00Z", "idempotency_key": "maintenance-12345-abcde", "maintenance_status": "maintenance_scheduled", "message": "Planned maintenance has been scheduled to upgrade our infrastructure. We expect minimal disruption, but some features may be briefly unavailable.", "name": "Routine infrastructure upgrade", "notify_subscribers": true, "start_at": "2025-01-28T10:00:00Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "schema": { "$ref": "#/components/schemas/StatusPagesCreateStatusPageMaintenancePayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "status_page_maintenance": { "automate_maintenance_status": true, "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "schema": { "$ref": "#/components/schemas/StatusPagesCreateStatusPageMaintenanceResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Status Pages V2" ], "x-display-name": "Create", "x-docs-display-name": "Create", "x-docs-group-name": "Status Page Maintenances V2", "x-docs-resource-type": "StatusPageMaintenanceV2", "x-mint": { "content": "🔑 Requires the `status_pages.publish_updates` scope." }, "x-rbac-scopes": [ "status_pages.publish_updates" ] } }, "/v2/status_page_maintenances/{status_page_maintenance_id}": { "delete": { "description": "Delete a Status Page maintenance window.\n\nThe maintenance window and its updates stop appearing on your public status page, links to it stop working, and a window that has not yet run publishes no further automated updates. This cannot be undone.\n\nSubscribers are not told the window has been deleted, so anyone already emailed about it will have updates for a maintenance window they can no longer find.\n\nThis endpoint requires an API key with the \"Create status page incidents, status page maintenance windows, and publish status page updates\" scope.", "operationId": "Status Pages V2_DeleteStatusPageMaintenance", "parameters": [ { "description": "ID of the status page maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "in": "path", "name": "status_page_maintenance_id", "required": true, "schema": { "description": "ID of the status page maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Status Pages V2" ], "x-display-name": "Delete", "x-docs-display-name": "Delete", "x-docs-group-name": "Status Page Maintenances V2", "x-docs-resource-type": "StatusPageMaintenanceV2", "x-mint": { "content": "🔑 Requires the `status_pages.publish_updates` scope." }, "x-rbac-scopes": [ "status_pages.publish_updates" ] }, "get": { "description": "Show a status page maintenance window.\n\nThis endpoint requires a valid API key but no specific scopes.", "operationId": "Status Pages V2_ShowStatusPageMaintenance", "parameters": [ { "description": "ID of the status page maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "in": "path", "name": "status_page_maintenance_id", "required": true, "schema": { "description": "ID of the status page maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "status_page_maintenance": { "automate_maintenance_status": true, "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "schema": { "$ref": "#/components/schemas/StatusPagesShowStatusPageMaintenanceResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Status Pages V2" ], "x-display-name": "Show", "x-docs-display-name": "Show", "x-docs-group-name": "Status Page Maintenances V2", "x-docs-resource-type": "StatusPageMaintenanceV2" }, "put": { "description": "Update the name and scheduled window of a Status Page maintenance window.\n\nThe new start_at and end_at apply to every component this maintenance window affects.\n\nThis does not publish an update to your status page and does not notify subscribers. Automated updates only move a window forwards, so one that has already started or completed will not move back to an earlier status. To move a status backwards, or to tell subscribers the schedule has changed, post a maintenance update to POST /status_page_maintenance_updates.\n\nThis endpoint requires an API key with the \"Create status page incidents, status page maintenance windows, and publish status page updates\" scope.", "operationId": "Status Pages V2_UpdateStatusPageMaintenance", "parameters": [ { "description": "ID of the status page maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "in": "path", "name": "status_page_maintenance_id", "required": true, "schema": { "description": "ID of the status page maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "end_at": "2025-01-28T12:00:00Z", "name": "Routine infrastructure upgrade", "start_at": "2025-01-28T10:00:00Z" }, "schema": { "$ref": "#/components/schemas/StatusPagesUpdateStatusPageMaintenancePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "status_page_maintenance": { "automate_maintenance_status": true, "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "schema": { "$ref": "#/components/schemas/StatusPagesUpdateStatusPageMaintenanceResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Status Pages V2" ], "x-display-name": "Update", "x-docs-display-name": "Update", "x-docs-group-name": "Status Page Maintenances V2", "x-docs-resource-type": "StatusPageMaintenanceV2", "x-mint": { "content": "🔑 Requires the `status_pages.publish_updates` scope." }, "x-rbac-scopes": [ "status_pages.publish_updates" ] } }, "/v2/status_page_retrospective_incidents": { "post": { "description": "Create a retrospective (historical) status page incident.\n\nUse this to backfill a completed incident with a reconstructed timeline of past updates, for example when migrating from another status page provider. Every update's published_at must be in the past, the updates must be ordered chronologically (earliest first), and the final update must set incident_status to \"resolved\".\n\nRetrospective incidents never notify subscribers.\n\nAs this endpoint is intended for bulk historical backfill, it has a dedicated rate limit of 5 requests per second (with a burst allowance of 300 requests) per API key. If you exceed it you'll receive a 429 response with a Retry-After header; back off and retry to resume your backfill.\n\nThis endpoint requires an API key with the \"Create status page incidents, status page maintenance windows, and publish status page updates\" scope.", "operationId": "Status Pages V2_CreateStatusPageRetrospectiveIncident", "requestBody": { "content": { "application/json": { "example": { "idempotency_key": "historical-incident-2021-08-17", "name": "Elevated API latency", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "incident_status": "investigating", "message": "We are currently investigating reports of elevated error rates affecting our API.", "published_at": "2021-08-17T13:28:57.801578Z" } ] }, "schema": { "$ref": "#/components/schemas/StatusPagesCreateStatusPageRetrospectiveIncidentPayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "status_page_incident": { "component_impacts": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "name": "Elevated API latency", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "schema": { "$ref": "#/components/schemas/StatusPagesCreateStatusPageRetrospectiveIncidentResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create retrospective", "tags": [ "Status Pages V2" ], "x-display-name": "Create retrospective", "x-docs-display-name": "Create retrospective", "x-docs-group-name": "Status Page Incidents V2", "x-docs-resource-type": "StatusPageIncidentV2", "x-mint": { "content": "🔑 Requires the `status_pages.publish_updates` scope." }, "x-rbac-scopes": [ "status_pages.publish_updates" ] } }, "/v2/status_page_structures/{status_page_id}": { "get": { "description": "Show the structure of a status page.\n\nThis endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page. Use this to find component IDs when specifying affected components for incidents or maintenance windows.", "operationId": "Status Pages V2_ShowStatusPageStructure", "parameters": [ { "description": "ID of the status page", "example": "abc123", "in": "path", "name": "status_page_id", "required": true, "schema": { "description": "ID of the status page", "example": "abc123", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "current_structure": { "items": [ { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" }, "sub_page": { "id": "01FCNDV6P870EA6S7TK1DSYDG1", "items": [ { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" } } ], "name": "United Kingdom" } } ] } }, "schema": { "$ref": "#/components/schemas/StatusPagesShowStatusPageStructureResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Status Pages V2" ], "x-display-name": "Show", "x-docs-display-name": "Show", "x-docs-group-name": "Status Pages V2", "x-docs-resource-type": "StatusPageV2" } }, "/v2/status_pages": { "get": { "description": "List all status pages for your organisation.\n\nThis endpoint requires a valid API key but no specific scopes. Use this to find status page IDs for use in other endpoints.", "operationId": "Status Pages V2_ListStatusPages", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "status_pages": [ { "description": "This status page is our public status page.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Our public status page", "public_url": "https://statuspage.incident.io/our-public-status-page" } ] }, "schema": { "$ref": "#/components/schemas/StatusPagesListStatusPagesResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Status Pages V2" ], "x-display-name": "List", "x-docs-display-name": "List", "x-docs-group-name": "Status Pages V2", "x-docs-resource-type": "StatusPageV2" } }, "/v3/teams": { "get": { "description": "List all teams in the organisation.", "operationId": "Teams V3_List", "parameters": [ { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 250, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "teams": [ { "catalog_entry": { "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "id": "abc123", "members": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "slack_user_id": "U02AYNF2XJM" } ], "name": "abc123" } ] }, "schema": { "$ref": "#/components/schemas/TeamsListResultV3" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Teams V3" ], "x-docs-display-name": "List", "x-docs-group-name": "Teams V3", "x-docs-resource-type": "TeamV3", "x-mint": { "content": "🔑 Requires the `catalog_entries.view` scope." }, "x-rbac-scopes": [ "catalog_entries.view" ] } }, "/v3/teams/{id}": { "get": { "description": "Get a single team.", "operationId": "Teams V3_Show", "parameters": [ { "description": "Unique ID of the team", "example": "abc123", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique ID of the team", "example": "abc123", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "team": { "catalog_entry": { "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "id": "abc123", "members": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "slack_user_id": "U02AYNF2XJM" } ], "name": "abc123" } }, "schema": { "$ref": "#/components/schemas/TeamsShowResultV3" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Teams V3" ], "x-docs-display-name": "Show", "x-docs-group-name": "Teams V3", "x-docs-resource-type": "TeamV3", "x-mint": { "content": "🔑 Requires the `catalog_entries.view` scope." }, "x-rbac-scopes": [ "catalog_entries.view" ] } }, "/v2/telemetry/data_sources/{id}": { "put": { "description": "Update the credentials or configuration of a telemetry data source. Provide only the config block that matches your data source type (e.g. grafana_config for Grafana, datadog_config for Datadog). New credentials are validated against the provider before being saved.", "operationId": "Telemetry V2_UpdateDataSource", "parameters": [ { "description": "Data source ID", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "in": "path", "name": "id", "required": true, "schema": { "description": "Data source ID", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "datadog_config": { "api_key": "abc123", "app_key": "abc123" }, "grafana_config": { "api_key": "glsa_123", "api_url": "grafana.example.com" }, "name": "Production Grafana" }, "schema": { "$ref": "#/components/schemas/TelemetryUpdateDataSourcePayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data_source": { "created_at": "2021-08-17T13:28:57.801578Z", "enabled": true, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary Prometheus", "provider": "grafana", "source_type": "grafana", "updated_at": "2021-08-17T13:28:57.801578Z", "version": "8.5.27" } }, "schema": { "$ref": "#/components/schemas/TelemetryUpdateDataSourceResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Telemetry V2" ], "x-display-name": "Update", "x-docs-display-name": "Update", "x-docs-group-name": "Telemetry V2", "x-docs-resource-type": "TelemetryDataSourceV2", "x-mint": { "content": "🔑 Requires the `telemetry_data_source.update` scope." }, "x-rbac-scopes": [ "telemetry_data_source.update" ] } }, "/v2/users": { "get": { "description": "List users in your account.", "operationId": "Users V2_List", "parameters": [ { "allowEmptyValue": true, "description": "Filter by email address", "example": "john.doe@incident.io", "in": "query", "name": "email", "schema": { "description": "Filter by email address", "example": "john.doe@incident.io", "type": "string" } }, { "allowEmptyValue": true, "description": "Filter by Slack user ID", "example": "U12345678", "in": "query", "name": "slack_user_id", "schema": { "description": "Filter by Slack user ID", "example": "U12345678", "type": "string" } }, { "allowEmptyValue": true, "description": "Include deactivated or not-yet-active users (defaults to false). Useful for resolving users who have since been offboarded.", "example": true, "in": "query", "name": "include_inactive", "schema": { "description": "Include deactivated or not-yet-active users (defaults to false). Useful for resolving users who have since been offboarded.", "example": true, "type": "boolean" } }, { "allowEmptyValue": true, "description": "Integer number of records to return", "example": 25, "in": "query", "name": "page_size", "schema": { "default": 25, "description": "Integer number of records to return", "example": 25, "format": "int64", "maximum": 10000, "minimum": 1, "type": "integer" } }, { "allowEmptyValue": true, "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "after", "schema": { "description": "An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "users": [ { "base_role": { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" }, "custom_roles": [ { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" } ], "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_active": true, "name": "Lisa Karlin Curtis", "role": "owner", "seats": { "on_call": "full_access", "response": "viewer_only" }, "slack_user_id": "U02AYNF2XJM" } ] }, "schema": { "$ref": "#/components/schemas/UsersListResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Users V2" ], "x-docs-display-name": "List", "x-docs-group-name": "Users V2", "x-docs-resource-type": "UserWithRolesV2", "x-mint": { "content": "🔑 Requires the `users.view` scope." }, "x-rbac-scopes": [ "users.view" ] } }, "/v2/users/{id}": { "get": { "description": "Get a single user.", "operationId": "Users V2_Show", "parameters": [ { "description": "Unique identifier of the user", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the user", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "user": { "base_role": { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" }, "custom_roles": [ { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" } ], "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_active": true, "name": "Lisa Karlin Curtis", "role": "owner", "seats": { "on_call": "full_access", "response": "viewer_only" }, "slack_user_id": "U02AYNF2XJM" } }, "schema": { "$ref": "#/components/schemas/UsersShowResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Users V2" ], "x-docs-display-name": "Show", "x-docs-group-name": "Users V2", "x-docs-resource-type": "UserWithRolesV2", "x-mint": { "content": "🔑 Requires the `users.view` scope." }, "x-rbac-scopes": [ "users.view" ] } }, "/v2/users/{user_id}/notification_methods": { "get": { "description": "List notification methods for a user. Phone numbers are partially redacted unless the API key holds the notification_methods.view_unredacted scope.", "operationId": "Users V2_ListNotificationMethods", "parameters": [ { "description": "The ID of the user whose notification methods you want to list.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "user_id", "required": true, "schema": { "description": "The ID of the user whose notification methods you want to list.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "notification_methods": [ { "address": "•••••••6789", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_usable": true, "method_type": "app", "phone_details": { "supports_sms": true, "supports_voice": true } } ] }, "schema": { "$ref": "#/components/schemas/UsersListNotificationMethodsResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Users V2" ], "x-display-name": "List", "x-docs-display-name": "List", "x-docs-group-name": "Notification Methods V2", "x-docs-resource-type": "OnCallNotificationMethodPublicV2", "x-mint": { "content": "🔑 Requires the `notification_methods.view` scope." }, "x-rbac-scopes": [ "notification_methods.view" ] } }, "/v2/users/{user_id}/notification_rules": { "get": { "description": "List notification rules for a user. Rules define how and when a user is notified for on-call pages. Only includes high_urgency and low_urgency rules; shift_changes rules are not returned.", "operationId": "Users V2_ListNotificationRules", "parameters": [ { "description": "The ID of the user whose notification rules you want to list.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "user_id", "required": true, "schema": { "description": "The ID of the user whose notification rules you want to list.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "notification_rules": [ { "app": { "push_notification_criticality": "critical" }, "delay_seconds": 0, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "method_target": { "all": {}, "specific": { "id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "specific" }, "method_type": "app", "phone": { "channel": "voice" }, "rule_type": "low_urgency" } ] }, "schema": { "$ref": "#/components/schemas/UsersListNotificationRulesResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Users V2" ], "x-display-name": "List", "x-docs-display-name": "List", "x-docs-group-name": "Notification Rules V2", "x-docs-resource-type": "OnCallNotificationRulePublicV2", "x-mint": { "content": "🔑 Requires the `notification_rules.view` scope." }, "x-rbac-scopes": [ "notification_rules.view" ] } }, "/v2/users/{user_id}/paging_provider": { "get": { "description": "Show the paging provider that would be used to escalate to this user. Reflects their explicit preference if set; otherwise resolves to the effective fallback (typically `native` for on-call seat users, or a linked external provider otherwise). May be omitted only when the user cannot be escalated to at all (no seat and no linked external user).", "operationId": "Users V2_ShowPagingProvider", "parameters": [ { "description": "The ID of the user.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "user_id", "required": true, "schema": { "description": "The ID of the user.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "preferred_escalation_provider": "native" }, "schema": { "$ref": "#/components/schemas/UsersShowPagingProviderResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show paging provider", "tags": [ "Users V2" ], "x-docs-display-name": "Show paging provider", "x-docs-group-name": "Users V2", "x-docs-resource-type": "UserWithRolesV2", "x-mint": { "content": "🔑 Requires the `user_preferences.view` scope." }, "x-rbac-scopes": [ "user_preferences.view" ] }, "post": { "description": "Update a user's preferred paging provider.", "operationId": "Users V2_UpdatePagingProvider", "parameters": [ { "description": "The ID of the user to update.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "user_id", "required": true, "schema": { "description": "The ID of the user to update.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "preferred_escalation_provider": "native" }, "schema": { "$ref": "#/components/schemas/UsersUpdatePagingProviderPayloadV2" } } }, "required": true }, "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update paging provider", "tags": [ "Users V2" ], "x-docs-display-name": "Update paging provider", "x-docs-group-name": "Users V2", "x-docs-resource-type": "UserWithRolesV2", "x-mint": { "content": "🔑 Requires the `users.preferred_paging_provider.edit` scope." }, "x-rbac-scopes": [ "users.preferred_paging_provider.edit" ] } }, "/v1/identity": { "get": { "description": "Test if your API key is valid, and which roles it has.", "operationId": "Utilities V1_Identity", "responses": { "200": { "content": { "application/json": { "example": { "identity": { "dashboard_url": "https://app.incident.io/my-org", "name": "Alertmanager token", "roles": [ "viewer" ], "team_roles": [ "catalog_editor" ], "teams": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Platform" } ] } }, "schema": { "$ref": "#/components/schemas/UtilitiesIdentityResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show Identity", "tags": [ "Utilities V1" ], "x-docs-display-name": "Show Identity", "x-docs-group-name": "Utilities V1" } }, "/v1/ip_ranges": { "get": { "description": "List the IP addresses our requests to your systems come from.\n\nUse this to keep a firewall allowlist up to date without watching our documentation. Poll\nit rather than copying the list once. We give at least two weeks' notice before our own\naddresses change. Webhook deliveries come from our provider's addresses, so we cannot\npromise notice on those.\n\nThese are the addresses we send from. Do not allowlist them for inbound access: our API is\nserved on different addresses, and those change without notice.", "operationId": "Utilities V1_IPRanges", "responses": { "200": { "content": { "application/json": { "example": { "ip_ranges": [ { "cidr": "34.91.219.113/32", "description": "Requests to your systems from integrations and from workflow \"Send a webhook\" steps" } ] }, "schema": { "$ref": "#/components/schemas/UtilitiesIPRangesResultV1" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List IP Ranges", "tags": [ "Utilities V1" ], "x-docs-display-name": "List IP Ranges", "x-docs-group-name": "Utilities V1", "x-docs-resource-type": "IPRangeV1" } }, "/v1/openapiV3.json": { "get": { "description": "Get the OpenAPI (v3) definition.", "operationId": "Utilities V1_OpenAPIV3", "responses": { "200": { "content": { "application/json": { "schema": { "format": "binary", "type": "string" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show OpenAPI V3 Spec", "tags": [ "Utilities V1" ], "x-docs-display-name": "Show OpenAPI V3 Spec", "x-docs-group-name": "Utilities V1", "security": [] } }, "/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." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "WorkflowRuns 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." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "WorkflowRuns 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" ] } }, "/v2/workflows": { "get": { "description": "List all workflows", "operationId": "Workflows V2_ListWorkflows", "responses": { "200": { "content": { "application/json": { "example": { "workflows": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "folder": "My folder 01", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -> Affected Team", "type": "IncidentSeverity" } ], "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incident_scope": "owning_teams", "runs_from": "2021-08-17T13:28:57.801578Z", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "label": "PagerDuty Escalate", "name": "pagerduty.escalate" } ], "trigger": { "label": "Incident Updated", "name": "incident.updated" }, "version": 3 } ] }, "schema": { "$ref": "#/components/schemas/WorkflowsListWorkflowsResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Workflows V2" ], "x-display-name": "List", "x-docs-display-name": "List", "x-docs-group-name": "Workflows V2", "x-docs-resource-type": "WorkflowV2", "x-mint": { "content": "🔑 Requires the `workflows.view` scope." }, "x-rbac-scopes": [ "workflows.view" ] }, "post": { "description": "Create a new workflow", "operationId": "Workflows V2_CreateWorkflow", "requestBody": { "content": { "application/json": { "example": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "folder": "My folder 01", "form_fields": [ { "array": true, "description": "The customer affected by this incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "key": "affected_customer", "required": true, "title": "Affected customer", "type": "User" } ], "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ "incident.url" ], "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incident_scope": "owning_teams", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "for_each": "abc123", "id": "abc123", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ] } ], "trigger": "incident.updated" }, "schema": { "$ref": "#/components/schemas/WorkflowsCreateWorkflowPayloadV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "management_meta": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "managed_by": "dashboard", "source_url": "https://github.com/my-company/infrastructure" }, "workflow": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "folder": "My folder 01", "form_fields": [ { "array": true, "description": "The customer affected by this incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "key": "affected_customer", "required": true, "title": "Affected customer", "type": "User" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -> Affected Team", "type": "IncidentSeverity" } ], "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incident_scope": "owning_teams", "runs_from": "2021-08-17T13:28:57.801578Z", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "for_each": "abc123", "id": "abc123", "label": "PagerDuty Escalate", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ] } ], "trigger": { "label": "Incident Updated", "name": "incident.updated" }, "version": 3 } }, "schema": { "$ref": "#/components/schemas/WorkflowsCreateWorkflowResultV2" } } }, "description": "Created response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Create", "tags": [ "Workflows V2" ], "x-display-name": "Create", "x-docs-display-name": "Create", "x-docs-group-name": "Workflows V2", "x-docs-resource-type": "WorkflowV2", "x-mint": { "content": "🔑 Requires the `workflows.create` scope." }, "x-rbac-scopes": [ "workflows.create" ] } }, "/v2/workflows/{id}": { "delete": { "description": "Archives a workflow", "operationId": "Workflows V2_DestroyWorkflow", "parameters": [ { "description": "Unique identifier for the workflow", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the workflow", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "204": { "description": "No Content response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Delete", "tags": [ "Workflows V2" ], "x-display-name": "Destroy", "x-docs-display-name": "Delete", "x-docs-group-name": "Workflows V2", "x-docs-resource-type": "WorkflowV2", "x-mint": { "content": "🔑 Requires the `workflows.destroy` scope." }, "x-rbac-scopes": [ "workflows.destroy" ] }, "get": { "description": "Show a workflow by ID", "operationId": "Workflows V2_ShowWorkflow", "parameters": [ { "allowEmptyValue": true, "description": "Skips workflow step upgrades, when the parameters for an existing workflow step change", "example": false, "in": "query", "name": "skip_step_upgrades", "schema": { "description": "Skips workflow step upgrades, when the parameters for an existing workflow step change", "example": false, "type": "boolean" } }, { "description": "Unique identifier for the workflow", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for the workflow", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "management_meta": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "managed_by": "dashboard", "source_url": "https://github.com/my-company/infrastructure" }, "workflow": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "folder": "My folder 01", "form_fields": [ { "array": true, "description": "The customer affected by this incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "key": "affected_customer", "required": true, "title": "Affected customer", "type": "User" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -> Affected Team", "type": "IncidentSeverity" } ], "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incident_scope": "owning_teams", "runs_from": "2021-08-17T13:28:57.801578Z", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "for_each": "abc123", "id": "abc123", "label": "PagerDuty Escalate", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ] } ], "trigger": { "label": "Incident Updated", "name": "incident.updated" }, "version": 3 } }, "schema": { "$ref": "#/components/schemas/WorkflowsShowWorkflowResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Show", "tags": [ "Workflows V2" ], "x-display-name": "Show", "x-docs-display-name": "Show", "x-docs-group-name": "Workflows V2", "x-docs-resource-type": "WorkflowV2", "x-mint": { "content": "🔑 Requires the `workflows.view` scope." }, "x-rbac-scopes": [ "workflows.view" ] }, "put": { "description": "Updates a workflow", "operationId": "Workflows V2_UpdateWorkflow", "parameters": [ { "description": "ID of the workflow to update", "examples": { "default": { "summary": "default", "value": "01FCNDV6P870EA6S7TK1DSYDG0" } }, "in": "path", "name": "id", "required": true, "schema": { "description": "ID of the workflow to update", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "folder": "My folder 01", "form_fields": [ { "array": true, "description": "The customer affected by this incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "key": "affected_customer", "required": true, "title": "Affected customer", "type": "User" } ], "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ "incident.url" ], "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incident_scope": "owning_teams", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "skip_step_upgrades": false, "state": "active", "steps": [ { "for_each": "abc123", "id": "abc123", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ] } ] }, "schema": { "$ref": "#/components/schemas/WorkflowsUpdateWorkflowPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "management_meta": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "managed_by": "dashboard", "source_url": "https://github.com/my-company/infrastructure" }, "workflow": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "folder": "My folder 01", "form_fields": [ { "array": true, "description": "The customer affected by this incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "key": "affected_customer", "required": true, "title": "Affected customer", "type": "User" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -> Affected Team", "type": "IncidentSeverity" } ], "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incident_scope": "owning_teams", "runs_from": "2021-08-17T13:28:57.801578Z", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "for_each": "abc123", "id": "abc123", "label": "PagerDuty Escalate", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ] } ], "trigger": { "label": "Incident Updated", "name": "incident.updated" }, "version": 3 } }, "schema": { "$ref": "#/components/schemas/WorkflowsUpdateWorkflowResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Update", "tags": [ "Workflows V2" ], "x-display-name": "Update", "x-docs-display-name": "Update", "x-docs-group-name": "Workflows V2", "x-docs-resource-type": "WorkflowV2", "x-mint": { "content": "🔑 Requires the `workflows.update` scope." }, "x-rbac-scopes": [ "workflows.update" ] } } }, "components": { "schemas": { "ActionsListResultV3": { "example": { "actions": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "actions": { "example": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/ActionV3" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV3" } }, "required": [ "actions", "pagination_meta" ], "type": "object" }, "ErrorResponse": { "example": { "debug": { "message": "Something broke: and something else: and something else", "stacktrace": [ "thing.go:123" ] }, "errors": [ { "code": "trial_expired", "message": "Default incident call link must be a valid URL", "metadata": { "abc123": "abc123" }, "source": { "field": "default_call_url", "pointer": "/settings/default_call_url" } } ], "rate_limit": { "limit": 100, "name": "client_ip", "remaining": 98, "retry_after": "2020-01-01T00:00:00Z" }, "request_id": "2T1p0e3j", "status": 408, "type": "invalid_request_error" }, "properties": { "debug": { "$ref": "#/components/schemas/ErrorDebug" }, "errors": { "description": "List of errors that caused this request to fail", "example": [ { "code": "trial_expired", "message": "Default incident call link must be a valid URL", "metadata": { "abc123": "abc123" }, "source": { "field": "default_call_url", "pointer": "/settings/default_call_url" } } ], "items": { "$ref": "#/components/schemas/ErrorSingle" }, "type": "array" }, "rate_limit": { "$ref": "#/components/schemas/ErrorRateLimit" }, "request_id": { "description": "Unique identifier of the request", "example": "2T1p0e3j", "type": "string" }, "status": { "description": "HTTP status of the response", "example": 408, "format": "int64", "type": "integer" }, "type": { "description": "Machine-readable identifier for the general category of error", "enum": [ "invalid_request_error", "authentication_error", "resource_forbidden", "not_found", "not_acceptable", "method_not_allowed", "request_timeout", "conflict", "precondition_failed", "payload_too_large", "validation_error", "too_many_requests", "api_error", "rate_limit_reached", "client_timeout" ], "example": "invalid_request_error", "type": "string" } }, "required": [ "type", "status", "request_id", "errors" ], "type": "object" }, "ActionsCreatePayloadV3": { "example": { "assignee_id": "01FCNDV6P870EA6S7TK1DSYDG0", "description": "Call the fire brigade", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H" }, "properties": { "assignee_id": { "description": "ID of the user this action is assigned to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "description": { "description": "Description of the action. Supports Markdown.", "example": "Call the fire brigade", "type": "string" }, "incident_id": { "description": "Unique identifier of the incident the action belongs to", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" } }, "required": [ "incident_id", "description" ], "type": "object" }, "ActionsCreateResultV3": { "example": { "action": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "action": { "$ref": "#/components/schemas/ActionV3" } }, "required": [ "action" ], "type": "object" }, "ActionsShowResultV3": { "example": { "action": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "action": { "$ref": "#/components/schemas/ActionV3" } }, "required": [ "action" ], "type": "object" }, "ActionsUpdatePayloadV3": { "example": { "assignee_id": "01FCNDV6P870EA6S7TK1DSYDG0", "description": "Call the fire brigade", "status": "outstanding" }, "properties": { "assignee_id": { "description": "ID of the user this action is assigned to. Set to null to unassign.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "description": { "description": "Description of the action. Supports Markdown.", "example": "Call the fire brigade", "type": "string" }, "status": { "description": "Status of the action. Setting this to `deleted` is not allowed; use the delete endpoint instead.", "enum": [ "outstanding", "completed", "deleted", "not_doing" ], "example": "outstanding", "type": "string" } }, "required": [ "description", "status" ], "type": "object" }, "ActionsUpdateResultV3": { "example": { "action": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "status": "outstanding", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "action": { "$ref": "#/components/schemas/ActionV3" } }, "required": [ "action" ], "type": "object" }, "AlertAttributesListResultV2": { "example": { "alert_attributes": [ { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" } ] }, "properties": { "alert_attributes": { "example": [ { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" } ], "items": { "$ref": "#/components/schemas/AlertAttributeV2" }, "type": "array" } }, "required": [ "alert_attributes" ], "type": "object" }, "AlertAttributesCreatePayloadV2": { "example": { "array": false, "emoji": "fire", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "properties": { "array": { "description": "Whether this attribute is an array", "example": false, "type": "boolean" }, "emoji": { "description": "The emoji to display alongside this attribute in chat messages, stored without colons", "example": "fire", "type": "string" }, "name": { "description": "Unique name of this attribute", "example": "service", "type": "string" }, "required": { "description": "Whether this attribute is required. If this field is not set, the existing setting will be preserved.", "example": false, "type": "boolean" }, "type": { "description": "Engine resource name for this attribute", "example": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]", "type": "string" } }, "required": [ "name", "type", "array" ], "type": "object" }, "AlertAttributesCreateResultV2": { "example": { "alert_attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" } }, "properties": { "alert_attribute": { "$ref": "#/components/schemas/AlertAttributeV2" } }, "required": [ "alert_attribute" ], "type": "object" }, "AlertAttributesShowResultV2": { "example": { "alert_attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" } }, "properties": { "alert_attribute": { "$ref": "#/components/schemas/AlertAttributeV2" } }, "required": [ "alert_attribute" ], "type": "object" }, "AlertAttributesUpdatePayloadV2": { "example": { "array": false, "emoji": "fire", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" }, "properties": { "array": { "description": "Whether this attribute is an array", "example": false, "type": "boolean" }, "emoji": { "description": "The emoji to display alongside this attribute in chat messages, stored without colons", "example": "fire", "type": "string" }, "name": { "description": "Unique name of this attribute", "example": "service", "type": "string" }, "required": { "description": "Whether this attribute is required. If this field is not set, the existing setting will be preserved.", "example": false, "type": "boolean" }, "type": { "description": "Engine resource name for this attribute", "example": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]", "type": "string" } }, "required": [ "name", "type", "array" ], "type": "object" }, "AlertAttributesUpdateResultV2": { "example": { "alert_attribute": { "array": false, "emoji": "fire", "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "service", "required": false, "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]" } }, "properties": { "alert_attribute": { "$ref": "#/components/schemas/AlertAttributeV2" } }, "required": [ "alert_attribute" ], "type": "object" }, "AlertEventsCreateHTTPPayloadV2": { "example": { "deduplication_key": "4293868629", "description": "We've detected a number of timeouts on hello.world.com, the service may be down. To fix...", "metadata": { "service": "hello.world.com", "team": [ "my-team" ] }, "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123", "status": "firing", "title": "*errors.withMessage: PG::Error failed to connect" }, "properties": { "deduplication_key": { "description": "A deduplication key which uniquely references this alert from your alert source. For newly created HTTP sources, this field is required.\nIf you send an event with the same deduplication_key multiple times, only one alert will be created in incident.io for this alert source config.\nYou can filter on this field to find the alert created by an event you've sent us.", "example": "4293868629", "type": "string" }, "description": { "description": "Description that optionally adds more detail to title. Supports markdown.", "example": "We've detected a number of timeouts on hello.world.com, the service may be down. To fix...", "type": "string" }, "metadata": { "additionalProperties": true, "description": "Any additional metadata that you've configured your alert source to parse", "example": { "service": "hello.world.com", "team": [ "my-team" ] }, "type": "object" }, "source_url": { "description": "If applicable, a link to the alert in the upstream system", "example": "https://www.my-alerting-platform.com/alerts/my-alert-123", "type": "string" }, "status": { "description": "Current status of this alert", "enum": [ "firing", "resolved" ], "example": "firing", "type": "string" }, "title": { "description": "The title of the alert, parsed from the alert payload according to the alert source configuration", "example": "*errors.withMessage: PG::Error failed to connect", "type": "string" } }, "required": [ "title", "status" ], "type": "object" }, "AlertEventsCreateHTTPResultV2": { "example": { "deduplication_key": "unique-key", "message": "Event accepted for processing", "status": "success" }, "properties": { "deduplication_key": { "description": "The deduplication key that the event has been processed with", "example": "unique-key", "type": "string" }, "message": { "description": "Human readable message giving detail about the event", "example": "Event accepted for processing", "type": "string" }, "status": { "description": "Status of the event", "example": "success", "type": "string" } }, "required": [ "status", "message", "deduplication_key" ], "type": "object" }, "AlertNotesListResultV1": { "example": { "alert_notes": [ { "alert_group_id": "01HB9Z8WANK6P870EA6S7TK1DS", "alert_id": "01FCNDV6P870EA6S7TK1DSYDG0", "content": "Customer reports **checkout 500s** starting ~14:32 UTC. Investigating `payments-api`.\n\n- Error rate: ~12% on `/checkout`\n- Region: `eu-west-1`\n- See [dashboard](https://grafana.example.com/d/abc)\n", "created_at": "2026-05-28T15:30:00Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01J1X9J85C7Y12G8P8W8K55Q5Y", "images": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "url": "https://storage.googleapis.com/incident-io/images/..." } ], "last_edited_at": "2026-05-28T15:35:00Z", "updated_at": "2026-05-28T15:35:00Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "alert_notes": { "example": [ { "alert_group_id": "01HB9Z8WANK6P870EA6S7TK1DS", "alert_id": "01FCNDV6P870EA6S7TK1DSYDG0", "content": "Customer reports **checkout 500s** starting ~14:32 UTC. Investigating `payments-api`.\n\n- Error rate: ~12% on `/checkout`\n- Region: `eu-west-1`\n- See [dashboard](https://grafana.example.com/d/abc)\n", "created_at": "2026-05-28T15:30:00Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01J1X9J85C7Y12G8P8W8K55Q5Y", "images": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "url": "https://storage.googleapis.com/incident-io/images/..." } ], "last_edited_at": "2026-05-28T15:35:00Z", "updated_at": "2026-05-28T15:35:00Z" } ], "items": { "$ref": "#/components/schemas/AlertNoteV1" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV1" } }, "required": [ "alert_notes", "pagination_meta" ], "type": "object" }, "AlertNotesCreatePayloadV1": { "example": { "alert_group_id": "01HB9Z8WANK6P870EA6S7TK1DS", "alert_id": "01FCNDV6P870EA6S7TK1DSYDG0", "content": "Customer reports **checkout 500s** starting ~14:32 UTC. Investigating `payments-api`.\n\n- Error rate: ~12% on `/checkout`\n- Region: `eu-west-1`\n- See [dashboard](https://grafana.example.com/d/abc)\n" }, "properties": { "alert_group_id": { "description": "ID of the alert group to add the note to. Provide exactly one of alert_id or alert_group_id.", "example": "01HB9Z8WANK6P870EA6S7TK1DS", "type": "string" }, "alert_id": { "description": "ID of the alert to add the note to. Provide exactly one of alert_id or alert_group_id.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "content": { "description": "Markdown body of the note", "example": "Customer reports **checkout 500s** starting ~14:32 UTC. Investigating `payments-api`.\n\n- Error rate: ~12% on `/checkout`\n- Region: `eu-west-1`\n- See [dashboard](https://grafana.example.com/d/abc)\n", "type": "string" } }, "required": [ "content" ], "type": "object" }, "AlertNotesCreateResultV1": { "example": { "alert_note": { "alert_group_id": "01HB9Z8WANK6P870EA6S7TK1DS", "alert_id": "01FCNDV6P870EA6S7TK1DSYDG0", "content": "Customer reports **checkout 500s** starting ~14:32 UTC. Investigating `payments-api`.\n\n- Error rate: ~12% on `/checkout`\n- Region: `eu-west-1`\n- See [dashboard](https://grafana.example.com/d/abc)\n", "created_at": "2026-05-28T15:30:00Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01J1X9J85C7Y12G8P8W8K55Q5Y", "images": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "url": "https://storage.googleapis.com/incident-io/images/..." } ], "last_edited_at": "2026-05-28T15:35:00Z", "updated_at": "2026-05-28T15:35:00Z" } }, "properties": { "alert_note": { "$ref": "#/components/schemas/AlertNoteV1" } }, "required": [ "alert_note" ], "type": "object" }, "AlertNotesShowResultV1": { "example": { "alert_note": { "alert_group_id": "01HB9Z8WANK6P870EA6S7TK1DS", "alert_id": "01FCNDV6P870EA6S7TK1DSYDG0", "content": "Customer reports **checkout 500s** starting ~14:32 UTC. Investigating `payments-api`.\n\n- Error rate: ~12% on `/checkout`\n- Region: `eu-west-1`\n- See [dashboard](https://grafana.example.com/d/abc)\n", "created_at": "2026-05-28T15:30:00Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01J1X9J85C7Y12G8P8W8K55Q5Y", "images": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "url": "https://storage.googleapis.com/incident-io/images/..." } ], "last_edited_at": "2026-05-28T15:35:00Z", "updated_at": "2026-05-28T15:35:00Z" } }, "properties": { "alert_note": { "$ref": "#/components/schemas/AlertNoteV1" } }, "required": [ "alert_note" ], "type": "object" }, "AlertNotesUpdatePayloadV1": { "example": { "content": "Customer reports **checkout 500s** starting ~14:32 UTC. Investigating `payments-api`.\n\n- Error rate: ~12% on `/checkout`\n- Region: `eu-west-1`\n- See [dashboard](https://grafana.example.com/d/abc)\n" }, "properties": { "content": { "description": "Markdown body of the note", "example": "Customer reports **checkout 500s** starting ~14:32 UTC. Investigating `payments-api`.\n\n- Error rate: ~12% on `/checkout`\n- Region: `eu-west-1`\n- See [dashboard](https://grafana.example.com/d/abc)\n", "type": "string" } }, "required": [ "content" ], "type": "object" }, "AlertNotesUpdateResultV1": { "example": { "alert_note": { "alert_group_id": "01HB9Z8WANK6P870EA6S7TK1DS", "alert_id": "01FCNDV6P870EA6S7TK1DSYDG0", "content": "Customer reports **checkout 500s** starting ~14:32 UTC. Investigating `payments-api`.\n\n- Error rate: ~12% on `/checkout`\n- Region: `eu-west-1`\n- See [dashboard](https://grafana.example.com/d/abc)\n", "created_at": "2026-05-28T15:30:00Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01J1X9J85C7Y12G8P8W8K55Q5Y", "images": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "url": "https://storage.googleapis.com/incident-io/images/..." } ], "last_edited_at": "2026-05-28T15:35:00Z", "updated_at": "2026-05-28T15:35:00Z" } }, "properties": { "alert_note": { "$ref": "#/components/schemas/AlertNoteV1" } }, "required": [ "alert_note" ], "type": "object" }, "AlertRoutesListResultV3": { "example": { "alert_routes": [ { "enabled": false, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Production incidents" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "alert_routes": { "example": [ { "enabled": false, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Production incidents" } ], "items": { "$ref": "#/components/schemas/AlertRouteSlimV3" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV3" } }, "required": [ "alert_routes", "pagination_meta" ], "type": "object" }, "AlertRoutesCreatePayloadV3": { "example": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] } ], "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "when_alert_joins_group": { "grace_period_seconds": 60, "mode": "on_each_new_alert" } }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "grouping_config": { "default": { "enabled": true, "grouping_keys": [ { "reference": "alert.title" } ], "window_seconds": 1800, "window_type": "rolling" } }, "incident_config": { "auto_decline_enabled": false, "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "enabled": false, "incident_template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "membership_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } } }, "is_private": false, "message_config": { "destinations": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "public", "group_alerts_summary": false }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "public", "group_alerts_summary": false } } ], "template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ] }, "properties": { "alert_sources": { "description": "Which alert sources this route matches", "example": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] } ], "items": { "$ref": "#/components/schemas/AlertRouteAlertSourcePayloadV3" }, "type": "array" }, "condition_groups": { "description": "Filter: the condition groups that must be true for this route to fire", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV3" }, "type": "array" }, "enabled": { "description": "Whether this alert route is enabled", "example": false, "type": "boolean" }, "escalation_config": { "$ref": "#/components/schemas/AlertRouteEscalationConfigPayloadV3" }, "expressions": { "description": "The expressions used by bindings in this route", "example": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionPayloadV3" }, "type": "array" }, "grouping_config": { "$ref": "#/components/schemas/AlertGroupingConfigV3" }, "incident_config": { "$ref": "#/components/schemas/AlertRouteIncidentConfigPayloadV3" }, "is_private": { "description": "Whether this alert route is private. Private alert routes only create private incidents from alerts.", "example": false, "type": "boolean" }, "message_config": { "$ref": "#/components/schemas/AlertMessageConfigPayloadV3" }, "name": { "description": "The name of this alert route, for the user's reference", "example": "Production incidents", "type": "string" }, "owning_team_ids": { "description": "IDs of teams that own this alert route", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" } }, "required": [ "name", "is_private", "enabled", "alert_sources", "condition_groups", "grouping_config", "escalation_config", "incident_config", "message_config", "expressions" ], "type": "object" }, "AlertRoutesCreateResultV3": { "example": { "alert_route": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] } ], "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "when_alert_joins_group": { "grace_period_seconds": 60, "mode": "on_each_new_alert" } }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "grouping_config": { "default": { "enabled": true, "grouping_keys": [ { "reference": "alert.title" } ], "window_seconds": 1800, "window_type": "rolling" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_config": { "auto_decline_enabled": false, "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "enabled": false, "incident_template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "membership_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } } }, "is_private": false, "message_config": { "destinations": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123", "group_alerts_summary": false }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123", "group_alerts_summary": false } } ], "template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "properties": { "alert_route": { "$ref": "#/components/schemas/AlertRouteV3" } }, "required": [ "alert_route" ], "type": "object" }, "AlertRoutesShowResultV3": { "example": { "alert_route": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] } ], "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "when_alert_joins_group": { "grace_period_seconds": 60, "mode": "on_each_new_alert" } }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "grouping_config": { "default": { "enabled": true, "grouping_keys": [ { "reference": "alert.title" } ], "window_seconds": 1800, "window_type": "rolling" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_config": { "auto_decline_enabled": false, "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "enabled": false, "incident_template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "membership_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } } }, "is_private": false, "message_config": { "destinations": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123", "group_alerts_summary": false }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123", "group_alerts_summary": false } } ], "template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "properties": { "alert_route": { "$ref": "#/components/schemas/AlertRouteV3" } }, "required": [ "alert_route" ], "type": "object" }, "AlertRoutesUpdatePayloadV3": { "example": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] } ], "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "when_alert_joins_group": { "grace_period_seconds": 60, "mode": "on_each_new_alert" } }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "grouping_config": { "default": { "enabled": true, "grouping_keys": [ { "reference": "alert.title" } ], "window_seconds": 1800, "window_type": "rolling" } }, "incident_config": { "auto_decline_enabled": false, "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "enabled": false, "incident_template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "membership_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } } }, "is_private": false, "message_config": { "destinations": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "public", "group_alerts_summary": false }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "public", "group_alerts_summary": false } } ], "template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "version": 1 }, "properties": { "alert_sources": { "description": "Which alert sources this route matches", "example": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] } ], "items": { "$ref": "#/components/schemas/AlertRouteAlertSourcePayloadV3" }, "type": "array" }, "condition_groups": { "description": "Filter: the condition groups that must be true for this route to fire", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV3" }, "type": "array" }, "enabled": { "description": "Whether this alert route is enabled", "example": false, "type": "boolean" }, "escalation_config": { "$ref": "#/components/schemas/AlertRouteEscalationConfigPayloadV3" }, "expressions": { "description": "The expressions used by bindings in this route", "example": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionPayloadV3" }, "type": "array" }, "grouping_config": { "$ref": "#/components/schemas/AlertGroupingConfigV3" }, "incident_config": { "$ref": "#/components/schemas/AlertRouteIncidentConfigPayloadV3" }, "is_private": { "description": "Whether this alert route is private. Private alert routes only create private incidents from alerts.", "example": false, "type": "boolean" }, "message_config": { "$ref": "#/components/schemas/AlertMessageConfigPayloadV3" }, "name": { "description": "The name of this alert route, for the user's reference", "example": "Production incidents", "type": "string" }, "owning_team_ids": { "description": "IDs of teams that own this alert route", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "version": { "description": "The version this update will create. It must be one more than the route's latest version, otherwise the update is rejected - guarding against concurrent edits.", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "version", "name", "is_private", "enabled", "alert_sources", "condition_groups", "grouping_config", "escalation_config", "incident_config", "message_config", "expressions" ], "type": "object" }, "AlertRoutesUpdateResultV3": { "example": { "alert_route": { "alert_sources": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] } ], "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "enabled": false, "escalation_config": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "when_alert_joins_group": { "grace_period_seconds": 60, "mode": "on_each_new_alert" } }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "grouping_config": { "default": { "enabled": true, "grouping_keys": [ { "reference": "alert.title" } ], "window_seconds": 1800, "window_type": "rolling" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_config": { "auto_decline_enabled": false, "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "enabled": false, "incident_template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "membership_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } } }, "is_private": false, "message_config": { "destinations": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123", "group_alerts_summary": false }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123", "group_alerts_summary": false } } ], "template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": "Production incidents", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "properties": { "alert_route": { "$ref": "#/components/schemas/AlertRouteV3" } }, "required": [ "alert_route" ], "type": "object" }, "AlertSourcesListResultV2": { "example": { "alert_sources": [ { "alert_events_url": "https://api.incident.io/v2/alert_events/http/01GW2G3V0S59R238FAHPDS1R66", "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "azure_devops_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "ba038695-f5f7-4490-a9ea-bf4ab3cbf483" ] }, "email_options": { "email_address": "lawrence@example.com", "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "filter_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "fixed_team_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60, "ping_url": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping" }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "id": "01GW2G3V0S59R238FAHPDS1R66", "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rate_limit_sharding": { "rate_limit_shard_key_path": "$.priority" }, "secret_token": "some-secret-token", "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "is_private": false, "title": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } } ] }, "properties": { "alert_sources": { "example": [ { "alert_events_url": "https://api.incident.io/v2/alert_events/http/01GW2G3V0S59R238FAHPDS1R66", "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "azure_devops_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "ba038695-f5f7-4490-a9ea-bf4ab3cbf483" ] }, "email_options": { "email_address": "lawrence@example.com", "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "filter_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "fixed_team_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60, "ping_url": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping" }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "id": "01GW2G3V0S59R238FAHPDS1R66", "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rate_limit_sharding": { "rate_limit_shard_key_path": "$.priority" }, "secret_token": "some-secret-token", "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "is_private": false, "title": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } } ], "items": { "$ref": "#/components/schemas/AlertSourceV2" }, "type": "array" } }, "required": [ "alert_sources" ], "type": "object" }, "AlertSourcesCreatePayloadV2": { "example": { "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "azure_devops_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "ba038695-f5f7-4490-a9ea-bf4ab3cbf483" ] }, "email_options": { "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "filter_condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "fixed_team_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60 }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rate_limit_sharding": { "rate_limit_shard_key_path": "$.priority" }, "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "is_private": false, "title": { "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "properties": { "auto_resolve_incident_alerts": { "description": "Whether alerts from this source keep counting down to auto-resolve while attached to an incident. Defaults to true. Has no effect without auto_resolve_timeout_minutes.", "example": false, "type": "boolean" }, "auto_resolve_timeout_minutes": { "description": "When set, alerts from this source will automatically resolve after this many minutes.", "example": 1, "format": "int64", "type": "integer" }, "azure_devops_options": { "$ref": "#/components/schemas/AlertSourceAzureDevopsOptionsV2" }, "email_options": { "$ref": "#/components/schemas/AlertSourceEmailOptionsPayloadV2" }, "filter_condition_groups": { "description": "Conditions an incoming event must match to be ingested from this source, evaluated against the event's payload and this source's expressions. When empty or omitted, everything is ingested; otherwise a firing event that doesn't match is dropped and never creates or updates an alert. Resolve events are never filtered.", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" }, "fixed_team_id": { "description": "Fix the team every alert from this source is attributed to. While set, the team attribute is managed from this field: don't send its binding in the template.", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "heartbeat_options": { "$ref": "#/components/schemas/AlertSourceHeartbeatOptionsPayloadV2" }, "http_custom_options": { "$ref": "#/components/schemas/AlertSourceHTTPCustomOptionsV2" }, "jira_options": { "$ref": "#/components/schemas/AlertSourceJiraOptionsV2" }, "name": { "description": "Unique name of the alert source", "example": "Production Web Dashboard Alerts", "type": "string" }, "owning_team_ids": { "description": "IDs of teams that own this alert source", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "rate_limit_sharding": { "$ref": "#/components/schemas/AlertSourceRateLimitShardingV2" }, "source_type": { "description": "Type of alert source", "enum": [ "alertmanager", "app_optics", "azure_monitor", "azure_devops", "big_panda", "bugsnag", "checkly", "chronosphere", "cloudwatch", "cloudflare", "coralogix", "cronitor", "crowdstrike_falcon", "dash0", "datadog", "dynatrace", "elasticsearch", "email", "expel", "github_issue", "google_cloud", "grafana", "heartbeat", "http", "http_custom", "honeycomb", "icinga2", "incoming_calls", "jira", "jsm", "monte_carlo", "nagios", "new_relic", "opsgenie", "prtg", "pager_duty", "panther", "pingdom", "runscope", "sns", "salesforce_case", "sentry", "sentry_metric", "service_now", "splunk", "status_cake", "status_page_views", "sumo_logic", "uptime", "vercel", "wiz", "zendesk" ], "example": "alertmanager", "type": "string" }, "template": { "$ref": "#/components/schemas/AlertTemplatePayloadV2" } }, "required": [ "name", "source_type", "template" ], "type": "object" }, "AlertSourcesCreateResultV2": { "example": { "alert_source": { "alert_events_url": "https://api.incident.io/v2/alert_events/http/01GW2G3V0S59R238FAHPDS1R66", "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "azure_devops_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "ba038695-f5f7-4490-a9ea-bf4ab3cbf483" ] }, "email_options": { "email_address": "lawrence@example.com", "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "filter_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "fixed_team_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60, "ping_url": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping" }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "id": "01GW2G3V0S59R238FAHPDS1R66", "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rate_limit_sharding": { "rate_limit_shard_key_path": "$.priority" }, "secret_token": "some-secret-token", "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "is_private": false, "title": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } } }, "properties": { "alert_source": { "$ref": "#/components/schemas/AlertSourceV2" } }, "required": [ "alert_source" ], "type": "object" }, "AlertSourcesShowResultV2": { "example": { "alert_source": { "alert_events_url": "https://api.incident.io/v2/alert_events/http/01GW2G3V0S59R238FAHPDS1R66", "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "azure_devops_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "ba038695-f5f7-4490-a9ea-bf4ab3cbf483" ] }, "email_options": { "email_address": "lawrence@example.com", "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "filter_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "fixed_team_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60, "ping_url": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping" }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "id": "01GW2G3V0S59R238FAHPDS1R66", "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rate_limit_sharding": { "rate_limit_shard_key_path": "$.priority" }, "secret_token": "some-secret-token", "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "is_private": false, "title": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } } }, "properties": { "alert_source": { "$ref": "#/components/schemas/AlertSourceV2" } }, "required": [ "alert_source" ], "type": "object" }, "AlertSourcesUpdatePayloadV2": { "example": { "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "azure_devops_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "ba038695-f5f7-4490-a9ea-bf4ab3cbf483" ] }, "disabled": false, "email_options": { "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "filter_condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "fixed_team_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60 }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rate_limit_sharding": { "rate_limit_shard_key_path": "$.priority" }, "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "is_private": false, "title": { "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "properties": { "auto_resolve_incident_alerts": { "description": "Whether alerts from this source keep counting down to auto-resolve while attached to an incident. Defaults to true. Has no effect without auto_resolve_timeout_minutes.", "example": false, "type": "boolean" }, "auto_resolve_timeout_minutes": { "description": "When set, alerts from this source will automatically resolve after this many minutes.", "example": 1, "format": "int64", "type": "integer" }, "azure_devops_options": { "$ref": "#/components/schemas/AlertSourceAzureDevopsOptionsV2" }, "disabled": { "description": "For heartbeat sources, set to true to disable monitoring", "example": false, "type": "boolean" }, "email_options": { "$ref": "#/components/schemas/AlertSourceEmailOptionsPayloadV2" }, "filter_condition_groups": { "description": "Conditions an incoming event must match to be ingested from this source, evaluated against the event's payload and this source's expressions. When empty, everything is ingested; otherwise a firing event that doesn't match is dropped and never creates or updates an alert. Resolve events are never filtered. Omit to leave unchanged.", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" }, "fixed_team_id": { "description": "Fix the team every alert from this source is attributed to. While set, the team attribute is managed from this field: a team binding sent in the template is ignored. Omit to leave unchanged; set to an empty string to clear it, making the team attribute editable again.", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "heartbeat_options": { "$ref": "#/components/schemas/AlertSourceHeartbeatOptionsPayloadV2" }, "http_custom_options": { "$ref": "#/components/schemas/AlertSourceHTTPCustomOptionsV2" }, "jira_options": { "$ref": "#/components/schemas/AlertSourceJiraOptionsV2" }, "name": { "description": "Unique name of the alert source", "example": "Production Web Dashboard Alerts", "type": "string" }, "owning_team_ids": { "description": "IDs of teams that own this alert source", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "rate_limit_sharding": { "$ref": "#/components/schemas/AlertSourceRateLimitShardingV2" }, "template": { "$ref": "#/components/schemas/AlertTemplatePayloadV2" } }, "required": [ "name", "template" ], "type": "object" }, "AlertSourcesUpdateResultV2": { "example": { "alert_source": { "alert_events_url": "https://api.incident.io/v2/alert_events/http/01GW2G3V0S59R238FAHPDS1R66", "auto_resolve_incident_alerts": false, "auto_resolve_timeout_minutes": 1, "azure_devops_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "ba038695-f5f7-4490-a9ea-bf4ab3cbf483" ] }, "email_options": { "email_address": "lawrence@example.com", "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "filter_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "fixed_team_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "heartbeat_options": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60, "ping_url": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping" }, "http_custom_options": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "id": "01GW2G3V0S59R238FAHPDS1R66", "jira_options": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "name": "Production Web Dashboard Alerts", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rate_limit_sharding": { "rate_limit_shard_key_path": "$.priority" }, "secret_token": "some-secret-token", "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "is_private": false, "title": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } } }, "properties": { "alert_source": { "$ref": "#/components/schemas/AlertSourceV2" } }, "required": [ "alert_source" ], "type": "object" }, "AlertSourcesValidatePayloadV2": { "example": { "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "source_type": "alertmanager", "template": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "is_private": false, "title": { "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "properties": { "owning_team_ids": { "description": "IDs of teams that own this alert source", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "source_type": { "description": "Type of alert source", "enum": [ "alertmanager", "app_optics", "azure_monitor", "azure_devops", "big_panda", "bugsnag", "checkly", "chronosphere", "cloudwatch", "cloudflare", "coralogix", "cronitor", "crowdstrike_falcon", "dash0", "datadog", "dynatrace", "elasticsearch", "email", "expel", "github_issue", "google_cloud", "grafana", "heartbeat", "http", "http_custom", "honeycomb", "icinga2", "incoming_calls", "jira", "jsm", "monte_carlo", "nagios", "new_relic", "opsgenie", "prtg", "pager_duty", "panther", "pingdom", "runscope", "sns", "salesforce_case", "sentry", "sentry_metric", "service_now", "splunk", "status_cake", "status_page_views", "sumo_logic", "uptime", "vercel", "wiz", "zendesk" ], "example": "alertmanager", "type": "string" }, "template": { "$ref": "#/components/schemas/AlertTemplatePayloadV2" } }, "required": [ "source_type", "template" ], "type": "object" }, "AlertsListAlertTagsResultV2": { "example": { "alert_tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "alert_tags": { "example": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "items": { "$ref": "#/components/schemas/AlertTagV2" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" } }, "required": [ "alert_tags", "pagination_meta" ], "type": "object" }, "AlertsListResultV2": { "example": { "alerts": [ { "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", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "alerts": { "example": [ { "alert_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", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/AlertV2" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" } }, "required": [ "alerts", "pagination_meta" ], "type": "object" }, "AlertsShowResultV2": { "example": { "alert": { "alert_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", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "alert": { "$ref": "#/components/schemas/AlertV2" } }, "required": [ "alert" ], "type": "object" }, "AlertsAddTagsPayloadV2": { "example": { "tags": [ "known issue", "customer impacting" ] }, "properties": { "tags": { "description": "Tag names to add to this alert", "example": [ "known issue", "customer impacting" ], "items": { "example": "abc123", "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "tags" ], "type": "object" }, "AlertsAddTagsResultV2": { "example": { "alert": { "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", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "alert": { "$ref": "#/components/schemas/AlertV2" } }, "required": [ "alert" ], "type": "object" }, "AlertsRemoveTagsPayloadV2": { "example": { "tags": [ "known issue", "customer impacting" ] }, "properties": { "tags": { "description": "Tag names to remove from this alert", "example": [ "known issue", "customer impacting" ], "items": { "example": "abc123", "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "tags" ], "type": "object" }, "AlertsRemoveTagsResultV2": { "example": { "alert": { "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", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "alert": { "$ref": "#/components/schemas/AlertV2" } }, "required": [ "alert" ], "type": "object" }, "AlertsResolveResultV2": { "example": { "alert": { "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", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "alert": { "$ref": "#/components/schemas/AlertV2" } }, "required": [ "alert" ], "type": "object" }, "AlertsSetTagsPayloadV2": { "example": { "tags": [ "known issue", "customer impacting" ] }, "properties": { "tags": { "description": "The complete set of tag names for this alert", "example": [ "known issue", "customer impacting" ], "items": { "example": "abc123", "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "tags" ], "type": "object" }, "AlertsSetTagsResultV2": { "example": { "alert": { "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", "tags": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "title": "*errors.withMessage: PG::Error failed to connect", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "alert": { "$ref": "#/components/schemas/AlertV2" } }, "required": [ "alert" ], "type": "object" }, "AlertsListIncidentAlertsResultV2": { "example": { "incident_alerts": [ { "alert": { "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" }, "alert_route_id": "01GW2G3V0S59R238FAHPDS1R67", "id": "01GW2G3V0S59R238FAHPDS1R66", "incident": { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "incident_alerts": { "example": [ { "alert": { "alert_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" }, "alert_route_id": "01GW2G3V0S59R238FAHPDS1R67", "id": "01GW2G3V0S59R238FAHPDS1R66", "incident": { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } } ], "items": { "$ref": "#/components/schemas/IncidentAlertV2" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" } }, "required": [ "incident_alerts", "pagination_meta" ], "type": "object" }, "AlertsCreateIncidentAlertPayloadV2": { "example": { "alert_id": "01FCNDV6P870EA6S7TK1DSYDG1", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "re_relate": false }, "properties": { "alert_id": { "description": "Alert to attach to the incident", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" }, "incident_id": { "description": "Incident to attach the alert to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "re_relate": { "default": false, "description": "Relate the alert again even though someone previously marked it unrelated to this incident. Defaults to false, which preserves that decision and returns a 422", "example": false, "type": "boolean" } }, "required": [ "alert_id", "incident_id" ], "type": "object" }, "AlertsCreateIncidentAlertResultV2": { "example": { "incident_alert": { "alert": { "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" }, "alert_route_id": "01GW2G3V0S59R238FAHPDS1R67", "id": "01GW2G3V0S59R238FAHPDS1R66", "incident": { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } } }, "properties": { "incident_alert": { "$ref": "#/components/schemas/IncidentAlertV2" } }, "required": [ "incident_alert" ], "type": "object" }, "AlertsTransitionIncidentAlertPayloadV2": { "example": { "state": "related" }, "properties": { "state": { "description": "What state to move the connection to", "enum": [ "related", "unrelated" ], "example": "related", "type": "string" } }, "required": [ "state" ], "type": "object" }, "AlertsTransitionIncidentAlertResultV2": { "example": { "incident_alert": { "alert": { "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" }, "alert_route_id": "01GW2G3V0S59R238FAHPDS1R67", "id": "01GW2G3V0S59R238FAHPDS1R66", "incident": { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } } }, "properties": { "incident_alert": { "$ref": "#/components/schemas/IncidentAlertV2" } }, "required": [ "incident_alert" ], "type": "object" }, "APIKeysListResultV1": { "example": { "api_keys": [ { "comments": "Requested in https://example.slack.com/archives/C123/p456", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_used_at": "2021-08-17T13:28:57.801578Z", "name": "My test API key", "roles": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "team_ids": [ "abc123" ], "team_roles": [ { "description": "can view data, like public incidents and organization settings", "name": "catalog_editor" } ], "token_last_issued_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "api_keys": { "example": [ { "comments": "Requested in https://example.slack.com/archives/C123/p456", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_used_at": "2021-08-17T13:28:57.801578Z", "name": "My test API key", "roles": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "team_ids": [ "abc123" ], "team_roles": [ { "description": "can view data, like public incidents and organization settings", "name": "catalog_editor" } ], "token_last_issued_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/APIKeyV1" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV1" } }, "required": [ "api_keys", "pagination_meta" ], "type": "object" }, "APIKeysCreatePayloadV1": { "example": { "comments": "Requested in https://example.slack.com/archives/C123/p456", "name": "My test API key", "role_names": [ "viewer", "incident_creator" ], "team_ids": [ "01FCNDV6P870EA6S7TK1DSYDG0" ], "team_role_names": [ "schedules_editor" ] }, "properties": { "comments": { "description": "Freeform notes about the API key", "example": "Requested in https://example.slack.com/archives/C123/p456", "maxLength": 5000, "pattern": "^[^\u0000]*$", "type": "string" }, "name": { "description": "Human-readable name for the new API key", "example": "My test API key", "maxLength": 200, "minLength": 1, "type": "string" }, "role_names": { "description": "Account-level roles to assign to the API key. These roles apply across the entire account, not scoped to specific teams. Pass an empty array if no account-level roles are needed.", "example": [ "viewer", "incident_creator" ], "items": { "enum": [ "viewer", "incident_creator", "incident_editor", "manage_settings", "global_access", "catalog_viewer", "catalog_editor", "incident_memberships_editor", "schedules_editor", "schedules_reader", "schedule_overrides_editor", "workflows_editor", "workflows_viewer", "private_workflows_editor", "private_escalation_workflows_editor", "on_call_editor", "on_call_viewer", "escalation_creator", "post_incident_flow_opt_out", "security_settings_editor", "investigation_download", "team_memberships_manage", "status_page_publisher", "postmortems_manage", "api_keys_manage", "notification_methods_manage", "notification_methods_unredacted_viewer", "incident_workload_viewer", "incident_workload_private_viewer", "act_on_behalf_of_users", "secrets_manage", "secrets_use", "call_transcripts_viewer", "heartbeats_ping", "telemetry_query_restricted", "telemetry_data_source_update", "policies_viewer", "policy_findings_manage", "pay_reports_viewer", "pay_reports_editor", "pay_configs_viewer", "pay_configs_editor" ], "example": "viewer", "type": "string" }, "type": "array" }, "team_ids": { "description": "IDs of teams to scope the `team_role_names` to. If provided, `team_role_names` must also be a non-empty array, and vice versa. Pass an empty array if the key should not be scoped to any teams.", "example": [ "01FCNDV6P870EA6S7TK1DSYDG0" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "team_role_names": { "description": "Roles to grant for the teams specified in `team_ids`. If provided, `team_ids` must also be a non-empty array, and vice versa. Pass an empty array if no team-level roles are needed.", "example": [ "schedules_editor" ], "items": { "enum": [ "catalog_editor", "schedules_editor", "schedules_reader", "schedule_overrides_editor", "on_call_editor", "escalation_creator", "api_keys_manage", "workflows_editor", "private_workflows_editor", "secrets_manage", "secrets_use", "heartbeats_ping", "telemetry_query_restricted", "telemetry_data_source_update" ], "example": "catalog_editor", "type": "string" }, "type": "array" } }, "required": [ "name", "role_names", "team_ids", "team_role_names" ], "type": "object" }, "APIKeysCreateResultV1": { "example": { "api_key": { "comments": "Requested in https://example.slack.com/archives/C123/p456", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_used_at": "2021-08-17T13:28:57.801578Z", "name": "My test API key", "roles": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "team_ids": [ "abc123" ], "team_roles": [ { "description": "can view data, like public incidents and organization settings", "name": "catalog_editor" } ], "token_last_issued_at": "2021-08-17T13:28:57.801578Z" }, "token": "inc_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef" }, "properties": { "api_key": { "$ref": "#/components/schemas/APIKeyV1" }, "token": { "description": "The bearer token to use in API requests. This is the only time the token is returned — store it securely.", "example": "inc_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef", "type": "string" } }, "required": [ "api_key", "token" ], "type": "object" }, "APIKeysShowResultV1": { "example": { "api_key": { "comments": "Requested in https://example.slack.com/archives/C123/p456", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_used_at": "2021-08-17T13:28:57.801578Z", "name": "My test API key", "roles": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "team_ids": [ "abc123" ], "team_roles": [ { "description": "can view data, like public incidents and organization settings", "name": "catalog_editor" } ], "token_last_issued_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "api_key": { "$ref": "#/components/schemas/APIKeyV1" } }, "required": [ "api_key" ], "type": "object" }, "APIKeysUpdatePayloadV1": { "example": { "comments": "Requested in https://example.slack.com/archives/C123/p456", "name": "My test API key", "role_names": [ "viewer", "incident_creator" ], "team_ids": [ "01FCNDV6P870EA6S7TK1DSYDG0" ], "team_role_names": [ "schedules_editor" ] }, "properties": { "comments": { "description": "Freeform notes about the API key", "example": "Requested in https://example.slack.com/archives/C123/p456", "maxLength": 5000, "pattern": "^[^\u0000]*$", "type": "string" }, "name": { "description": "Human-readable name for the API key", "example": "My test API key", "maxLength": 200, "minLength": 1, "type": "string" }, "role_names": { "description": "Account-level roles for the API key. These roles apply across the entire account, not scoped to specific teams. Pass an empty array if no account-level roles are needed.", "example": [ "viewer", "incident_creator" ], "items": { "enum": [ "viewer", "incident_creator", "incident_editor", "manage_settings", "global_access", "catalog_viewer", "catalog_editor", "incident_memberships_editor", "schedules_editor", "schedules_reader", "schedule_overrides_editor", "workflows_editor", "workflows_viewer", "private_workflows_editor", "private_escalation_workflows_editor", "on_call_editor", "on_call_viewer", "escalation_creator", "post_incident_flow_opt_out", "security_settings_editor", "investigation_download", "team_memberships_manage", "status_page_publisher", "postmortems_manage", "api_keys_manage", "notification_methods_manage", "notification_methods_unredacted_viewer", "incident_workload_viewer", "incident_workload_private_viewer", "act_on_behalf_of_users", "secrets_manage", "secrets_use", "call_transcripts_viewer", "heartbeats_ping", "telemetry_query_restricted", "telemetry_data_source_update", "policies_viewer", "policy_findings_manage", "pay_reports_viewer", "pay_reports_editor", "pay_configs_viewer", "pay_configs_editor" ], "example": "viewer", "type": "string" }, "type": "array" }, "team_ids": { "description": "IDs of teams to scope the `team_role_names` to. If provided, `team_role_names` must also be a non-empty array, and vice versa. Pass an empty array if the key should not be scoped to any teams.", "example": [ "01FCNDV6P870EA6S7TK1DSYDG0" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "team_role_names": { "description": "Roles to grant for the teams specified in `team_ids`. If provided, `team_ids` must also be a non-empty array, and vice versa. Pass an empty array if no team-level roles are needed.", "example": [ "schedules_editor" ], "items": { "enum": [ "catalog_editor", "schedules_editor", "schedules_reader", "schedule_overrides_editor", "on_call_editor", "escalation_creator", "api_keys_manage", "workflows_editor", "private_workflows_editor", "secrets_manage", "secrets_use", "heartbeats_ping", "telemetry_query_restricted", "telemetry_data_source_update" ], "example": "catalog_editor", "type": "string" }, "type": "array" } }, "required": [ "name", "role_names", "team_ids", "team_role_names" ], "type": "object" }, "APIKeysUpdateResultV1": { "example": { "api_key": { "comments": "Requested in https://example.slack.com/archives/C123/p456", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_used_at": "2021-08-17T13:28:57.801578Z", "name": "My test API key", "roles": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "team_ids": [ "abc123" ], "team_roles": [ { "description": "can view data, like public incidents and organization settings", "name": "catalog_editor" } ], "token_last_issued_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "api_key": { "$ref": "#/components/schemas/APIKeyV1" } }, "required": [ "api_key" ], "type": "object" }, "APIKeysRotatePayloadV1": { "example": { "grace_period_minutes": 30 }, "properties": { "grace_period_minutes": { "default": 30, "description": "How many minutes to keep the old access token alive.", "example": 30, "format": "int64", "maximum": 60, "minimum": 0, "type": "integer" } }, "required": [ "grace_period_minutes" ], "type": "object" }, "APIKeysRotateResultV1": { "example": { "api_key": { "comments": "Requested in https://example.slack.com/archives/C123/p456", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_used_at": "2021-08-17T13:28:57.801578Z", "name": "My test API key", "roles": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "team_ids": [ "abc123" ], "team_roles": [ { "description": "can view data, like public incidents and organization settings", "name": "catalog_editor" } ], "token_last_issued_at": "2021-08-17T13:28:57.801578Z" }, "token": "inc_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef" }, "properties": { "api_key": { "$ref": "#/components/schemas/APIKeyV1" }, "token": { "description": "The new bearer token to use in API requests. This is the only time the token is returned — store it securely.", "example": "inc_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef", "type": "string" } }, "required": [ "api_key", "token" ], "type": "object" }, "CallRoutesListResultV2": { "example": { "call_routes": [ { "allowed_callers": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator duty desk", "phone_number": "+15551234567" } ], "country_code": "US", "created_at": "2021-08-17T13:28:57.801578Z", "current_state": "active", "custom_language": "en-US", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator urgent request", "options": [ { "digit": "1", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "prompt": "For an urgent production outage, press 1" } ], "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "phone_number": "+15551234567", "phone_number_type": "toll_free", "responder_caller_id": "route_number", "updated_at": "2021-08-17T13:28:57.801578Z", "use_caller_allowlist": true } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "call_routes": { "example": [ { "allowed_callers": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator duty desk", "phone_number": "+15551234567" } ], "country_code": "US", "created_at": "2021-08-17T13:28:57.801578Z", "current_state": "active", "custom_language": "en-US", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator urgent request", "options": [ { "digit": "1", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "prompt": "For an urgent production outage, press 1" } ], "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "phone_number": "+15551234567", "phone_number_type": "toll_free", "responder_caller_id": "route_number", "updated_at": "2021-08-17T13:28:57.801578Z", "use_caller_allowlist": true } ], "items": { "$ref": "#/components/schemas/CallRouteV2" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" } }, "required": [ "call_routes" ], "type": "object" }, "CallRoutesListAllowedCallersResultV2": { "example": { "allowed_callers": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator duty desk", "phone_number": "+15551234567" } ] }, "properties": { "allowed_callers": { "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator duty desk", "phone_number": "+15551234567" } ], "items": { "$ref": "#/components/schemas/CallRouteAllowedCallerV2" }, "type": "array" } }, "required": [ "allowed_callers" ], "type": "object" }, "CallRoutesCreateAllowedCallerPayloadV2": { "example": { "name": "Regulator duty desk", "phone_number": "+15551234567" }, "properties": { "name": { "description": "Label for whose number this is", "example": "Regulator duty desk", "type": "string" }, "phone_number": { "description": "The number to allow, in international format", "example": "+15551234567", "type": "string" } }, "required": [ "phone_number" ], "type": "object" }, "CallRoutesCreateAllowedCallerResultV2": { "example": { "allowed_caller": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator duty desk", "phone_number": "+15551234567" } }, "properties": { "allowed_caller": { "$ref": "#/components/schemas/CallRouteAllowedCallerV2" } }, "required": [ "allowed_caller" ], "type": "object" }, "CallRoutesShowAllowedCallerResultV2": { "example": { "allowed_caller": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator duty desk", "phone_number": "+15551234567" } }, "properties": { "allowed_caller": { "$ref": "#/components/schemas/CallRouteAllowedCallerV2" } }, "required": [ "allowed_caller" ], "type": "object" }, "CallRoutesUpdateAllowedCallerPayloadV2": { "example": { "name": "Regulator duty desk", "phone_number": "+15551234567" }, "properties": { "name": { "description": "Label for whose number this is", "example": "Regulator duty desk", "type": "string" }, "phone_number": { "description": "The number to allow, in international format", "example": "+15551234567", "type": "string" } }, "required": [ "phone_number" ], "type": "object" }, "CallRoutesUpdateAllowedCallerResultV2": { "example": { "allowed_caller": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator duty desk", "phone_number": "+15551234567" } }, "properties": { "allowed_caller": { "$ref": "#/components/schemas/CallRouteAllowedCallerV2" } }, "required": [ "allowed_caller" ], "type": "object" }, "CallRoutesListOptionsResultV2": { "example": { "options": [ { "digit": "1", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "prompt": "For an urgent production outage, press 1" } ] }, "properties": { "options": { "example": [ { "digit": "1", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "prompt": "For an urgent production outage, press 1" } ], "items": { "$ref": "#/components/schemas/CallRouteOptionV2" }, "type": "array" } }, "required": [ "options" ], "type": "object" }, "CallRoutesCreateOptionPayloadV2": { "example": { "digit": "1", "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "prompt": "For an urgent production outage, press 1" }, "properties": { "digit": { "description": "The keypad digit a caller presses to choose this option", "enum": [ "1", "2", "3", "4", "5", "6", "7", "8", "9" ], "example": "1", "type": "string" }, "path": { "description": "Who to page when a caller chooses this option", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "items": { "$ref": "#/components/schemas/CallRoutePathNodePayloadV2" }, "type": "array" }, "prompt": { "description": "What we read out to offer this option, via text-to-speech in the route's language, exactly as written", "example": "For an urgent production outage, press 1", "maxLength": 250, "type": "string" } }, "required": [ "digit", "prompt", "path" ], "type": "object" }, "CallRoutesCreateOptionResultV2": { "example": { "option": { "digit": "1", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "prompt": "For an urgent production outage, press 1" } }, "properties": { "option": { "$ref": "#/components/schemas/CallRouteOptionV2" } }, "required": [ "option" ], "type": "object" }, "CallRoutesShowOptionResultV2": { "example": { "option": { "digit": "1", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "prompt": "For an urgent production outage, press 1" } }, "properties": { "option": { "$ref": "#/components/schemas/CallRouteOptionV2" } }, "required": [ "option" ], "type": "object" }, "CallRoutesUpdateOptionPayloadV2": { "example": { "digit": "1", "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "prompt": "For an urgent production outage, press 1" }, "properties": { "digit": { "description": "The keypad digit a caller presses to choose this option", "enum": [ "1", "2", "3", "4", "5", "6", "7", "8", "9" ], "example": "1", "type": "string" }, "path": { "description": "Who to page when a caller chooses this option", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "items": { "$ref": "#/components/schemas/CallRoutePathNodePayloadV2" }, "type": "array" }, "prompt": { "description": "What we read out to offer this option, via text-to-speech in the route's language, exactly as written", "example": "For an urgent production outage, press 1", "maxLength": 250, "type": "string" } }, "required": [ "digit", "prompt", "path" ], "type": "object" }, "CallRoutesUpdateOptionResultV2": { "example": { "option": { "digit": "1", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "prompt": "For an urgent production outage, press 1" } }, "properties": { "option": { "$ref": "#/components/schemas/CallRouteOptionV2" } }, "required": [ "option" ], "type": "object" }, "CallRoutesShowResultV2": { "example": { "call_route": { "allowed_callers": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator duty desk", "phone_number": "+15551234567" } ], "country_code": "US", "created_at": "2021-08-17T13:28:57.801578Z", "current_state": "active", "custom_language": "en-US", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator urgent request", "options": [ { "digit": "1", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "prompt": "For an urgent production outage, press 1" } ], "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "phone_number": "+15551234567", "phone_number_type": "toll_free", "responder_caller_id": "route_number", "updated_at": "2021-08-17T13:28:57.801578Z", "use_caller_allowlist": true } }, "properties": { "call_route": { "$ref": "#/components/schemas/CallRouteV2" } }, "required": [ "call_route" ], "type": "object" }, "CallRoutesUpdatePayloadV2": { "example": { "custom_language": "en-US", "name": "Regulator urgent request", "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "responder_caller_id": "route_number", "use_caller_allowlist": true }, "properties": { "custom_language": { "description": "The language we speak voice prompts in, via text-to-speech", "enum": [ "en-US", "en-GB", "fr-FR", "es-ES", "pt-PT", "pt-BR", "de-DE", "nl-NL" ], "example": "en-US", "type": "string" }, "name": { "description": "Name for this call route", "example": "Regulator urgent request", "type": "string" }, "path": { "description": "Who to page when a call comes in. Retires any phone-tree menu on the route; send an empty list to keep the menu.", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "items": { "$ref": "#/components/schemas/CallRoutePathNodePayloadV2" }, "type": "array" }, "responder_caller_id": { "description": "Which number responders see when we call them:\n* route_number: this route's own number\n* oncall_number: an incident.io on-call number", "enum": [ "route_number", "oncall_number" ], "example": "route_number", "type": "string" }, "use_caller_allowlist": { "description": "Whether to only answer calls from this route's allowed callers. Needs at least one allowed caller.", "example": true, "type": "boolean" } }, "required": [ "name", "custom_language", "responder_caller_id", "use_caller_allowlist", "path" ], "type": "object" }, "CallRoutesUpdateResultV2": { "example": { "call_route": { "allowed_callers": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator duty desk", "phone_number": "+15551234567" } ], "country_code": "US", "created_at": "2021-08-17T13:28:57.801578Z", "current_state": "active", "custom_language": "en-US", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator urgent request", "options": [ { "digit": "1", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "prompt": "For an urgent production outage, press 1" } ], "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "phone_number": "+15551234567", "phone_number_type": "toll_free", "responder_caller_id": "route_number", "updated_at": "2021-08-17T13:28:57.801578Z", "use_caller_allowlist": true } }, "properties": { "call_route": { "$ref": "#/components/schemas/CallRouteV2" } }, "required": [ "call_route" ], "type": "object" }, "CallSessionsListResultV2": { "example": { "call_sessions": [ { "ended_at": "2021-08-17T14:28:57.801578Z", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "started_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "call_sessions": { "example": [ { "ended_at": "2021-08-17T14:28:57.801578Z", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "started_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/CallSessionV2" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" } }, "required": [ "call_sessions" ], "type": "object" }, "CallTranscriptEntriesListResultV2": { "example": { "call_transcript_entries": [ { "content": "I think we should roll back the deploy.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "medium": "spoken", "participant_name": "Alice Smith", "timestamp": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "call_transcript_entries": { "example": [ { "content": "I think we should roll back the deploy.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "medium": "spoken", "participant_name": "Alice Smith", "timestamp": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/CallTranscriptEntryV2" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" } }, "required": [ "call_transcript_entries" ], "type": "object" }, "CatalogListEntriesResultV3": { "example": { "catalog_entries": [ { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" } ], "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "engine_resource_type": "CatalogEntry[\"PagerDutyService\"]", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true }, "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 } }, "properties": { "catalog_entries": { "example": [ { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/CatalogEntryV3" }, "type": "array" }, "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV3" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultWithTotalV3" } }, "required": [ "catalog_type", "catalog_entries", "pagination_meta" ], "type": "object" }, "CatalogCreateEntryPayloadV3": { "example": { "aliases": [ "lawrence@incident.io", "lawrence" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "name": "Primary On-call", "rank": 3 }, "properties": { "aliases": { "description": "Optional aliases that can be used to reference this entry", "example": [ "lawrence@incident.io", "lawrence" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "attribute_values": { "additionalProperties": { "$ref": "#/components/schemas/CatalogEngineParamBindingPayloadV3" }, "description": "Values of this entry", "example": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "type": "object" }, "catalog_type_id": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "external_id": { "description": "An optional alternative ID for this entry, which is ensured to be unique for the type", "example": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "type": "string" }, "name": { "description": "Name is the human readable name of this entry", "example": "Primary On-call", "type": "string" }, "rank": { "description": "When catalog type is ranked, this is used to help order things", "example": 3, "format": "int32", "type": "integer" } }, "required": [ "catalog_type_id", "name", "attribute_values" ], "type": "object" }, "CatalogCreateEntryResultV3": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "catalog_entry": { "$ref": "#/components/schemas/CatalogEntryV3" } }, "required": [ "catalog_entry" ], "type": "object" }, "CatalogShowEntryResultV3": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" }, "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "engine_resource_type": "CatalogEntry[\"PagerDutyService\"]", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "properties": { "catalog_entry": { "$ref": "#/components/schemas/CatalogEntryV3" }, "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV3" } }, "required": [ "catalog_type", "catalog_entry" ], "type": "object" }, "CatalogUpdateEntryPayloadV3": { "example": { "aliases": [ "lawrence@incident.io", "lawrence" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "name": "Primary On-call", "rank": 3, "update_attributes": [ "abc123" ] }, "properties": { "aliases": { "description": "Optional aliases that can be used to reference this entry", "example": [ "lawrence@incident.io", "lawrence" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "attribute_values": { "additionalProperties": { "$ref": "#/components/schemas/CatalogEngineParamBindingPayloadV3" }, "description": "Values of this entry", "example": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "type": "object" }, "external_id": { "description": "An optional alternative ID for this entry, which is ensured to be unique for the type", "example": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "type": "string" }, "name": { "description": "Name is the human readable name of this entry", "example": "Primary On-call", "type": "string" }, "rank": { "description": "When catalog type is ranked, this is used to help order things", "example": 3, "format": "int32", "type": "integer" }, "update_attributes": { "description": "If provided, only update these attribute_values keys. If not provided, update all attribute values.\nIf you specify an attribute key that's not in your payload, the associated attribute value will be cleared.", "example": [ "abc123" ], "items": { "example": "abc123", "type": "string" }, "type": "array" } }, "required": [ "name", "attribute_values" ], "type": "object" }, "CatalogUpdateEntryResultV3": { "example": { "catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "archived_at": "2021-08-17T14:28:57.801578Z", "attribute_values": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123" } } }, "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call", "rank": 3, "updated_at": "2021-08-17T13:28:57.801578Z" }, "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "engine_resource_type": "CatalogEntry[\"PagerDutyService\"]", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "properties": { "catalog_entry": { "$ref": "#/components/schemas/CatalogEntryV3" }, "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV3" } }, "required": [ "catalog_type", "catalog_entry" ], "type": "object" }, "CatalogBulkUpdateEntriesPayloadV3": { "example": { "catalog_type_id": "01GW2G3V0S59R238FAHPDS1R66", "entries": [ { "aliases": [ "abc123" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "entry_id": "abc123", "external_id": "abc123", "name": "abc123", "rank": 1 }, { "aliases": [ "abc123" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "entry_id": "abc123", "external_id": "abc123", "name": "abc123", "rank": 1 } ], "update_attributes": [ "01GW2G3V0S59R238FAHPDS1R66", "01GW2G3V0S59R238FAHPDS1R67" ] }, "properties": { "catalog_type_id": { "description": "The unique identifier of the catalog type containing the entries", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "entries": { "description": "A list of entries to update with their new values. Maximum 250 entries per request.", "example": [ { "aliases": [ "abc123" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "entry_id": "abc123", "external_id": "abc123", "name": "abc123", "rank": 1 }, { "aliases": [ "abc123" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "entry_id": "abc123", "external_id": "abc123", "name": "abc123", "rank": 1 } ], "items": { "$ref": "#/components/schemas/PartialEntryPayloadV3" }, "maxItems": 250, "minItems": 1, "type": "array" }, "update_attributes": { "description": "Optional list of specific attribute IDs to update across all entries. When provided, only these attributes in attribute_values will be updated and all other attributes will be preserved. This parameter only affects attribute_values - it does not affect core entry fields like name, rank, aliases, or external_id, which follow their individual omission rules.", "example": [ "01GW2G3V0S59R238FAHPDS1R66", "01GW2G3V0S59R238FAHPDS1R67" ], "items": { "example": "abc123", "type": "string" }, "type": "array" } }, "required": [ "catalog_type_id", "entries" ], "type": "object" }, "CatalogListResourcesResultV3": { "example": { "resources": [ { "category": "custom", "description": "Boolean true or false value", "engine_resource_type": "CatalogEntry[\"01GVGYJSD39FRKVDWACK9NDS4E\"]", "label": "GitHub Repository", "type": "Custom[\"Team\"]", "value_docstring": "Either the GraphQL node ID of the repository or a string of /, e.g. incident-io/website" } ] }, "properties": { "resources": { "example": [ { "category": "custom", "description": "Boolean true or false value", "engine_resource_type": "CatalogEntry[\"01GVGYJSD39FRKVDWACK9NDS4E\"]", "label": "GitHub Repository", "type": "Custom[\"Team\"]", "value_docstring": "Either the GraphQL node ID of the repository or a string of /, e.g. incident-io/website" } ], "items": { "$ref": "#/components/schemas/CatalogResourceV3" }, "type": "array" } }, "required": [ "resources" ], "type": "object" }, "CatalogListTypesResultV3": { "example": { "catalog_types": [ { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "engine_resource_type": "CatalogEntry[\"PagerDutyService\"]", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } ] }, "properties": { "catalog_types": { "example": [ { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "engine_resource_type": "CatalogEntry[\"PagerDutyService\"]", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } ], "items": { "$ref": "#/components/schemas/CatalogTypeV3" }, "type": "array" } }, "required": [ "catalog_types" ], "type": "object" }, "CatalogCreateTypePayloadV3": { "example": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "description": "Represents Kubernetes clusters that we run inside of GKE.", "icon": "alert", "name": "Kubernetes Cluster", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "ranked": true, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "use_name_as_identifier": true }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that can track metadata about this type", "example": { "incident.io/catalog-importer/id": "id-of-config" }, "type": "object" }, "categories": { "description": "What categories is this type considered part of", "example": [ "customer" ], "items": { "enum": [ "customer", "issue-tracker", "product-feature", "service", "on-call", "team", "user" ], "example": "customer", "type": "string" }, "type": "array" }, "color": { "description": "Sets the display color of this type in the dashboard", "enum": [ "yellow", "green", "blue", "violet", "pink", "cyan", "orange" ], "example": "yellow", "type": "string" }, "description": { "description": "Human readble description of this type", "example": "Represents Kubernetes clusters that we run inside of GKE.", "type": "string" }, "icon": { "description": "Sets the display icon of this type in the dashboard", "enum": [ "alert", "bolt", "box", "briefcase", "browser", "bulb", "calendar", "clock", "cog", "components", "database", "doc", "email", "escalation-path", "files", "flag", "folder", "globe", "incident-template", "money", "server", "severity", "status-page", "store", "star", "tag", "user", "users" ], "example": "alert", "type": "string" }, "name": { "description": "Name is the human readable name of this type", "example": "Kubernetes Cluster", "type": "string" }, "owning_team_ids": { "description": "IDs of the teams that own this catalog type", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "ranked": { "description": "If this type should be ranked", "example": true, "type": "boolean" }, "source_repo_url": { "description": "The url of the external repository where this type is managed", "example": "https://github.com/my-company/incident-io-catalog", "type": "string" }, "type_name": { "description": "The type name of this catalog type, to be used when defining attributes. This is immutable once a CatalogType has been created. For non-externally sync types, it must follow the pattern Custom[\"SomeName\"]", "example": "Custom[\"BackstageGroup\"]", "type": "string" }, "use_name_as_identifier": { "description": "If enabled, you can refer to entries of this type by their name, as well as their external ID and any aliases.", "example": true, "type": "boolean" } }, "required": [ "name", "description" ], "type": "object" }, "CatalogCreateTypeResultV3": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "engine_resource_type": "CatalogEntry[\"PagerDutyService\"]", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "properties": { "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV3" } }, "required": [ "catalog_type" ], "type": "object" }, "CatalogShowTypeResultV3": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "engine_resource_type": "CatalogEntry[\"PagerDutyService\"]", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "properties": { "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV3" } }, "required": [ "catalog_type" ], "type": "object" }, "CatalogUpdateTypePayloadV3": { "example": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "description": "Represents Kubernetes clusters that we run inside of GKE.", "icon": "alert", "name": "Kubernetes Cluster", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "ranked": true, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "use_name_as_identifier": true }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that can track metadata about this type", "example": { "incident.io/catalog-importer/id": "id-of-config" }, "type": "object" }, "categories": { "description": "What categories is this type considered part of", "example": [ "customer" ], "items": { "enum": [ "customer", "issue-tracker", "product-feature", "service", "on-call", "team", "user" ], "example": "customer", "type": "string" }, "type": "array" }, "color": { "description": "Sets the display color of this type in the dashboard", "enum": [ "yellow", "green", "blue", "violet", "pink", "cyan", "orange" ], "example": "yellow", "type": "string" }, "description": { "description": "Human readble description of this type", "example": "Represents Kubernetes clusters that we run inside of GKE.", "type": "string" }, "icon": { "description": "Sets the display icon of this type in the dashboard", "enum": [ "alert", "bolt", "box", "briefcase", "browser", "bulb", "calendar", "clock", "cog", "components", "database", "doc", "email", "escalation-path", "files", "flag", "folder", "globe", "incident-template", "money", "server", "severity", "status-page", "store", "star", "tag", "user", "users" ], "example": "alert", "type": "string" }, "name": { "description": "Name is the human readable name of this type", "example": "Kubernetes Cluster", "type": "string" }, "owning_team_ids": { "description": "IDs of the teams that own this catalog type", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "ranked": { "description": "If this type should be ranked", "example": true, "type": "boolean" }, "source_repo_url": { "description": "The url of the external repository where this type is managed", "example": "https://github.com/my-company/incident-io-catalog", "type": "string" }, "use_name_as_identifier": { "description": "If enabled, you can refer to entries of this type by their name, as well as their external ID and any aliases.", "example": true, "type": "boolean" } }, "required": [ "name", "description" ], "type": "object" }, "CatalogUpdateTypeResultV3": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "engine_resource_type": "CatalogEntry[\"PagerDutyService\"]", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "properties": { "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV3" } }, "required": [ "catalog_type" ], "type": "object" }, "CatalogUpdateTypeSchemaPayloadV3": { "example": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "properties": { "attributes": { "example": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123" } ], "type": "Custom[\"Service\"]" } ], "items": { "$ref": "#/components/schemas/CatalogTypeAttributePayloadV3" }, "type": "array" }, "version": { "example": 1, "format": "int64", "type": "integer" } }, "required": [ "attributes", "version" ], "type": "object" }, "CatalogUpdateTypeSchemaResultV3": { "example": { "catalog_type": { "annotations": { "incident.io/catalog-importer/id": "id-of-config" }, "categories": [ "customer" ], "color": "yellow", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Represents Kubernetes clusters that we run inside of GKE.", "dynamic_resource_parameter": "abc123", "engine_resource_type": "CatalogEntry[\"PagerDutyService\"]", "estimated_count": 7, "icon": "alert", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_editable": false, "is_team_type": false, "last_synced_at": "2021-08-17T13:28:57.801578Z", "name": "Kubernetes Cluster", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "ranked": true, "registry_type": "PagerDutyService", "required_integrations": [ "pager_duty" ], "schema": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "source_repo_url": "https://github.com/my-company/incident-io-catalog", "type_name": "Custom[\"BackstageGroup\"]", "updated_at": "2021-08-17T13:28:57.801578Z", "use_name_as_identifier": true } }, "properties": { "catalog_type": { "$ref": "#/components/schemas/CatalogTypeV3" } }, "required": [ "catalog_type" ], "type": "object" }, "CustomFieldOptionsListResultV1": { "example": { "custom_field_options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "custom_field_options": { "example": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ], "items": { "$ref": "#/components/schemas/CustomFieldOptionV1" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV1" } }, "required": [ "custom_field_options", "pagination_meta" ], "type": "object" }, "CustomFieldOptionsCreatePayloadV1": { "example": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "properties": { "custom_field_id": { "description": "ID of the custom field this option belongs to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "sort_key": { "default": 1000, "description": "Sort key used to order the custom field options correctly", "example": 10, "format": "int64", "type": "integer" }, "value": { "description": "Human readable name for the custom field option. Values must not start or end with whitespace, or contain tabs or newlines.", "example": "Product", "type": "string" } }, "required": [ "custom_field_id", "value" ], "type": "object" }, "CustomFieldOptionsCreateResultV1": { "example": { "custom_field_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } }, "properties": { "custom_field_option": { "$ref": "#/components/schemas/CustomFieldOptionV1" } }, "required": [ "custom_field_option" ], "type": "object" }, "CustomFieldOptionsShowResultV1": { "example": { "custom_field_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } }, "properties": { "custom_field_option": { "$ref": "#/components/schemas/CustomFieldOptionV1" } }, "required": [ "custom_field_option" ], "type": "object" }, "CustomFieldOptionsUpdatePayloadV1": { "example": { "sort_key": 10, "value": "Product" }, "properties": { "sort_key": { "default": 1000, "description": "Sort key used to order the custom field options correctly", "example": 10, "format": "int64", "type": "integer" }, "value": { "description": "Human readable name for the custom field option. Values must not start or end with whitespace, or contain tabs or newlines.", "example": "Product", "type": "string" } }, "required": [ "value", "sort_key" ], "type": "object" }, "CustomFieldOptionsUpdateResultV1": { "example": { "custom_field_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } }, "properties": { "custom_field_option": { "$ref": "#/components/schemas/CustomFieldOptionV1" } }, "required": [ "custom_field_option" ], "type": "object" }, "CustomFieldsListResultV2": { "example": { "custom_fields": [ { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "fixed_filter": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "values": [ "01H2FW182TAH0NHEVBY34SCAK0", "01H2FW182TAH0NHEVBY34SCAK1" ] }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "custom_fields": { "example": [ { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "fixed_filter": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "values": [ "01H2FW182TAH0NHEVBY34SCAK0", "01H2FW182TAH0NHEVBY34SCAK1" ] }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/CustomFieldV2" }, "type": "array" } }, "required": [ "custom_fields" ], "type": "object" }, "CustomFieldsCreatePayloadV2": { "example": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "description": "Which team is impacted by this issue", "field_type": "single_select", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "fixed_filter": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "values": [ "01H2FW182TAH0NHEVBY34SCAK0", "01H2FW182TAH0NHEVBY34SCAK1" ] }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "name": "Affected Team" }, "properties": { "catalog_type_id": { "description": "For catalog fields, the ID of the associated catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "description": { "description": "Description of the custom field", "example": "Which team is impacted by this issue", "type": "string" }, "field_type": { "description": "Type of custom field", "enum": [ "single_select", "multi_select", "text", "link", "numeric" ], "example": "single_select", "type": "string" }, "filter_by": { "$ref": "#/components/schemas/CustomFieldFilterByOptionsV2" }, "fixed_filter": { "$ref": "#/components/schemas/CustomFieldFixedFilterOptionsV2" }, "group_by_catalog_attribute_id": { "description": "For catalog fields, the ID of the attribute used to group catalog entries (if applicable)", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "helptext_catalog_attribute_id": { "description": "Which catalog attribute provides helptext for the options", "example": "01H2FW182TAH0NHEVBY34SCAK0", "type": "string" }, "name": { "description": "Human readable name for the custom field", "example": "Affected Team", "maxLength": 50, "type": "string" } }, "required": [ "name", "description", "field_type" ], "type": "object" }, "CustomFieldsCreateResultV2": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "fixed_filter": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "values": [ "01H2FW182TAH0NHEVBY34SCAK0", "01H2FW182TAH0NHEVBY34SCAK1" ] }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "custom_field": { "$ref": "#/components/schemas/CustomFieldV2" } }, "required": [ "custom_field" ], "type": "object" }, "CustomFieldsShowResultV2": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "fixed_filter": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "values": [ "01H2FW182TAH0NHEVBY34SCAK0", "01H2FW182TAH0NHEVBY34SCAK1" ] }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "custom_field": { "$ref": "#/components/schemas/CustomFieldV2" } }, "required": [ "custom_field" ], "type": "object" }, "CustomFieldsUpdatePayloadV2": { "example": { "description": "Which team is impacted by this issue", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "fixed_filter": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "values": [ "01H2FW182TAH0NHEVBY34SCAK0", "01H2FW182TAH0NHEVBY34SCAK1" ] }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "name": "Affected Team" }, "properties": { "description": { "description": "Description of the custom field", "example": "Which team is impacted by this issue", "type": "string" }, "filter_by": { "$ref": "#/components/schemas/CustomFieldFilterByOptionsV2" }, "fixed_filter": { "$ref": "#/components/schemas/CustomFieldFixedFilterOptionsV2" }, "group_by_catalog_attribute_id": { "description": "For catalog fields, the ID of the attribute used to group catalog entries (if applicable)", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "helptext_catalog_attribute_id": { "description": "Which catalog attribute provides helptext for the options", "example": "01H2FW182TAH0NHEVBY34SCAK0", "type": "string" }, "name": { "description": "Human readable name for the custom field", "example": "Affected Team", "maxLength": 50, "type": "string" } }, "required": [ "name", "description" ], "type": "object" }, "CustomFieldsUpdateResultV2": { "example": { "custom_field": { "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Which team is impacted by this issue", "field_type": "single_select", "filter_by": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "fixed_filter": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "values": [ "01H2FW182TAH0NHEVBY34SCAK0", "01H2FW182TAH0NHEVBY34SCAK1" ] }, "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0", "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "custom_field": { "$ref": "#/components/schemas/CustomFieldV2" } }, "required": [ "custom_field" ], "type": "object" }, "EscalationPathTemplatesListResultV2": { "example": { "escalation_path_templates": [ { "description": "abc123", "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "has_historical_escalation_path_versions": false, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Team on-call", "params": [ { "allowed_value_types": [ "literal" ], "array": true, "default_value": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "description": "What slack channel should we send the message to?", "label": "To date", "name": "severity", "optional": true, "type": "IncidentSeverity" } ], "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "escalation_path_templates": { "example": [ { "description": "abc123", "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "has_historical_escalation_path_versions": false, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Team on-call", "params": [ { "allowed_value_types": [ "literal" ], "array": true, "default_value": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "description": "What slack channel should we send the message to?", "label": "To date", "name": "severity", "optional": true, "type": "IncidentSeverity" } ], "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } ], "items": { "$ref": "#/components/schemas/EscalationPathTemplateV2" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" } }, "required": [ "escalation_path_templates", "pagination_meta" ], "type": "object" }, "EscalationPathTemplatesCreatePayloadV2": { "example": { "description": "Pages the team on-call, then a fallback user", "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "name": "Team on-call", "params": [ { "allowed_value_types": [ "literal" ], "array": true, "default_value": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "description": "What slack channel should we send the message to?", "label": "To date", "name": "severity", "optional": true, "type": "IncidentSeverity" } ], "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "properties": { "description": { "description": "A description of what this template is for.", "example": "Pages the team on-call, then a fallback user", "type": "string" }, "expressions": { "description": "Expressions backing the template's binding targets.", "example": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionPayloadV2" }, "type": "array" }, "name": { "description": "The name of this template, for the user's reference.", "example": "Team on-call", "type": "string" }, "params": { "description": "The parameters declared by this template, bound per templated path.", "example": [ { "allowed_value_types": [ "literal" ], "array": true, "default_value": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "description": "What slack channel should we send the message to?", "label": "To date", "name": "severity", "optional": true, "type": "IncidentSeverity" } ], "items": { "$ref": "#/components/schemas/EngineParamV2" }, "type": "array" }, "path": { "description": "The nodes that form the levels and branches of this template.", "example": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "items": { "$ref": "#/components/schemas/EscalationPathTemplateNodePayloadV2" }, "type": "array" }, "repeat_config": { "$ref": "#/components/schemas/EscalationPathRepeatConfigV2" }, "working_hours": { "description": "The working hours for this template.", "example": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ], "items": { "$ref": "#/components/schemas/WeekdayIntervalConfigV2" }, "type": "array" } }, "required": [ "name", "path" ], "type": "object" }, "EscalationPathTemplatesCreateResultV2": { "example": { "escalation_path_template": { "description": "abc123", "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "has_historical_escalation_path_versions": false, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Team on-call", "params": [ { "allowed_value_types": [ "literal" ], "array": true, "default_value": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "description": "What slack channel should we send the message to?", "label": "To date", "name": "severity", "optional": true, "type": "IncidentSeverity" } ], "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } }, "properties": { "escalation_path_template": { "$ref": "#/components/schemas/EscalationPathTemplateV2" } }, "required": [ "escalation_path_template" ], "type": "object" }, "EscalationPathTemplatesShowResultV2": { "example": { "escalation_path_template": { "description": "abc123", "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "has_historical_escalation_path_versions": false, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Team on-call", "params": [ { "allowed_value_types": [ "literal" ], "array": true, "default_value": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "description": "What slack channel should we send the message to?", "label": "To date", "name": "severity", "optional": true, "type": "IncidentSeverity" } ], "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } }, "properties": { "escalation_path_template": { "$ref": "#/components/schemas/EscalationPathTemplateV2" } }, "required": [ "escalation_path_template" ], "type": "object" }, "EscalationPathTemplatesUpdatePayloadV2": { "example": { "description": "Pages the team on-call, then a fallback user", "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "name": "Team on-call", "params": [ { "allowed_value_types": [ "literal" ], "array": true, "default_value": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "description": "What slack channel should we send the message to?", "label": "To date", "name": "severity", "optional": true, "type": "IncidentSeverity" } ], "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "properties": { "description": { "description": "A description of what this template is for.", "example": "Pages the team on-call, then a fallback user", "type": "string" }, "expressions": { "description": "Expressions backing the template's binding targets.", "example": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionPayloadV2" }, "type": "array" }, "name": { "description": "The name of this template, for the user's reference.", "example": "Team on-call", "type": "string" }, "params": { "description": "The parameters declared by this template, bound per templated path.", "example": [ { "allowed_value_types": [ "literal" ], "array": true, "default_value": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "description": "What slack channel should we send the message to?", "label": "To date", "name": "severity", "optional": true, "type": "IncidentSeverity" } ], "items": { "$ref": "#/components/schemas/EngineParamV2" }, "type": "array" }, "path": { "description": "The nodes that form the levels and branches of this template.", "example": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "items": { "$ref": "#/components/schemas/EscalationPathTemplateNodePayloadV2" }, "type": "array" }, "repeat_config": { "$ref": "#/components/schemas/EscalationPathRepeatConfigV2" }, "working_hours": { "description": "The working hours for this template.", "example": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ], "items": { "$ref": "#/components/schemas/WeekdayIntervalConfigV2" }, "type": "array" } }, "required": [ "name", "path" ], "type": "object" }, "EscalationPathTemplatesUpdateResultV2": { "example": { "escalation_path_template": { "description": "abc123", "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "has_historical_escalation_path_versions": false, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Team on-call", "params": [ { "allowed_value_types": [ "literal" ], "array": true, "default_value": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "description": "What slack channel should we send the message to?", "label": "To date", "name": "severity", "optional": true, "type": "IncidentSeverity" } ], "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } }, "properties": { "escalation_path_template": { "$ref": "#/components/schemas/EscalationPathTemplateV2" } }, "required": [ "escalation_path_template" ], "type": "object" }, "EscalationsListPathsResultV2": { "example": { "escalation_paths": [ { "current_responders": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "kind": "templated", "name": "Urgent Support", "param_bindings": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "template_id": "01FCNDV6P870EA6S7TK1DSYDG0", "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "escalation_paths": { "example": [ { "current_responders": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "kind": "templated", "name": "Urgent Support", "param_bindings": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "template_id": "01FCNDV6P870EA6S7TK1DSYDG0", "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } ], "items": { "$ref": "#/components/schemas/EscalationPathV2" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" } }, "required": [ "escalation_paths", "pagination_meta" ], "type": "object" }, "EscalationsCreatePathPayloadV2": { "example": { "kind": "templated", "name": "Urgent Support", "param_bindings": { "abc123": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "template_id": "01FCNDV6P870EA6S7TK1DSYDG0", "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "properties": { "kind": { "description": "Whether this path carries its own nodes, or is built from an escalation path template.", "enum": [ "standalone", "templated" ], "example": "templated", "type": "string" }, "name": { "description": "The name of this escalation path, for the user's reference.", "example": "Urgent Support", "type": "string" }, "param_bindings": { "additionalProperties": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "description": "For a templated path, the values to bind to the template's declared parameters, keyed by parameter name.", "example": { "abc123": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "type": "object" }, "path": { "description": "The nodes that form the levels and branches of this escalation path.", "example": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "items": { "$ref": "#/components/schemas/EscalationPathNodePayloadV2" }, "type": "array" }, "repeat_config": { "$ref": "#/components/schemas/EscalationPathRepeatConfigV2" }, "team_ids": { "description": "IDs of the teams that own this escalation path. This will automatically sync escalation paths with the right teams in Catalog. If you have an escalation paths attribute on your Teams, this attribute is required.", "example": [ "01JPQA75EPNEES4479P16P4XAB" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "template_id": { "description": "For a templated path, the template to build it from. Required when kind is templated.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "working_hours": { "description": "The working hours for this escalation path.", "example": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ], "items": { "$ref": "#/components/schemas/WeekdayIntervalConfigV2" }, "type": "array" } }, "required": [ "name", "path" ], "type": "object" }, "EscalationsCreatePathResultV2": { "example": { "escalation_path": { "current_responders": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "kind": "templated", "name": "Urgent Support", "param_bindings": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "template_id": "01FCNDV6P870EA6S7TK1DSYDG0", "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } }, "properties": { "escalation_path": { "$ref": "#/components/schemas/EscalationPathV2" } }, "required": [ "escalation_path" ], "type": "object" }, "EscalationsShowPathResultV2": { "example": { "escalation_path": { "current_responders": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "kind": "templated", "name": "Urgent Support", "param_bindings": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "template_id": "01FCNDV6P870EA6S7TK1DSYDG0", "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } }, "properties": { "escalation_path": { "$ref": "#/components/schemas/EscalationPathV2" } }, "required": [ "escalation_path" ], "type": "object" }, "EscalationsUpdatePathPayloadV2": { "example": { "kind": "templated", "name": "Urgent Support", "param_bindings": { "abc123": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "template_id": "01FCNDV6P870EA6S7TK1DSYDG0", "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "properties": { "kind": { "description": "Whether this path carries its own nodes, or is built from an escalation path template.", "enum": [ "standalone", "templated" ], "example": "templated", "type": "string" }, "name": { "description": "The name of this escalation path, for the user's reference.", "example": "Urgent Support", "type": "string" }, "param_bindings": { "additionalProperties": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "description": "For a templated path, the values to bind to the template's declared parameters, keyed by parameter name.", "example": { "abc123": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "type": "object" }, "path": { "description": "The nodes that form the levels and branches of this escalation path.", "example": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "items": { "$ref": "#/components/schemas/EscalationPathNodePayloadV2" }, "type": "array" }, "repeat_config": { "$ref": "#/components/schemas/EscalationPathRepeatConfigV2" }, "team_ids": { "description": "IDs of the teams that own this escalation path. This will automatically sync escalation paths with the right teams in Catalog. If you have an escalation paths attribute on your Teams, this attribute is required.", "example": [ "01JPQA75EPNEES4479P16P4XAB" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "template_id": { "description": "For a templated path, the template to build it from. Required when kind is templated.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "working_hours": { "description": "The working hours for this escalation path.", "example": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ], "items": { "$ref": "#/components/schemas/WeekdayIntervalConfigV2" }, "type": "array" } }, "required": [ "name", "path" ], "type": "object" }, "EscalationsUpdatePathResultV2": { "example": { "escalation_path": { "current_responders": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "kind": "templated", "name": "Urgent Support", "param_bindings": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "repeat_config": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "template_id": "01FCNDV6P870EA6S7TK1DSYDG0", "working_hours": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] } }, "properties": { "escalation_path": { "$ref": "#/components/schemas/EscalationPathV2" } }, "required": [ "escalation_path" ], "type": "object" }, "EscalationsListResultV2": { "example": { "escalations": [ { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Database CPU has been above 90% for 5 minutes", "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" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "escalations": { "example": [ { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Database CPU has been above 90% for 5 minutes", "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" } ], "items": { "$ref": "#/components/schemas/EscalationV2" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" } }, "required": [ "escalations", "pagination_meta" ], "type": "object" }, "EscalationsCreatePayloadV2": { "example": { "description": "Database CPU has been above 90% for 5 minutes", "escalation_path_id": "01H0J1EXE7AXZ2C93K61WBPYEH", "idempotency_key": "2024-01-15-abc123", "incident_id": "01H0J1EXE7AXZ2C93K61WBPYEH", "title": "Production database experiencing high CPU", "user_ids": [ "01H0J1EXE7AXZ2C93K61WBPYEH", "01H0J1EXE7AXZ2C93K61WBPYEI" ] }, "properties": { "description": { "description": "Additional details about the escalation", "example": "Database CPU has been above 90% for 5 minutes", "type": "string" }, "escalation_path_id": { "description": "ID of the escalation path to follow", "example": "01H0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "idempotency_key": { "description": "Unique key to prevent duplicate escalations. If this key has already been used, the existing escalation will be returned.", "example": "2024-01-15-abc123", "type": "string" }, "incident_id": { "description": "ID of an incident to associate with this escalation. The linked incident will appear in the escalation's related_incidents field.", "example": "01H0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "title": { "description": "The title of the escalation. This message will be included in all notifications about this escalation.", "example": "Production database experiencing high CPU", "type": "string" }, "user_ids": { "description": "IDs of users to escalate directly to", "example": [ "01H0J1EXE7AXZ2C93K61WBPYEH", "01H0J1EXE7AXZ2C93K61WBPYEI" ], "items": { "example": "abc123", "type": "string" }, "type": "array" } }, "required": [ "idempotency_key", "title" ], "type": "object" }, "EscalationsCreateResultV2": { "example": { "escalation": { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Database CPU has been above 90% for 5 minutes", "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": { "escalation": { "$ref": "#/components/schemas/EscalationV2" } }, "required": [ "escalation" ], "type": "object" }, "EscalationsCheckEscalationPermissionsPayloadV2": { "example": { "user_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ] }, "properties": { "user_ids": { "description": "The IDs of the users to check response options for", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" } }, "required": [ "user_ids" ], "type": "object" }, "EscalationsCheckEscalationPermissionsResultV2": { "example": { "response_options": [ { "available_actions": [ "ack", "nack", "snooze" ], "user_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ] }, "properties": { "response_options": { "description": "The response options available to each requested user, in the same order as the request.", "example": [ { "available_actions": [ "ack", "nack", "snooze" ], "user_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ], "items": { "$ref": "#/components/schemas/EscalationUserResponseOptionsV2" }, "type": "array" } }, "required": [ "response_options" ], "type": "object" }, "EscalationsReassignEscalationPayloadV2": { "example": { "description": "Database CPU has been above 90% for 5 minutes", "escalation_path_id": "01H0J1EXE7AXZ2C93K61WBPYEH", "resolve_original": true, "title": "Production database experiencing high CPU", "user_ids": [ "01H0J1EXE7AXZ2C93K61WBPYEH", "01H0J1EXE7AXZ2C93K61WBPYEI" ] }, "properties": { "description": { "description": "Additional details about the new escalation. Defaults to the original's description.", "example": "Database CPU has been above 90% for 5 minutes", "type": "string" }, "escalation_path_id": { "description": "ID of the escalation path to reassign to", "example": "01H0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "resolve_original": { "default": true, "description": "Whether to resolve the original escalation, stopping it paging its targets. Defaults to true.", "example": true, "type": "boolean" }, "title": { "description": "The title of the new escalation. Defaults to the original's title.", "example": "Production database experiencing high CPU", "type": "string" }, "user_ids": { "description": "IDs of users to reassign directly to", "example": [ "01H0J1EXE7AXZ2C93K61WBPYEH", "01H0J1EXE7AXZ2C93K61WBPYEI" ], "items": { "example": "abc123", "type": "string" }, "type": "array" } }, "type": "object" }, "EscalationsReassignEscalationResultV2": { "example": { "escalation": { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Database CPU has been above 90% for 5 minutes", "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": { "escalation": { "$ref": "#/components/schemas/EscalationV2" } }, "required": [ "escalation" ], "type": "object" }, "EscalationsRespondEscalationPayloadV2": { "example": { "response": "ack", "snooze_details": { "reason": "Waiting for deployment to complete", "snooze_until": "2025-01-01T12:00:00Z" } }, "properties": { "response": { "description": "Whether to acknowledge, decline or snooze the escalation", "enum": [ "ack", "nack", "snooze" ], "example": "ack", "type": "string" }, "snooze_details": { "$ref": "#/components/schemas/EscalationRespondSnoozeDetailsPayloadV2" } }, "required": [ "response" ], "type": "object" }, "EscalationsShowResultV2": { "example": { "escalation": { "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Database CPU has been above 90% for 5 minutes", "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": { "escalation": { "$ref": "#/components/schemas/EscalationV2" } }, "required": [ "escalation" ], "type": "object" }, "FollowUpsListResultV3": { "example": { "follow_ups": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "category": { "description": "Follow-ups related to infrastructure changes.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Infrastructure", "rank": 10 }, "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" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "follow_ups": { "example": [ { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "category": { "description": "Follow-ups related to infrastructure changes.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Infrastructure", "rank": 10 }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/FollowUpV3" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV3" } }, "required": [ "follow_ups", "pagination_meta" ], "type": "object" }, "FollowUpsCreatePayloadV3": { "example": { "assignee_id": "01FCNDV6P870EA6S7TK1DSYDG0", "assignee_team_id": "01FCNDV6P870EA6S7TK1DSYDG0", "description": "Call the fire brigade", "external_issue_reference_id": "01FCNDV6P870EA6S7TK1DSYDG0", "follow_up_category_id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "follow_up_priority_option_id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "labels": [ "bug", "urgent" ], "title": "Add alerting on replica lag" }, "properties": { "assignee_id": { "description": "ID of the user this follow-up is assigned to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "assignee_team_id": { "description": "ID of the team this follow-up is assigned to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "description": { "description": "Description of the follow-up. Supports Markdown.", "example": "Call the fire brigade", "type": "string" }, "external_issue_reference_id": { "description": "If this follow-up is related to an external issue, the ID of that issue", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "follow_up_category_id": { "description": "ID of the category for this follow-up", "example": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "type": "string" }, "follow_up_priority_option_id": { "description": "ID of the priority for this follow-up", "example": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "type": "string" }, "incident_id": { "description": "Unique identifier of the incident the follow-up belongs to", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "labels": { "description": "Labels associated with this follow-up", "example": [ "bug", "urgent" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "title": { "description": "Title of the follow-up", "example": "Add alerting on replica lag", "type": "string" } }, "required": [ "incident_id", "title" ], "type": "object" }, "FollowUpsCreateResultV3": { "example": { "follow_up": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "category": { "description": "Follow-ups related to infrastructure changes.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Infrastructure", "rank": 10 }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "follow_up": { "$ref": "#/components/schemas/FollowUpV3" } }, "required": [ "follow_up" ], "type": "object" }, "FollowUpsShowResultV3": { "example": { "follow_up": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "category": { "description": "Follow-ups related to infrastructure changes.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Infrastructure", "rank": 10 }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "follow_up": { "$ref": "#/components/schemas/FollowUpV3" } }, "required": [ "follow_up" ], "type": "object" }, "FollowUpsUpdatePayloadV3": { "example": { "assignee_id": "01FCNDV6P870EA6S7TK1DSYDG0", "assignee_team_id": "01FCNDV6P870EA6S7TK1DSYDG0", "description": "Call the fire brigade", "follow_up_category_id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "follow_up_priority_option_id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "labels": [ "bug", "urgent" ], "status": "outstanding", "title": "Add alerting on replica lag" }, "properties": { "assignee_id": { "description": "ID of the user this follow-up is assigned to. Set to null to unassign.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "assignee_team_id": { "description": "ID of the team this follow-up is assigned to. Set to null to unassign.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "description": { "description": "Description of the follow-up. Supports Markdown.", "example": "Call the fire brigade", "type": "string" }, "follow_up_category_id": { "description": "ID of the category for this follow-up", "example": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "type": "string" }, "follow_up_priority_option_id": { "description": "ID of the priority for this follow-up", "example": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "type": "string" }, "labels": { "description": "Labels associated with this follow-up", "example": [ "bug", "urgent" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "status": { "description": "Status of the follow-up. Setting this to `deleted` is not allowed; use the delete endpoint instead.", "enum": [ "outstanding", "completed", "deleted", "not_doing" ], "example": "outstanding", "type": "string" }, "title": { "description": "Title of the follow-up", "example": "Add alerting on replica lag", "type": "string" } }, "required": [ "title", "status" ], "type": "object" }, "FollowUpsUpdateResultV3": { "example": { "follow_up": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "category": { "description": "Follow-ups related to infrastructure changes.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Infrastructure", "rank": 10 }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "follow_up": { "$ref": "#/components/schemas/FollowUpV3" } }, "required": [ "follow_up" ], "type": "object" }, "FollowUpsConnectExternalIssuePayloadV3": { "example": { "provider": "linear", "url": "https://linear.app/incident/issue/INC-123" }, "properties": { "provider": { "description": "The issue tracker provider the issue belongs to", "enum": [ "asana", "azure_devops", "click_up", "freshservice", "linear", "jira", "salesforce", "jira_server", "github", "gitlab", "service_now", "shortcut", "notion" ], "example": "linear", "type": "string" }, "url": { "description": "URL of the issue in the external provider", "example": "https://linear.app/incident/issue/INC-123", "type": "string" } }, "required": [ "provider", "url" ], "type": "object" }, "FollowUpsConnectExternalIssueResultV3": { "example": { "follow_up": { "assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "assignee_team": { "id": "abc123", "name": "abc123" }, "category": { "description": "Follow-ups related to infrastructure changes.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Infrastructure", "rank": 10 }, "completed_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "description": "Call the fire brigade", "external_issue_reference": { "issue_name": "INC-123", "issue_permalink": "https://linear.app/incident-io/issue/INC-1609/find-copywriter-to-write-up", "provider": "asana" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "labels": [ "bug", "urgent" ], "priority": { "description": "A follow-up that requires immediate attention.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Urgent", "rank": 10 }, "status": "outstanding", "title": "Cat is stuck in the tree", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "follow_up": { "$ref": "#/components/schemas/FollowUpV3" } }, "required": [ "follow_up" ], "type": "object" }, "IncidentActivityLogEntriesListResultV2": { "example": { "incident_activity_log_entries": [ { "content": { "action_created": { "action_id": "01FCNDV6P870EA6S7TK1DSYDG0", "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" } } }, "action_updated": { "action_id": "01FCNDV6P870EA6S7TK1DSYDG0", "new_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "new_status": "completed", "previous_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "previous_status": "outstanding", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "alert_attached_to_incident": { "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" } }, "alert_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "custom_field_value_update": { "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" } ] }, "new_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" } ], "new_values_count": 4, "previous_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" } ], "previous_values_count": 3, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "escalation_acknowledged": { "acknowledger": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "escalation_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_created": { "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" } }, "escalated_to_users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "escalation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG1" }, "follow_up_created": { "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" } }, "follow_up_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "follow_up_updated": { "follow_up_id": "01FCNDV6P870EA6S7TK1DSYDG0", "new_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "new_status": "completed", "new_title": "Add a payments-api rollback runbook", "previous_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "previous_status": "outstanding", "previous_title": "Add a runbook", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "incident_merged": { "incident_update_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merger": { "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" } }, "source_incident": { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } }, "incident_rename": { "new_name": "EU checkout failing after 14:02 deploy", "previous_name": "Checkout errors", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "incident_timestamp_set": { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "new_value": "2026-09-01T13:42:00Z", "previous_value": "2026-09-01T14:00:00Z", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "incident_type_changed": { "new_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" }, "previous_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" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "incident_update": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "message": "Rolled back **payments-api** to v411, error rate recovering.", "new_severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "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" }, "next_update_in_minutes": 30, "previous_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" }, "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" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "incident_visibility_changed": { "new_visibility": "private", "previous_visibility": "public", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "role_update": { "new_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "previous_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", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "status_change": { "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" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "summary_update": { "new_summary": "Checkout is failing for all EU customers since the 14:02 deploy.", "previous_summary": "Checkout is failing for some customers.", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "workflow_ran": { "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" } }, "event_description": "Stopped the synthetic load test in staging.", "event_title": "Load test halted" } }, "created_at": "2026-09-01T15:30:01Z", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "occurred_at": "2026-09-01T15:30:00Z", "title": "Status changed from Investigating to Monitoring", "type": "incident_update" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "incident_activity_log_entries": { "example": [ { "content": { "action_created": { "action_id": "01FCNDV6P870EA6S7TK1DSYDG0", "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" } } }, "action_updated": { "action_id": "01FCNDV6P870EA6S7TK1DSYDG0", "new_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "new_status": "completed", "previous_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "previous_status": "outstanding", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "alert_attached_to_incident": { "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" } }, "alert_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "custom_field_value_update": { "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" } ] }, "new_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" } ], "new_values_count": 4, "previous_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" } ], "previous_values_count": 3, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "escalation_acknowledged": { "acknowledger": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "escalation_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_created": { "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" } }, "escalated_to_users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "escalation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG1" }, "follow_up_created": { "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" } }, "follow_up_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "follow_up_updated": { "follow_up_id": "01FCNDV6P870EA6S7TK1DSYDG0", "new_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "new_status": "completed", "new_title": "Add a payments-api rollback runbook", "previous_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "previous_status": "outstanding", "previous_title": "Add a runbook", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "incident_merged": { "incident_update_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merger": { "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" } }, "source_incident": { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } }, "incident_rename": { "new_name": "EU checkout failing after 14:02 deploy", "previous_name": "Checkout errors", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "incident_timestamp_set": { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "new_value": "2026-09-01T13:42:00Z", "previous_value": "2026-09-01T14:00:00Z", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "incident_type_changed": { "new_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" }, "previous_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" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "incident_update": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "message": "Rolled back **payments-api** to v411, error rate recovering.", "new_severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "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" }, "next_update_in_minutes": 30, "previous_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" }, "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" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "incident_visibility_changed": { "new_visibility": "private", "previous_visibility": "public", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "role_update": { "new_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "previous_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", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "status_change": { "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" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "summary_update": { "new_summary": "Checkout is failing for all EU customers since the 14:02 deploy.", "previous_summary": "Checkout is failing for some customers.", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "workflow_ran": { "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" } }, "event_description": "Stopped the synthetic load test in staging.", "event_title": "Load test halted" } }, "created_at": "2026-09-01T15:30:01Z", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "occurred_at": "2026-09-01T15:30:00Z", "title": "Status changed from Investigating to Monitoring", "type": "incident_update" } ], "items": { "$ref": "#/components/schemas/IncidentActivityLogEntryV2" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" } }, "required": [ "incident_activity_log_entries" ], "type": "object" }, "IncidentAttachmentsListResultV1": { "example": { "incident_attachments": [ { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "resource": { "external_id": "123", "permalink": "https://my.pagerduty.com/incidents/ABC", "resource_type": "pager_duty_incident", "title": "The database has gone down" } } ] }, "properties": { "incident_attachments": { "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "resource": { "external_id": "123", "permalink": "https://my.pagerduty.com/incidents/ABC", "resource_type": "pager_duty_incident", "title": "The database has gone down" } } ], "items": { "$ref": "#/components/schemas/IncidentAttachmentV1" }, "type": "array" } }, "required": [ "incident_attachments" ], "type": "object" }, "IncidentAttachmentsCreatePayloadV1": { "example": { "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "resource": { "emoji": "rocket", "external_id": "123", "resource_type": "pager_duty_incident", "title": "Impact tracking spreadsheet", "url": "https://github.com/company/repo/pull/123" } }, "properties": { "incident_id": { "description": "ID of the incident to add an attachment to", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "resource": { "example": { "emoji": "rocket", "external_id": "123", "resource_type": "pager_duty_incident", "title": "Impact tracking spreadsheet", "url": "https://github.com/company/repo/pull/123" }, "properties": { "emoji": { "description": "Emoji shortcode representing the link, without surrounding colons. Only supported for the arbitrary_url resource type.", "example": "rocket", "type": "string" }, "external_id": { "description": "ID of the resource in the external system", "example": "123", "type": "string" }, "resource_type": { "description": "E.g. PagerDuty: the external system that holds the resource", "enum": [ "pager_duty_incident", "opsgenie_alert", "datadog_monitor_alert", "github_pull_request", "gitlab_merge_request", "sentry_issue", "jira_issue", "jsm_alert", "atlassian_statuspage_incident", "zendesk_ticket", "google_calendar_event", "outlook_calendar_event", "slack_file", "salesforce_case", "arbitrary_url", "scrubbed", "statuspage_incident" ], "example": "pager_duty_incident", "type": "string" }, "title": { "description": "Human readable title for the link. Only supported for the arbitrary_url resource type.", "example": "Impact tracking spreadsheet", "type": "string" }, "url": { "description": "URL of the external resource to attach for the given resource type.", "example": "https://github.com/company/repo/pull/123", "type": "string" } }, "required": [ "resource_type" ], "type": "object" } }, "required": [ "incident_id", "resource" ], "type": "object" }, "IncidentAttachmentsCreateResultV1": { "example": { "incident_attachment": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "resource": { "external_id": "123", "permalink": "https://my.pagerduty.com/incidents/ABC", "resource_type": "pager_duty_incident", "title": "The database has gone down" } } }, "properties": { "incident_attachment": { "$ref": "#/components/schemas/IncidentAttachmentV1" } }, "required": [ "incident_attachment" ], "type": "object" }, "IncidentMembershipsCreatePayloadV1": { "example": { "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "user_id": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "properties": { "incident_id": { "description": "The incident to make the user a member of", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "user_id": { "example": "01FCQSP07Z74QMMYPDDGQB9FTG", "type": "string" } }, "required": [ "user_id", "incident_id" ], "type": "object" }, "IncidentMembershipsCreateResultV1": { "example": { "incident_membership": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "updated_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } } }, "properties": { "incident_membership": { "$ref": "#/components/schemas/IncidentMembershipV1" } }, "required": [ "incident_membership" ], "type": "object" }, "IncidentMembershipsRevokePayloadV1": { "example": { "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "user_id": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "properties": { "incident_id": { "description": "Revoke memberships to incident", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "user_id": { "example": "01FCQSP07Z74QMMYPDDGQB9FTG", "type": "string" } }, "required": [ "user_id", "incident_id" ], "type": "object" }, "IncidentRelationshipsListResultV1": { "example": { "incident_relationships": [ { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "incident": { "external_id": 123, "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "The database is down" } } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "incident_relationships": { "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "incident": { "external_id": 123, "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "The database is down" } } ], "items": { "$ref": "#/components/schemas/IncidentRelationshipV1" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV1" } }, "required": [ "incident_relationships" ], "type": "object" }, "IncidentRolesListResultV2": { "example": { "incident_roles": [ { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "incident_roles": { "example": [ { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/IncidentRoleV2" }, "type": "array" } }, "required": [ "incident_roles" ], "type": "object" }, "IncidentRolesCreatePayloadV2": { "example": { "description": "The person currently coordinating the incident", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "shortform": "lead" }, "properties": { "description": { "description": "Describes the purpose of the role", "example": "The person currently coordinating the incident", "minLength": 1, "type": "string" }, "instructions": { "description": "Provided to whoever is nominated for the role. Note that this will be empty for the 'reporter' role.", "example": "Take point on the incident; Make sure people are clear on responsibilities", "type": "string" }, "name": { "description": "Human readable name of the incident role", "example": "Incident Lead", "minLength": 1, "type": "string" }, "shortform": { "description": "Short human readable name for Slack. Note that this will be empty for the 'reporter' role.", "example": "lead", "type": "string" } }, "required": [ "name", "shortform", "description", "instructions" ], "type": "object" }, "IncidentRolesCreateResultV2": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_role": { "$ref": "#/components/schemas/IncidentRoleV2" } }, "required": [ "incident_role" ], "type": "object" }, "IncidentRolesShowResultV2": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_role": { "$ref": "#/components/schemas/IncidentRoleV2" } }, "required": [ "incident_role" ], "type": "object" }, "IncidentRolesUpdatePayloadV2": { "example": { "description": "The person currently coordinating the incident", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "shortform": "lead" }, "properties": { "description": { "description": "Describes the purpose of the role", "example": "The person currently coordinating the incident", "minLength": 1, "type": "string" }, "instructions": { "description": "Provided to whoever is nominated for the role. Note that this will be empty for the 'reporter' role.", "example": "Take point on the incident; Make sure people are clear on responsibilities", "type": "string" }, "name": { "description": "Human readable name of the incident role", "example": "Incident Lead", "minLength": 1, "type": "string" }, "shortform": { "description": "Short human readable name for Slack. Note that this will be empty for the 'reporter' role.", "example": "lead", "type": "string" } }, "required": [ "name", "shortform", "description", "instructions" ], "type": "object" }, "IncidentRolesUpdateResultV2": { "example": { "incident_role": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "The person currently coordinating the incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "instructions": "Take point on the incident; Make sure people are clear on responsibilities", "name": "Incident Lead", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_role": { "$ref": "#/components/schemas/IncidentRoleV2" } }, "required": [ "incident_role" ], "type": "object" }, "IncidentStatusesListResultV1": { "example": { "incident_statuses": [ { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "incident_statuses": { "example": [ { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/IncidentStatusV1" }, "type": "array" } }, "required": [ "incident_statuses" ], "type": "object" }, "IncidentStatusesCreatePayloadV1": { "example": { "category": "live", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "name": "Closed", "rank": 4 }, "properties": { "category": { "description": "Whether the status should be considered 'live' (now renamed to active), 'learning' (now renamed to post-incident) or 'closed'. The triage and declined statuses cannot be created or modified.", "enum": [ "live", "learning", "closed" ], "example": "live", "type": "string" }, "description": { "description": "Rich text description of the incident status", "example": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "type": "string" }, "name": { "description": "Unique name of this status", "example": "Closed", "type": "string" }, "rank": { "description": "Where this status sits within its category, lowest rank first. No two statuses in the same category can share a rank, but ranks needn't run consecutively — leaving gaps (10, 20, 30) means you can later insert a status between two others without renumbering them. Omit it to add this status to the end of its category.", "example": 4, "format": "int64", "type": "integer" } }, "required": [ "name", "description", "category" ], "type": "object" }, "IncidentStatusesCreateResultV1": { "example": { "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_status": { "$ref": "#/components/schemas/IncidentStatusV1" } }, "required": [ "incident_status" ], "type": "object" }, "IncidentStatusesShowResultV1": { "example": { "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_status": { "$ref": "#/components/schemas/IncidentStatusV1" } }, "required": [ "incident_status" ], "type": "object" }, "IncidentStatusesUpdatePayloadV1": { "example": { "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "name": "Closed", "rank": 4 }, "properties": { "description": { "description": "Rich text description of the incident status", "example": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "type": "string" }, "name": { "description": "Unique name of this status", "example": "Closed", "type": "string" }, "rank": { "description": "Where this status sits within its category, lowest rank first. No two statuses in the same category can share a rank, but ranks needn't run consecutively — leaving gaps (10, 20, 30) means you can later insert a status between two others without renumbering them. Omit it to leave this status where it is.", "example": 4, "format": "int64", "type": "integer" } }, "required": [ "name", "description" ], "type": "object" }, "IncidentStatusesUpdateResultV1": { "example": { "incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_status": { "$ref": "#/components/schemas/IncidentStatusV1" } }, "required": [ "incident_status" ], "type": "object" }, "IncidentTemplatesListResultV1": { "example": { "incident_templates": [ { "created_at": "2021-08-17T13:28:57.801578Z", "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Payments incidents", "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "updated_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "incident_templates": { "example": [ { "created_at": "2021-08-17T13:28:57.801578Z", "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Payments incidents", "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/IncidentTemplateV1" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV1" } }, "required": [ "incident_templates" ], "type": "object" }, "IncidentTemplatesCreatePayloadV1": { "example": { "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "name": "Payments incidents", "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } } }, "properties": { "expressions": { "description": "The expressions used by bindings in this template", "example": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionPayloadV3" }, "type": "array" }, "name": { "description": "The name of this incident template, for the user's reference", "example": "Payments incidents", "type": "string" }, "template": { "$ref": "#/components/schemas/IncidentTemplateConfigPayloadV1" } }, "required": [ "name", "template" ], "type": "object" }, "IncidentTemplatesCreateResultV1": { "example": { "incident_template": { "created_at": "2021-08-17T13:28:57.801578Z", "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Payments incidents", "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_template": { "$ref": "#/components/schemas/IncidentTemplateV1" } }, "required": [ "incident_template" ], "type": "object" }, "IncidentTemplatesShowResultV1": { "example": { "incident_template": { "created_at": "2021-08-17T13:28:57.801578Z", "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Payments incidents", "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_template": { "$ref": "#/components/schemas/IncidentTemplateV1" } }, "required": [ "incident_template" ], "type": "object" }, "IncidentTemplatesUpdatePayloadV1": { "example": { "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "name": "Payments incidents", "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } } }, "properties": { "expressions": { "description": "The expressions used by bindings in this template", "example": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionPayloadV3" }, "type": "array" }, "name": { "description": "The name of this incident template, for the user's reference", "example": "Payments incidents", "type": "string" }, "template": { "$ref": "#/components/schemas/IncidentTemplateConfigPayloadV1" } }, "required": [ "name", "template" ], "type": "object" }, "IncidentTemplatesUpdateResultV1": { "example": { "incident_template": { "created_at": "2021-08-17T13:28:57.801578Z", "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Payments incidents", "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_template": { "$ref": "#/components/schemas/IncidentTemplateV1" } }, "required": [ "incident_template" ], "type": "object" }, "IncidentTemplatesValidatePayloadV1": { "example": { "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "name": "Payments incidents", "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } } }, "properties": { "expressions": { "description": "The expressions used by bindings in this template", "example": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionPayloadV3" }, "type": "array" }, "name": { "description": "The name of this incident template, for the user's reference", "example": "Payments incidents", "type": "string" }, "template": { "$ref": "#/components/schemas/IncidentTemplateConfigPayloadV1" } }, "required": [ "name", "template" ], "type": "object" }, "IncidentTemplatesValidateResultV1": { "example": { "warnings": [ { "detail": "Creating a new template with this name will fail. Updating the template that already has it keeps working.", "summary": "An incident template with this name already exists" } ] }, "properties": { "warnings": { "description": "Anything suspect about this config that isn't severe enough to reject it. Empty when there's nothing to say.", "example": [ { "detail": "Creating a new template with this name will fail. Updating the template that already has it keeps working.", "summary": "An incident template with this name already exists" } ], "items": { "$ref": "#/components/schemas/IncidentTemplateValidateWarningV1" }, "type": "array" } }, "required": [ "warnings" ], "type": "object" }, "IncidentTimelineItemsListResultV2": { "example": { "incident_timeline_items": [ { "activity_log_id": "01FCNDV6P870EA6S7TK1DSYDG1", "created_at": "2026-09-01T15:31:04Z", "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": "Rolled back **payments-api** to v411 after error rate hit 12%.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "timestamp": "2026-09-01T15:30:00Z", "title": "Rolled back payments-api", "updated_at": "2026-09-01T16:45:00Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "incident_timeline_items": { "example": [ { "activity_log_id": "01FCNDV6P870EA6S7TK1DSYDG1", "created_at": "2026-09-01T15:31:04Z", "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": "Rolled back **payments-api** to v411 after error rate hit 12%.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "timestamp": "2026-09-01T15:30:00Z", "title": "Rolled back payments-api", "updated_at": "2026-09-01T16:45:00Z" } ], "items": { "$ref": "#/components/schemas/IncidentTimelineItemV2" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" } }, "required": [ "incident_timeline_items" ], "type": "object" }, "IncidentTimelineItemsCreatePayloadV2": { "example": { "description": "Rolled back **payments-api** to v411 after error rate hit 12%.", "idempotency_key": "deploy-4f2c1b90", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "timestamp": "2026-09-01T15:30:00Z", "title": "Rolled back payments-api" }, "properties": { "description": { "description": "Description of the timeline item, in markdown", "example": "Rolled back **payments-api** to v411 after error rate hit 12%.", "type": "string" }, "idempotency_key": { "description": "Unique string used to de-duplicate timeline item requests. Retrying with the same key returns the item the first request created, rather than adding a second one.", "example": "deploy-4f2c1b90", "minLength": 1, "type": "string" }, "incident_id": { "description": "Incident to add this item to", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "timestamp": { "description": "When the thing this item describes happened. This is where the item sits on the timeline, and can be in the past.", "example": "2026-09-01T15:30:00Z", "format": "date-time", "type": "string" }, "title": { "description": "Title of the timeline item", "example": "Rolled back payments-api", "minLength": 1, "type": "string" } }, "required": [ "incident_id", "timestamp", "title", "idempotency_key" ], "type": "object" }, "IncidentTimelineItemsCreateResultV2": { "example": { "incident_timeline_item": { "activity_log_id": "01FCNDV6P870EA6S7TK1DSYDG1", "created_at": "2026-09-01T15:31:04Z", "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": "Rolled back **payments-api** to v411 after error rate hit 12%.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "timestamp": "2026-09-01T15:30:00Z", "title": "Rolled back payments-api", "updated_at": "2026-09-01T16:45:00Z" } }, "properties": { "incident_timeline_item": { "$ref": "#/components/schemas/IncidentTimelineItemV2" } }, "required": [ "incident_timeline_item" ], "type": "object" }, "IncidentTimelineItemsUpdatePayloadV2": { "example": { "description": "Rolled back **payments-api** to v411 after error rate hit 12%.", "timestamp": "2026-09-01T15:30:00Z", "title": "Rolled back payments-api" }, "properties": { "description": { "description": "Description of the timeline item, in markdown. Send an empty string to remove it.", "example": "Rolled back **payments-api** to v411 after error rate hit 12%.", "type": "string" }, "timestamp": { "description": "When the thing this item describes happened. Only editable on a custom item.", "example": "2026-09-01T15:30:00Z", "format": "date-time", "type": "string" }, "title": { "description": "Title of the timeline item", "example": "Rolled back payments-api", "minLength": 1, "type": "string" } }, "type": "object" }, "IncidentTimelineItemsUpdateResultV2": { "example": { "incident_timeline_item": { "activity_log_id": "01FCNDV6P870EA6S7TK1DSYDG1", "created_at": "2026-09-01T15:31:04Z", "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": "Rolled back **payments-api** to v411 after error rate hit 12%.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "timestamp": "2026-09-01T15:30:00Z", "title": "Rolled back payments-api", "updated_at": "2026-09-01T16:45:00Z" } }, "properties": { "incident_timeline_item": { "$ref": "#/components/schemas/IncidentTimelineItemV2" } }, "required": [ "incident_timeline_item" ], "type": "object" }, "IncidentTimestampsListResultV2": { "example": { "incident_timestamps": [ { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 } ] }, "properties": { "incident_timestamps": { "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 } ], "items": { "$ref": "#/components/schemas/IncidentTimestampV2" }, "type": "array" } }, "required": [ "incident_timestamps" ], "type": "object" }, "IncidentTimestampsShowResultV2": { "example": { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 } }, "properties": { "incident_timestamp": { "$ref": "#/components/schemas/IncidentTimestampV2" } }, "required": [ "incident_timestamp" ], "type": "object" }, "IncidentTypesListResultV1": { "example": { "incident_types": [ { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "incident_types": { "example": [ { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/IncidentTypeV1" }, "type": "array" } }, "required": [ "incident_types" ], "type": "object" }, "IncidentTypesShowResultV1": { "example": { "incident_type": { "create_in_triage": "always", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Customer facing production outages", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_default": false, "name": "Production Outage", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incidents_only": false, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "incident_type": { "$ref": "#/components/schemas/IncidentTypeV1" } }, "required": [ "incident_type" ], "type": "object" }, "IncidentUpdatesListResultV2": { "example": { "incident_updates": [ { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merged_into_incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "message": "We're working on a fix, hoping to ship in the next 30 minutes", "new_incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "new_severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "incident_updates": { "example": [ { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merged_into_incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "message": "We're working on a fix, hoping to ship in the next 30 minutes", "new_incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "new_severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } } ], "items": { "$ref": "#/components/schemas/IncidentUpdateV2" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" } }, "required": [ "incident_updates" ], "type": "object" }, "IncidentUpdatesCreatePayloadV2": { "example": { "idempotency_key": "alert-uuid", "incident_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "message": "We're working on a fix, hoping to ship in the next 30 minutes", "to_incident_status_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "to_severity_id": "01FH5TZRWMNAFB0DZ23FD1TV96" }, "properties": { "idempotency_key": { "description": "Unique string used to de-duplicate incident update requests. Retrying with the same key returns the update the first request created, rather than sharing a second one.", "example": "alert-uuid", "type": "string" }, "incident_id": { "description": "The incident you want to update", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "message": { "description": "Message that explains the context behind the update, in markdown", "example": "We're working on a fix, hoping to ship in the next 30 minutes", "type": "string" }, "to_incident_status_id": { "description": "Move the incident to this status", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "to_severity_id": { "description": "Move the incident to this severity", "example": "01FH5TZRWMNAFB0DZ23FD1TV96", "type": "string" } }, "required": [ "incident_id", "idempotency_key" ], "type": "object" }, "IncidentUpdatesCreateResultV2": { "example": { "incident_update": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merged_into_incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "message": "We're working on a fix, hoping to ship in the next 30 minutes", "new_incident_status": { "category": "triage", "created_at": "2021-08-17T13:28:57.801578Z", "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.", "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Closed", "rank": 4, "updated_at": "2021-08-17T13:28:57.801578Z" }, "new_severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } } }, "properties": { "incident_update": { "$ref": "#/components/schemas/IncidentUpdateV2" } }, "required": [ "incident_update" ], "type": "object" }, "IncidentParticipantsListResultV2": { "example": { "incident_participants": { "active": [ { "participant_type": "observer", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "passive": [ { "participant_type": "observer", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ] } }, "properties": { "incident_participants": { "$ref": "#/components/schemas/IncidentParticipantsV2" } }, "required": [ "incident_participants" ], "type": "object" }, "IncidentParticipantWorkloadsListResultV2": { "example": { "incident_participant_workloads": [ { "archived_at": "2021-08-17T13:28:57.801578Z", "participant_type": "observer", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workload": { "minutes_spent_on_incident": 125.5, "minutes_spent_on_incident_in_late_hours": 20.5, "minutes_spent_on_incident_in_sleeping_hours": 15, "minutes_spent_on_incident_in_working_hours": 90 } } ], "metadata": { "data_synced_at": "2021-08-17T13:00:00Z" } }, "properties": { "incident_participant_workloads": { "example": [ { "archived_at": "2021-08-17T13:28:57.801578Z", "participant_type": "observer", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workload": { "minutes_spent_on_incident": 125.5, "minutes_spent_on_incident_in_late_hours": 20.5, "minutes_spent_on_incident_in_sleeping_hours": 15, "minutes_spent_on_incident_in_working_hours": 90 } } ], "items": { "$ref": "#/components/schemas/IncidentParticipantWorkloadV2" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/WorkloadMetadataV2" } }, "required": [ "incident_participant_workloads", "metadata" ], "type": "object" }, "IncidentsListResultV2": { "example": { "incidents": [ { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "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" }, "last_activity_at": "2021-08-17T13:28:57.801578Z", "mode": "standard", "ms_teams_channel_url": "https://teams.microsoft.com/l/channel/19%some-hex%40thread.tacv2/inc-123-title?groupId=some-uuid&tenantId=another-uuid", "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_channel_url": "https://slack.com/app_redirect?team=T1234&channel=C5678", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 } }, "properties": { "incidents": { "example": [ { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "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" }, "last_activity_at": "2021-08-17T13:28:57.801578Z", "mode": "standard", "ms_teams_channel_url": "https://teams.microsoft.com/l/channel/19%some-hex%40thread.tacv2/inc-123-title?groupId=some-uuid&tenantId=another-uuid", "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_channel_url": "https://slack.com/app_redirect?team=T1234&channel=C5678", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 } ], "items": { "$ref": "#/components/schemas/IncidentV2" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultWithTotalV2" } }, "required": [ "incidents" ], "type": "object" }, "IncidentsCreatePayloadV2": { "example": { "custom_field_entries": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] } ], "idempotency_key": "alert-uuid", "incident_role_assignments": [ { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" } ], "incident_status_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "incident_timestamp_values": [ { "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYD5H", "value": "2021-08-17T13:28:57.801578Z" } ], "incident_type_id": "01FH5TZRWMNAFB0DZ23FD1TV96", "mode": "standard", "name": "Our database is sad", "retrospective_incident_options": { "external_id": 123, "postmortem_document_url": "https://docs.google.com/my_doc_id", "slack_channel_id": "abc123" }, "severity_id": "01FH5TZRWMNAFB0DZ23FD1TV96", "slack_channel_name_override": "inc-123-database-down", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" }, "properties": { "custom_field_entries": { "description": "Set the incident's custom fields to these values", "example": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] } ], "items": { "$ref": "#/components/schemas/CustomFieldEntryPayloadV2" }, "type": "array" }, "idempotency_key": { "description": "Unique string used to de-duplicate incident create requests", "example": "alert-uuid", "type": "string" }, "incident_role_assignments": { "description": "Assign incident roles to these people", "example": [ { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" } ], "items": { "$ref": "#/components/schemas/IncidentRoleAssignmentPayloadV2" }, "type": "array" }, "incident_status_id": { "description": "Incident status to assign to the incident", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "incident_timestamp_values": { "description": "Assign the incident's timestamps to these values", "example": [ { "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYD5H", "value": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/IncidentTimestampValuePayloadV2" }, "type": "array" }, "incident_type_id": { "description": "Incident type to create this incident as", "example": "01FH5TZRWMNAFB0DZ23FD1TV96", "type": "string" }, "mode": { "description": "Whether the incident is real, a test, a tutorial, or importing as a retrospective incident", "enum": [ "standard", "retrospective", "test", "tutorial" ], "example": "standard", "type": "string" }, "name": { "description": "Explanation of the incident", "example": "Our database is sad", "type": "string" }, "retrospective_incident_options": { "$ref": "#/components/schemas/RetrospectiveIncidentOptionsV2" }, "severity_id": { "description": "Severity to create incident as", "example": "01FH5TZRWMNAFB0DZ23FD1TV96", "type": "string" }, "slack_channel_name_override": { "description": "Name of the Slack channel to create for this incident", "example": "inc-123-database-down", "type": "string" }, "slack_team_id": { "description": "Slack Team to create the incident in", "example": "T02A1FSLE8J", "type": "string" }, "summary": { "description": "Detailed description of the incident", "example": "Our database is really really sad, and we don't know why yet.", "type": "string" }, "visibility": { "description": "Whether the incident should be open to anyone in your Slack workspace (public), or invite-only (private). For more information on Private Incidents see our [docs](https://docs.incident.io/incidents/sensitive-incidents).", "enum": [ "public", "private" ], "example": "public", "type": "string" } }, "required": [ "idempotency_key", "visibility" ], "type": "object" }, "IncidentsCreateResultV2": { "example": { "incident": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "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" }, "last_activity_at": "2021-08-17T13:28:57.801578Z", "mode": "standard", "ms_teams_channel_url": "https://teams.microsoft.com/l/channel/19%some-hex%40thread.tacv2/inc-123-title?groupId=some-uuid&tenantId=another-uuid", "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_channel_url": "https://slack.com/app_redirect?team=T1234&channel=C5678", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 } }, "properties": { "incident": { "$ref": "#/components/schemas/IncidentV2" } }, "required": [ "incident" ], "type": "object" }, "IncidentsShowResultV2": { "example": { "incident": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "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" }, "last_activity_at": "2021-08-17T13:28:57.801578Z", "mode": "standard", "ms_teams_channel_url": "https://teams.microsoft.com/l/channel/19%some-hex%40thread.tacv2/inc-123-title?groupId=some-uuid&tenantId=another-uuid", "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_channel_url": "https://slack.com/app_redirect?team=T1234&channel=C5678", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 } }, "properties": { "incident": { "$ref": "#/components/schemas/IncidentV2" } }, "required": [ "incident" ], "type": "object" }, "IncidentsEditPayloadV2": { "example": { "incident": { "call_url": "https://zoom.us/foo", "custom_field_entries": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] } ], "incident_role_assignments": [ { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" } ], "incident_status_id": "abc123", "incident_timestamp_values": [ { "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYD5H", "value": "2021-08-17T13:28:57.801578Z" } ], "name": "Our database is sad", "severity_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_channel_name_override": "inc-123-database-down", "summary": "Our database is really really sad, and we don't know why yet." }, "notify_incident_channel": true }, "properties": { "incident": { "$ref": "#/components/schemas/IncidentEditPayloadV2" }, "notify_incident_channel": { "description": "Should we send Slack channel notifications to inform responders of this update? Note that this won't work if the Slack channel has already been archived.", "example": true, "type": "boolean" } }, "required": [ "incident", "notify_incident_channel" ], "type": "object" }, "IncidentsEditResultV2": { "example": { "incident": { "call_url": "https://zoom.us/foo", "created_at": "2021-08-17T13:28:57.801578Z", "creator": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "custom_field_entries": [ { "custom_field": { "description": "Which team is impacted by this issue", "field_type": "single_select", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Affected Team", "options": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" } ] }, "values": [ { "value_catalog_entry": { "aliases": [ "lawrence@incident.io", "lawrence" ], "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "value_link": "https://google.com/", "value_numeric": "123.456", "value_option": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "sort_key": 10, "value": "Product" }, "value_text": "This is my text field, I hope you like it" } ] } ], "duration_metrics": [ { "duration_metric": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Lasted" }, "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" }, "last_activity_at": "2021-08-17T13:28:57.801578Z", "mode": "standard", "ms_teams_channel_url": "https://teams.microsoft.com/l/channel/19%some-hex%40thread.tacv2/inc-123-title?groupId=some-uuid&tenantId=another-uuid", "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_channel_url": "https://slack.com/app_redirect?team=T1234&channel=C5678", "slack_team_id": "T02A1FSLE8J", "summary": "Our database is really really sad, and we don't know why yet.", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "updated_at": "2021-08-17T13:28:57.801578Z", "visibility": "public", "workload_minutes_late": 40.7, "workload_minutes_sleeping": 0, "workload_minutes_total": 60.7, "workload_minutes_working": 20 } }, "properties": { "incident": { "$ref": "#/components/schemas/IncidentV2" } }, "required": [ "incident" ], "type": "object" }, "IncidentsImportPostmortemDocumentPayloadV2": { "example": { "content": "## Summary\n\nA database migration caused increased latency...", "title": "INC-123: Post-incident review" }, "properties": { "content": { "description": "The document content as GitHub-Flavored Markdown", "example": "## Summary\n\nA database migration caused increased latency...", "type": "string" }, "title": { "description": "Title of the postmortem document", "example": "INC-123: Post-incident review", "type": "string" } }, "required": [ "title", "content" ], "type": "object" }, "IncidentsImportPostmortemDocumentResultV2": { "example": { "postmortem_document": { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" } }, "properties": { "postmortem_document": { "$ref": "#/components/schemas/PostmortemDocumentV1" } }, "required": [ "postmortem_document" ], "type": "object" }, "IPAllowlistsShowIPAllowlistResultV1": { "example": { "ip_allowlist": { "allowlist": [ { "label": "London HQ", "value": "192.0.2.0" } ], "enabled": true, "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "properties": { "ip_allowlist": { "$ref": "#/components/schemas/IPAllowlistV1" } }, "required": [ "ip_allowlist" ], "type": "object" }, "IPAllowlistsUpdateIPAllowlistPayloadV1": { "example": { "allowlist": [ { "label": "London HQ", "value": "192.0.2.0" } ], "enabled": true, "version": 1 }, "properties": { "allowlist": { "description": "A list of IP addresses or CIDR prefixes to allow", "example": [ { "label": "London HQ", "value": "192.0.2.0" } ], "items": { "$ref": "#/components/schemas/IPAllowlistItemV1" }, "type": "array" }, "enabled": { "description": "Whether this IP allowlist is enabled or not", "example": true, "type": "boolean" }, "version": { "description": "The version of this IP allowlist", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "version", "enabled", "allowlist" ], "type": "object" }, "IPAllowlistsUpdateIPAllowlistResultV1": { "example": { "ip_allowlist": { "allowlist": [ { "label": "London HQ", "value": "192.0.2.0" } ], "enabled": true, "updated_at": "2021-08-17T13:28:57.801578Z", "version": 1 } }, "properties": { "ip_allowlist": { "$ref": "#/components/schemas/IPAllowlistV1" } }, "required": [ "ip_allowlist" ], "type": "object" }, "MaintenanceWindowsListResultV1": { "example": { "maintenance_windows": [ { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "maintenance_windows": { "example": [ { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/MaintenanceWindowV1" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV1" } }, "required": [ "maintenance_windows", "pagination_meta" ], "type": "object" }, "MaintenanceWindowsCreatePayloadV1": { "example": { "alert_condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public" } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "alert_condition_groups": { "description": "Condition groups that determine which alerts this maintenance window applies to", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" }, "end_at": { "description": "When the maintenance window should end", "example": "2021-08-17T14:28:57.801578Z", "format": "date-time", "type": "string" }, "escalation_targets": { "description": "If set, alerts matching this window will be escalated to these targets", "example": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/MaintenanceWindowEscalationTargetPayloadV1" }, "type": "array" }, "incident_id": { "description": "If set, alerts matching this window will be automatically attached to this incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "lead": { "$ref": "#/components/schemas/UserReferencePayloadV2" }, "name": { "description": "Human readable name for the maintenance window", "example": "Planned database migration", "type": "string" }, "notification_message": { "description": "Custom message included in notifications about this maintenance window", "example": "Scheduled downtime for database migration", "type": "string" }, "notify_channels": { "description": "Channels to notify about the maintenance window starting and ending", "example": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public" } ], "items": { "$ref": "#/components/schemas/MaintenanceWindowNotifyChannelPayloadV1" }, "type": "array" }, "notify_end_minutes_before": { "description": "Minutes before the end to send a notification to the configured channels", "example": 5, "format": "int64", "type": "integer" }, "notify_start_minutes_before": { "description": "Minutes before the start to send a notification to the configured channels", "example": 15, "format": "int64", "type": "integer" }, "reroute_on_end": { "description": "Whether to retrigger firing alerts through alert routing when the window ends", "example": false, "type": "boolean" }, "resolve_on_end": { "description": "Whether to automatically resolve all firing alerts that matched this window when it ends", "example": false, "type": "boolean" }, "show_in_sidebar": { "description": "Whether to show this maintenance window in the dashboard sidebar when active", "example": true, "type": "boolean" }, "start_at": { "description": "When the maintenance window should start", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "name", "lead", "start_at", "end_at", "alert_condition_groups", "show_in_sidebar" ], "type": "object" }, "MaintenanceWindowsCreateResultV1": { "example": { "maintenance_window": { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "maintenance_window": { "$ref": "#/components/schemas/MaintenanceWindowV1" } }, "required": [ "maintenance_window" ], "type": "object" }, "MaintenanceWindowsShowResultV1": { "example": { "maintenance_window": { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "maintenance_window": { "$ref": "#/components/schemas/MaintenanceWindowV1" } }, "required": [ "maintenance_window" ], "type": "object" }, "MaintenanceWindowsUpdatePayloadV1": { "example": { "alert_condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public" } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "alert_condition_groups": { "description": "Condition groups that determine which alerts this maintenance window applies to", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" }, "end_at": { "description": "When the maintenance window should end", "example": "2021-08-17T14:28:57.801578Z", "format": "date-time", "type": "string" }, "escalation_targets": { "description": "If set, alerts matching this window will be escalated to these targets", "example": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/MaintenanceWindowEscalationTargetPayloadV1" }, "type": "array" }, "incident_id": { "description": "If set, alerts matching this window will be automatically attached to this incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "lead": { "$ref": "#/components/schemas/UserReferencePayloadV2" }, "name": { "description": "Human readable name for the maintenance window", "example": "Planned database migration", "type": "string" }, "notification_message": { "description": "Custom message included in notifications about this maintenance window", "example": "Scheduled downtime for database migration", "type": "string" }, "notify_channels": { "description": "Channels to notify about the maintenance window starting and ending", "example": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public" } ], "items": { "$ref": "#/components/schemas/MaintenanceWindowNotifyChannelPayloadV1" }, "type": "array" }, "notify_end_minutes_before": { "description": "Minutes before the end to send a notification to the configured channels", "example": 5, "format": "int64", "type": "integer" }, "notify_start_minutes_before": { "description": "Minutes before the start to send a notification to the configured channels", "example": 15, "format": "int64", "type": "integer" }, "reroute_on_end": { "description": "Whether to retrigger firing alerts through alert routing when the window ends", "example": false, "type": "boolean" }, "resolve_on_end": { "description": "Whether to automatically resolve all firing alerts that matched this window when it ends", "example": false, "type": "boolean" }, "show_in_sidebar": { "description": "Whether to show this maintenance window in the dashboard sidebar when active", "example": true, "type": "boolean" }, "start_at": { "description": "When the maintenance window should start", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "name", "lead", "start_at", "end_at", "alert_condition_groups", "show_in_sidebar" ], "type": "object" }, "MaintenanceWindowsUpdateResultV1": { "example": { "maintenance_window": { "alert_condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "archived_at": "2021-08-17T13:28:57.801578Z", "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T14:28:57.801578Z", "escalation_targets": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0", "lead": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } }, "name": "Planned database migration", "notification_message": "Scheduled downtime for database migration", "notify_channels": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "notify_end_minutes_before": 5, "notify_start_minutes_before": 15, "reroute_on_end": false, "resolve_on_end": false, "show_in_sidebar": true, "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "maintenance_window": { "$ref": "#/components/schemas/MaintenanceWindowV1" } }, "required": [ "maintenance_window" ], "type": "object" }, "PoliciesListResultV2": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "policies": [ { "assignment_rules": { "bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "reminder_cadence_after": { "interval": "daily" }, "reminder_cadence_before": { "interval": "daily" }, "reminder_detected_date_offset_hours": [ 0, 48 ], "reminder_due_date_offset_hours": [ -24, 0, 24 ] }, "conditions": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "debrief": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "description": "All critical incidents must export follow-ups to an external issue tracker before 7 days has passed since closure.", "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "follow_up": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Critical incidents must export follow-ups", "on_call_readiness": { "enforcement": "advisory", "high_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ] }, "policy_type": "follow_up", "post_mortem": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "schedule": { "evaluation_level": "schedule", "requirement_type": "contiguous" }, "status": "enabled", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" }, "policies": { "example": [ { "assignment_rules": { "bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "reminder_cadence_after": { "interval": "daily" }, "reminder_cadence_before": { "interval": "daily" }, "reminder_detected_date_offset_hours": [ 0, 48 ], "reminder_due_date_offset_hours": [ -24, 0, 24 ] }, "conditions": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "debrief": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "description": "All critical incidents must export follow-ups to an external issue tracker before 7 days has passed since closure.", "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "follow_up": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Critical incidents must export follow-ups", "on_call_readiness": { "enforcement": "advisory", "high_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ] }, "policy_type": "follow_up", "post_mortem": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "schedule": { "evaluation_level": "schedule", "requirement_type": "contiguous" }, "status": "enabled", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/PolicyV2" }, "type": "array" } }, "required": [ "policies", "pagination_meta" ], "type": "object" }, "PoliciesCreatePayloadV2": { "example": { "assignment_rules": { "bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "reminder_cadence_after": { "interval": "daily" }, "reminder_cadence_before": { "interval": "daily" }, "reminder_detected_date_offset_hours": [ 0, 48 ], "reminder_due_date_offset_hours": [ -24, 0, 24 ] }, "conditions": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "debrief": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "run_on_private_incidents": false }, "description": "All critical incidents must export follow-ups to an external issue tracker before 7 days has passed since closure.", "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "follow_up": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "run_on_private_incidents": false }, "name": "Critical incidents must export follow-ups", "on_call_readiness": { "enforcement": "advisory", "high_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ] }, "policy_type": "follow_up", "post_mortem": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "run_on_private_incidents": false }, "schedule": { "evaluation_level": "schedule", "requirement_type": "contiguous" }, "status": "enabled" }, "properties": { "assignment_rules": { "$ref": "#/components/schemas/PolicyAssignmentRulesPayloadV2" }, "conditions": { "description": "Conditions which determine which resources are in scope for this policy", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" }, "debrief": { "$ref": "#/components/schemas/PolicyDebriefPayloadV2" }, "description": { "description": "Human readable description of the policy", "example": "All critical incidents must export follow-ups to an external issue tracker before 7 days has passed since closure.", "type": "string" }, "expressions": { "description": "The expressions to use in this policy", "example": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionPayloadV2" }, "type": "array" }, "follow_up": { "$ref": "#/components/schemas/PolicyFollowUpPayloadV2" }, "name": { "description": "Human readable name of the policy", "example": "Critical incidents must export follow-ups", "type": "string" }, "on_call_readiness": { "$ref": "#/components/schemas/PolicyOnCallReadinessV2" }, "policy_type": { "description": "Type of the policy, specifying what this applies to. Cannot be changed after the policy is created.", "enum": [ "debrief", "follow_up", "on_call_readiness", "post_mortem", "schedule", "vacation_conflict" ], "example": "follow_up", "type": "string" }, "post_mortem": { "$ref": "#/components/schemas/PolicyPostMortemPayloadV2" }, "schedule": { "$ref": "#/components/schemas/PolicyScheduleV2" }, "status": { "description": "Defaults to enabled on create. Settable on update — there is no separate disable endpoint.", "enum": [ "enabled", "disabled" ], "example": "enabled", "type": "string" } }, "required": [ "name", "description", "policy_type", "conditions" ], "type": "object" }, "PoliciesCreateResultV2": { "example": { "policy": { "assignment_rules": { "bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "reminder_cadence_after": { "interval": "daily" }, "reminder_cadence_before": { "interval": "daily" }, "reminder_detected_date_offset_hours": [ 0, 48 ], "reminder_due_date_offset_hours": [ -24, 0, 24 ] }, "conditions": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "debrief": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "description": "All critical incidents must export follow-ups to an external issue tracker before 7 days has passed since closure.", "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "follow_up": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Critical incidents must export follow-ups", "on_call_readiness": { "enforcement": "advisory", "high_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ] }, "policy_type": "follow_up", "post_mortem": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "schedule": { "evaluation_level": "schedule", "requirement_type": "contiguous" }, "status": "enabled", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "policy": { "$ref": "#/components/schemas/PolicyV2" } }, "required": [ "policy" ], "type": "object" }, "PoliciesShowResultV2": { "example": { "policy": { "assignment_rules": { "bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "reminder_cadence_after": { "interval": "daily" }, "reminder_cadence_before": { "interval": "daily" }, "reminder_detected_date_offset_hours": [ 0, 48 ], "reminder_due_date_offset_hours": [ -24, 0, 24 ] }, "conditions": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "debrief": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "description": "All critical incidents must export follow-ups to an external issue tracker before 7 days has passed since closure.", "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "follow_up": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Critical incidents must export follow-ups", "on_call_readiness": { "enforcement": "advisory", "high_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ] }, "policy_type": "follow_up", "post_mortem": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "schedule": { "evaluation_level": "schedule", "requirement_type": "contiguous" }, "status": "enabled", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "policy": { "$ref": "#/components/schemas/PolicyV2" } }, "required": [ "policy" ], "type": "object" }, "PoliciesUpdatePayloadV2": { "example": { "assignment_rules": { "bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "reminder_cadence_after": { "interval": "daily" }, "reminder_cadence_before": { "interval": "daily" }, "reminder_detected_date_offset_hours": [ 0, 48 ], "reminder_due_date_offset_hours": [ -24, 0, 24 ] }, "conditions": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "debrief": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "run_on_private_incidents": false }, "description": "All critical incidents must export follow-ups to an external issue tracker before 7 days has passed since closure.", "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "follow_up": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "run_on_private_incidents": false }, "name": "Critical incidents must export follow-ups", "on_call_readiness": { "enforcement": "advisory", "high_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ] }, "policy_type": "follow_up", "post_mortem": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "run_on_private_incidents": false }, "schedule": { "evaluation_level": "schedule", "requirement_type": "contiguous" }, "status": "enabled" }, "properties": { "assignment_rules": { "$ref": "#/components/schemas/PolicyAssignmentRulesPayloadV2" }, "conditions": { "description": "Conditions which determine which resources are in scope for this policy", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" }, "debrief": { "$ref": "#/components/schemas/PolicyDebriefPayloadV2" }, "description": { "description": "Human readable description of the policy", "example": "All critical incidents must export follow-ups to an external issue tracker before 7 days has passed since closure.", "type": "string" }, "expressions": { "description": "The expressions to use in this policy", "example": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionPayloadV2" }, "type": "array" }, "follow_up": { "$ref": "#/components/schemas/PolicyFollowUpPayloadV2" }, "name": { "description": "Human readable name of the policy", "example": "Critical incidents must export follow-ups", "type": "string" }, "on_call_readiness": { "$ref": "#/components/schemas/PolicyOnCallReadinessV2" }, "policy_type": { "description": "Type of the policy, specifying what this applies to. Cannot be changed after the policy is created.", "enum": [ "debrief", "follow_up", "on_call_readiness", "post_mortem", "schedule", "vacation_conflict" ], "example": "follow_up", "type": "string" }, "post_mortem": { "$ref": "#/components/schemas/PolicyPostMortemPayloadV2" }, "schedule": { "$ref": "#/components/schemas/PolicyScheduleV2" }, "status": { "description": "Defaults to enabled on create. Settable on update — there is no separate disable endpoint.", "enum": [ "enabled", "disabled" ], "example": "enabled", "type": "string" } }, "required": [ "name", "description", "policy_type", "conditions" ], "type": "object" }, "PoliciesUpdateResultV2": { "example": { "policy": { "assignment_rules": { "bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "reminder_cadence_after": { "interval": "daily" }, "reminder_cadence_before": { "interval": "daily" }, "reminder_detected_date_offset_hours": [ 0, 48 ], "reminder_due_date_offset_hours": [ -24, 0, 24 ] }, "conditions": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "created_at": "2021-08-17T13:28:57.801578Z", "debrief": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "description": "All critical incidents must export follow-ups to an external issue tracker before 7 days has passed since closure.", "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "follow_up": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Critical incidents must export follow-ups", "on_call_readiness": { "enforcement": "advisory", "high_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ] }, "policy_type": "follow_up", "post_mortem": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "schedule": { "evaluation_level": "schedule", "requirement_type": "contiguous" }, "status": "enabled", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "policy": { "$ref": "#/components/schemas/PolicyV2" } }, "required": [ "policy" ], "type": "object" }, "PolicyFindingsListResultV2": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "policy_findings": [ { "created_at": "2021-08-17T13:28:57.801578Z", "days": 3, "debrief": { "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "dismissal": { "dismissed_at": "2021-08-17T13:28:57.801578Z", "dismissed_by": { "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" } }, "reason": "This incident is special." }, "due_at": "2025-10-14T00:00:00.000000Z", "follow_up": { "follow_up_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_checked_at": "2021-08-17T13:28:57.801578Z", "on_call_readiness": { "high_urgency": [ { "max_delay_seconds": 300, "met": false, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "met": false, "method_types": [ "slack" ] } ], "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "policy_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "policy_type": "follow_up", "post_mortem": { "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "responsible_users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "schedule": { "cause": "nobody_scheduled", "end_at": "2021-08-17T13:28:57.801578Z", "has_unscheduled_time": true, "impacted_users": [ { "cause": "no_on_call_seat", "name": "Alice Green", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" } ], "rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0", "start_at": "2021-08-17T13:28:57.801578Z" }, "state": "active", "updated_at": "2021-08-17T13:28:57.801578Z", "vacation_conflict": { "end_at": "2021-08-17T13:28:57.801578Z", "holiday_name": "Joe Bloggs - Holiday", "rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0", "start_at": "2021-08-17T13:28:57.801578Z", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" } } ] }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" }, "policy_findings": { "example": [ { "created_at": "2021-08-17T13:28:57.801578Z", "days": 3, "debrief": { "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "dismissal": { "dismissed_at": "2021-08-17T13:28:57.801578Z", "dismissed_by": { "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" } }, "reason": "This incident is special." }, "due_at": "2025-10-14T00:00:00.000000Z", "follow_up": { "follow_up_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_checked_at": "2021-08-17T13:28:57.801578Z", "on_call_readiness": { "high_urgency": [ { "max_delay_seconds": 300, "met": false, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "met": false, "method_types": [ "slack" ] } ], "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "policy_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "policy_type": "follow_up", "post_mortem": { "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "responsible_users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "schedule": { "cause": "nobody_scheduled", "end_at": "2021-08-17T13:28:57.801578Z", "has_unscheduled_time": true, "impacted_users": [ { "cause": "no_on_call_seat", "name": "Alice Green", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" } ], "rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0", "start_at": "2021-08-17T13:28:57.801578Z" }, "state": "active", "updated_at": "2021-08-17T13:28:57.801578Z", "vacation_conflict": { "end_at": "2021-08-17T13:28:57.801578Z", "holiday_name": "Joe Bloggs - Holiday", "rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0", "start_at": "2021-08-17T13:28:57.801578Z", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" } } ], "items": { "$ref": "#/components/schemas/PolicyFindingV2" }, "type": "array" } }, "required": [ "policy_findings", "pagination_meta" ], "type": "object" }, "PolicyFindingsShowResultV2": { "example": { "policy_finding": { "created_at": "2021-08-17T13:28:57.801578Z", "days": 3, "debrief": { "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "dismissal": { "dismissed_at": "2021-08-17T13:28:57.801578Z", "dismissed_by": { "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" } }, "reason": "This incident is special." }, "due_at": "2025-10-14T00:00:00.000000Z", "follow_up": { "follow_up_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_checked_at": "2021-08-17T13:28:57.801578Z", "on_call_readiness": { "high_urgency": [ { "max_delay_seconds": 300, "met": false, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "met": false, "method_types": [ "slack" ] } ], "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "policy_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "policy_type": "follow_up", "post_mortem": { "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "responsible_users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "schedule": { "cause": "nobody_scheduled", "end_at": "2021-08-17T13:28:57.801578Z", "has_unscheduled_time": true, "impacted_users": [ { "cause": "no_on_call_seat", "name": "Alice Green", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" } ], "rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0", "start_at": "2021-08-17T13:28:57.801578Z" }, "state": "active", "updated_at": "2021-08-17T13:28:57.801578Z", "vacation_conflict": { "end_at": "2021-08-17T13:28:57.801578Z", "holiday_name": "Joe Bloggs - Holiday", "rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0", "start_at": "2021-08-17T13:28:57.801578Z", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" } } }, "properties": { "policy_finding": { "$ref": "#/components/schemas/PolicyFindingV2" } }, "required": [ "policy_finding" ], "type": "object" }, "PolicyFindingsDismissPayloadV2": { "example": { "reason": "This incident is special." }, "properties": { "reason": { "description": "Why this finding is being dismissed", "example": "This incident is special.", "maxLength": 1000, "type": "string" } }, "required": [ "reason" ], "type": "object" }, "PolicyFindingsDismissResultV2": { "example": { "policy_finding": { "created_at": "2021-08-17T13:28:57.801578Z", "days": 3, "debrief": { "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "dismissal": { "dismissed_at": "2021-08-17T13:28:57.801578Z", "dismissed_by": { "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" } }, "reason": "This incident is special." }, "due_at": "2025-10-14T00:00:00.000000Z", "follow_up": { "follow_up_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_checked_at": "2021-08-17T13:28:57.801578Z", "on_call_readiness": { "high_urgency": [ { "max_delay_seconds": 300, "met": false, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "met": false, "method_types": [ "slack" ] } ], "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "policy_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "policy_type": "follow_up", "post_mortem": { "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "responsible_users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "schedule": { "cause": "nobody_scheduled", "end_at": "2021-08-17T13:28:57.801578Z", "has_unscheduled_time": true, "impacted_users": [ { "cause": "no_on_call_seat", "name": "Alice Green", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" } ], "rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0", "start_at": "2021-08-17T13:28:57.801578Z" }, "state": "active", "updated_at": "2021-08-17T13:28:57.801578Z", "vacation_conflict": { "end_at": "2021-08-17T13:28:57.801578Z", "holiday_name": "Joe Bloggs - Holiday", "rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0", "start_at": "2021-08-17T13:28:57.801578Z", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" } } }, "properties": { "policy_finding": { "$ref": "#/components/schemas/PolicyFindingV2" } }, "required": [ "policy_finding" ], "type": "object" }, "PolicyFindingsRestoreResultV2": { "example": { "policy_finding": { "created_at": "2021-08-17T13:28:57.801578Z", "days": 3, "debrief": { "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "dismissal": { "dismissed_at": "2021-08-17T13:28:57.801578Z", "dismissed_by": { "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" } }, "reason": "This incident is special." }, "due_at": "2025-10-14T00:00:00.000000Z", "follow_up": { "follow_up_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_checked_at": "2021-08-17T13:28:57.801578Z", "on_call_readiness": { "high_urgency": [ { "max_delay_seconds": 300, "met": false, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "met": false, "method_types": [ "slack" ] } ], "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "policy_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "policy_type": "follow_up", "post_mortem": { "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "responsible_users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "schedule": { "cause": "nobody_scheduled", "end_at": "2021-08-17T13:28:57.801578Z", "has_unscheduled_time": true, "impacted_users": [ { "cause": "no_on_call_seat", "name": "Alice Green", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" } ], "rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0", "start_at": "2021-08-17T13:28:57.801578Z" }, "state": "active", "updated_at": "2021-08-17T13:28:57.801578Z", "vacation_conflict": { "end_at": "2021-08-17T13:28:57.801578Z", "holiday_name": "Joe Bloggs - Holiday", "rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0", "start_at": "2021-08-17T13:28:57.801578Z", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" } } }, "properties": { "policy_finding": { "$ref": "#/components/schemas/PolicyFindingV2" } }, "required": [ "policy_finding" ], "type": "object" }, "PostmortemDocumentsListResultV1": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "postmortem_documents": [ { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" } ] }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV1" }, "postmortem_documents": { "example": [ { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" } ], "items": { "$ref": "#/components/schemas/PostmortemDocumentV1" }, "type": "array" } }, "required": [ "postmortem_documents", "pagination_meta" ], "type": "object" }, "PostmortemDocumentsShowResultV1": { "example": { "postmortem_document": { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" } }, "properties": { "postmortem_document": { "$ref": "#/components/schemas/PostmortemDocumentV1" } }, "required": [ "postmortem_document" ], "type": "object" }, "PostmortemDocumentsUpdateStatusPayloadV1": { "example": { "status": "completed" }, "properties": { "status": { "description": "The new status to set the post-mortem document to", "enum": [ "in_progress", "in_review", "completed" ], "example": "completed", "type": "string" } }, "required": [ "status" ], "type": "object" }, "PostmortemDocumentsUpdateStatusResultV1": { "example": { "postmortem_document": { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" } }, "properties": { "postmortem_document": { "$ref": "#/components/schemas/PostmortemDocumentV1" } }, "required": [ "postmortem_document" ], "type": "object" }, "PostmortemDocumentsShowContentResultV1": { "example": { "markdown": "# Incident Postmortem\n\n## Summary\n\nThis incident was investigated by Alice Smith and affected the API Gateway service.\n\n## Timeline\n\n### 2024-06-15 (UTC)\n\n* [10:30] **Alert fired**\n\n* [10:35] **Incident declared**\n\n## Follow-ups\n\n* **Add monitoring** - Assignee: Alice Smith\n" }, "properties": { "markdown": { "description": "The full content of the post-mortem document, rendered as markdown. Includes all sections, resolved mentions, timeline, follow-ups, and custom fields.", "example": "# Incident Postmortem\n\n## Summary\n\nThis incident was investigated by Alice Smith and affected the API Gateway service.\n\n## Timeline\n\n### 2024-06-15 (UTC)\n\n* [10:30] **Alert fired**\n\n* [10:35] **Incident declared**\n\n## Follow-ups\n\n* **Add monitoring** - Assignee: Alice Smith\n", "type": "string" } }, "required": [ "markdown" ], "type": "object" }, "PostmortemDocumentsAttachPayloadV1": { "example": { "document_provider": "notion", "incident_id": "01FCNDV6P870EA6S7TK1DSYD5H", "permalink": "https://www.notion.so/INC-123-database-is-sad" }, "properties": { "document_provider": { "description": "The provider hosting the document. Set this when it can't be inferred from the permalink so the link renders correctly.", "enum": [ "", "confluence", "google_docs", "notion", "sharepoint", "incident_io", "copy_paste_basecamp", "copy_paste_confluence", "copy_paste_github_wiki", "copy_paste_google_docs", "copy_paste_notion", "copy_paste_quip" ], "example": "notion", "type": "string" }, "incident_id": { "description": "The unique identifier of the incident to attach the post-mortem document to", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "permalink": { "description": "A URL pointing to the externally-hosted post-mortem document", "example": "https://www.notion.so/INC-123-database-is-sad", "type": "string" } }, "required": [ "incident_id", "permalink" ], "type": "object" }, "PostmortemDocumentsAttachResultV1": { "example": { "postmortem_document": { "created_at": "2021-08-17T13:28:57.801578Z", "document_url": "https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9", "editors": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } ], "exported_urls": [ "https://www.notion.so/INC-123-sad-database", "https://docs.google.com/document/d/1234" ], "id": "01GDZEW57FDA1K4S63MGMQ5DS9", "incident_id": "01GBA8J19SMXQWPJMX3P2ESCVG", "status": "in_progress", "title": "INC-123: Database is sad", "type": "in_app", "updated_at": "abc123" } }, "properties": { "postmortem_document": { "$ref": "#/components/schemas/PostmortemDocumentV1" } }, "required": [ "postmortem_document" ], "type": "object" }, "ScheduleSyncTargetsListResultV2": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "schedule_sync_targets": [ { "add_bot_to_group": true, "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000AB", "linked_schedules": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ] } ], "slack_team_id": "T02A1AZHG3J", "slack_user_group_id": "S06MNNU5BMK", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" }, "schedule_sync_targets": { "example": [ { "add_bot_to_group": true, "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000AB", "linked_schedules": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ] } ], "slack_team_id": "T02A1AZHG3J", "slack_user_group_id": "S06MNNU5BMK", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/ScheduleSyncTargetResourceV2" }, "type": "array" } }, "required": [ "schedule_sync_targets" ], "type": "object" }, "ScheduleSyncTargetsCreatePayloadV2": { "example": { "schedule_sync_target": { "add_bot_to_group": true, "annotations": { "incident.io/terraform/version": "3.0.0" }, "new_slack_user_group": { "description": "The team responsible for Project A", "handle": "project-team-a", "name": "Project Team A", "slack_team_id": "T01234567" }, "slack_user_group_id": "S06MNNU5BMK" } }, "properties": { "schedule_sync_target": { "$ref": "#/components/schemas/ScheduleSyncTargetCreatePayloadV2" } }, "required": [ "schedule_sync_target" ], "type": "object" }, "ScheduleSyncTargetsCreateResultV2": { "example": { "schedule_sync_target": { "add_bot_to_group": true, "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000AB", "linked_schedules": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ] } ], "slack_team_id": "T02A1AZHG3J", "slack_user_group_id": "S06MNNU5BMK", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "schedule_sync_target": { "$ref": "#/components/schemas/ScheduleSyncTargetResourceV2" } }, "required": [ "schedule_sync_target" ], "type": "object" }, "ScheduleSyncTargetsShowResultV2": { "example": { "schedule_sync_target": { "add_bot_to_group": true, "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000AB", "linked_schedules": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ] } ], "slack_team_id": "T02A1AZHG3J", "slack_user_group_id": "S06MNNU5BMK", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "schedule_sync_target": { "$ref": "#/components/schemas/ScheduleSyncTargetResourceV2" } }, "required": [ "schedule_sync_target" ], "type": "object" }, "ScheduleSyncTargetsUpdatePayloadV2": { "example": { "add_bot_to_group": true, "annotations": { "incident.io/terraform/version": "3.0.0" } }, "properties": { "add_bot_to_group": { "description": "Whether the incident.io bot should be added to the group", "example": true, "type": "boolean" }, "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that track metadata about this resource", "example": { "incident.io/terraform/version": "3.0.0" }, "type": "object" } }, "required": [ "add_bot_to_group" ], "type": "object" }, "ScheduleSyncTargetsUpdateResultV2": { "example": { "schedule_sync_target": { "add_bot_to_group": true, "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000AB", "linked_schedules": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ] } ], "slack_team_id": "T02A1AZHG3J", "slack_user_group_id": "S06MNNU5BMK", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "schedule_sync_target": { "$ref": "#/components/schemas/ScheduleSyncTargetResourceV2" } }, "required": [ "schedule_sync_target" ], "type": "object" }, "SchedulesListScheduleEntriesResultV2": { "example": { "pagination_meta": { "after": "abc123", "after_url": "abc123" }, "schedule_entries": { "final": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "overrides": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "scheduled": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ] } }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/AfterPaginationMetaResultV2" }, "schedule_entries": { "$ref": "#/components/schemas/ScheduleEntriesListPayloadV2" } }, "required": [ "schedule_entries" ], "type": "object" }, "SchedulesListOverridesResultV2": { "example": { "overrides": [ { "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "schedule_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 } }, "properties": { "overrides": { "example": [ { "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "schedule_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "items": { "$ref": "#/components/schemas/ScheduleOverrideV2" }, "type": "array" }, "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" } }, "required": [ "overrides" ], "type": "object" }, "SchedulesCreateOverridePayloadV2": { "example": { "end_at": "2021-08-17T14:00:00.000000Z", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "schedule_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:00:00.000000Z", "user": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } }, "properties": { "end_at": { "description": "End time of the override", "example": "2021-08-17T14:00:00.000000Z", "format": "date-time", "type": "string" }, "layer_id": { "description": "The layer this override applies to", "example": "01G0J1EXE7AXZ2C93K61WBPYNH", "type": "string" }, "rotation_id": { "description": "The rotation this override applies to", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "schedule_id": { "description": "The schedule this override applies to", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "start_at": { "description": "Start time of the override", "example": "2021-08-17T13:00:00.000000Z", "format": "date-time", "type": "string" }, "user": { "$ref": "#/components/schemas/UserReferencePayloadV2" } }, "required": [ "start_at", "end_at", "schedule_id", "rotation_id", "layer_id", "user" ], "type": "object" }, "SchedulesCreateOverrideResultV2": { "example": { "override": { "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "schedule_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } }, "properties": { "override": { "$ref": "#/components/schemas/ScheduleOverrideV2" } }, "required": [ "override" ], "type": "object" }, "SchedulesShowOverrideResultV2": { "example": { "override": { "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "schedule_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } }, "properties": { "override": { "$ref": "#/components/schemas/ScheduleOverrideV2" } }, "required": [ "override" ], "type": "object" }, "SchedulesUpdateOverridePayloadV2": { "example": { "end_at": "2021-08-17T14:00:00.000000Z", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:00:00.000000Z", "user": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } }, "properties": { "end_at": { "description": "End time of the override", "example": "2021-08-17T14:00:00.000000Z", "format": "date-time", "type": "string" }, "layer_id": { "description": "The layer this override applies to", "example": "01G0J1EXE7AXZ2C93K61WBPYNH", "type": "string" }, "rotation_id": { "description": "The rotation this override applies to", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "start_at": { "description": "Start time of the override", "example": "2021-08-17T13:00:00.000000Z", "format": "date-time", "type": "string" }, "user": { "$ref": "#/components/schemas/UserReferencePayloadV2" } }, "required": [ "start_at", "end_at", "rotation_id", "layer_id", "user" ], "type": "object" }, "SchedulesUpdateOverrideResultV2": { "example": { "override": { "created_at": "2021-08-17T13:28:57.801578Z", "end_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "schedule_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "updated_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } }, "properties": { "override": { "$ref": "#/components/schemas/ScheduleOverrideV2" } }, "required": [ "override" ], "type": "object" }, "SchedulesListResultV2": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 }, "schedules": [ { "annotations": { "incident.io/terraform/version": "3.0.0" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "created_at": "2021-08-17T13:28:57.801578Z", "current_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "holidays_public_config": { "country_codes": [ "GB", "FR" ] }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "next_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "permalink": "https://app.incident.io/acme/on-call/schedules/01G0J1EXE7AXZ2C93K61WBPYEH", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultWithTotalV2" }, "schedules": { "example": [ { "annotations": { "incident.io/terraform/version": "3.0.0" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "created_at": "2021-08-17T13:28:57.801578Z", "current_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "holidays_public_config": { "country_codes": [ "GB", "FR" ] }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "next_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "permalink": "https://app.incident.io/acme/on-call/schedules/01G0J1EXE7AXZ2C93K61WBPYEH", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/ScheduleV2" }, "type": "array" } }, "required": [ "schedules" ], "type": "object" }, "SchedulesCreatePayloadV2": { "example": { "schedule": { "annotations": { "incident.io/terraform/version": "version-of-terraform" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "holidays_public_config": { "country_codes": [ "abc123" ] }, "name": "Primary On-call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "America/Los_Angeles" } }, "properties": { "schedule": { "$ref": "#/components/schemas/ScheduleCreatePayloadV2" } }, "required": [ "schedule" ], "type": "object" }, "SchedulesCreateResultV2": { "example": { "schedule": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "created_at": "2021-08-17T13:28:57.801578Z", "current_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "holidays_public_config": { "country_codes": [ "GB", "FR" ] }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "next_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "permalink": "https://app.incident.io/acme/on-call/schedules/01G0J1EXE7AXZ2C93K61WBPYEH", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "schedule": { "$ref": "#/components/schemas/ScheduleV2" } }, "required": [ "schedule" ], "type": "object" }, "SchedulesShowResultV2": { "example": { "schedule": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "created_at": "2021-08-17T13:28:57.801578Z", "current_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "holidays_public_config": { "country_codes": [ "GB", "FR" ] }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "next_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "permalink": "https://app.incident.io/acme/on-call/schedules/01G0J1EXE7AXZ2C93K61WBPYEH", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "schedule": { "$ref": "#/components/schemas/ScheduleV2" } }, "required": [ "schedule" ], "type": "object" }, "SchedulesUpdatePayloadV2": { "example": { "schedule": { "annotations": { "incident.io/terraform/version": "version-of-terraform" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "holidays_public_config": { "country_codes": [ "abc123" ] }, "name": "Primary On-call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "America/Los_Angeles" } }, "properties": { "schedule": { "$ref": "#/components/schemas/ScheduleUpdatePayloadV2" } }, "required": [ "schedule" ], "type": "object" }, "SchedulesUpdateResultV2": { "example": { "schedule": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "created_at": "2021-08-17T13:28:57.801578Z", "current_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "holidays_public_config": { "country_codes": [ "GB", "FR" ] }, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "next_shifts": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "permalink": "https://app.incident.io/acme/on-call/schedules/01G0J1EXE7AXZ2C93K61WBPYEH", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "Europe/London", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "schedule": { "$ref": "#/components/schemas/ScheduleV2" } }, "required": [ "schedule" ], "type": "object" }, "SchedulesPreviewScheduleEntriesPayloadV2": { "example": { "entry_window_end": "2021-01-08T00:00:00Z", "entry_window_start": "2021-01-01T00:00:00Z", "schedule": { "annotations": { "incident.io/terraform/version": "version-of-terraform" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "holidays_public_config": { "country_codes": [ "abc123" ] }, "name": "Primary On-call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "America/Los_Angeles" } }, "properties": { "entry_window_end": { "description": "The end of the window to preview entries for. Defaults to four weeks after entry_window_start.", "example": "2021-01-08T00:00:00Z", "format": "date-time", "type": "string" }, "entry_window_start": { "description": "The start of the window to preview entries for. Defaults to now.", "example": "2021-01-01T00:00:00Z", "format": "date-time", "type": "string" }, "schedule": { "$ref": "#/components/schemas/ScheduleUpdatePayloadV2" } }, "required": [ "schedule" ], "type": "object" }, "SchedulesPreviewScheduleEntriesResultV2": { "example": { "schedule_entries": { "final": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "overrides": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "scheduled": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ] } }, "properties": { "schedule_entries": { "$ref": "#/components/schemas/ScheduleEntriesListPayloadV2" } }, "required": [ "schedule_entries" ], "type": "object" }, "SchedulesListScheduleReplicasResultV2": { "example": { "schedule_replicas": [ { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_sync_error": "Failed to find external user for Milly", "last_synced_at": "2023-11-07T13:33:30Z", "mirror_window_days": 14, "replica_fallback_user_id": "PA7AXXN", "replica_provider": "pagerduty", "replica_provider_id": "PO8107X", "schedule_id": "01FDAG4SAP5TYPT98WGR2N7W91", "sources": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "user_statuses": [ { "external_user_id": "PJYTRGS", "user_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ] } ] }, "properties": { "schedule_replicas": { "example": [ { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_sync_error": "Failed to find external user for Milly", "last_synced_at": "2023-11-07T13:33:30Z", "mirror_window_days": 14, "replica_fallback_user_id": "PA7AXXN", "replica_provider": "pagerduty", "replica_provider_id": "PO8107X", "schedule_id": "01FDAG4SAP5TYPT98WGR2N7W91", "sources": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "user_statuses": [ { "external_user_id": "PJYTRGS", "user_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ] } ], "items": { "$ref": "#/components/schemas/ScheduleReplicaV2" }, "type": "array" } }, "required": [ "schedule_replicas" ], "type": "object" }, "SchedulesCreateScheduleReplicaPayloadV2": { "example": { "schedule_replica": { "mirror_window_days": 14, "replica_fallback_user_id": "PA7AXXN", "replica_provider": "pagerduty", "replica_provider_id": "PO8107X", "sources": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ] } }, "properties": { "schedule_replica": { "$ref": "#/components/schemas/ScheduleReplicaCreatePayloadV2" } }, "required": [ "schedule_replica" ], "type": "object" }, "SchedulesCreateScheduleReplicaResultV2": { "example": { "schedule_replica": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_sync_error": "Failed to find external user for Milly", "last_synced_at": "2023-11-07T13:33:30Z", "mirror_window_days": 14, "replica_fallback_user_id": "PA7AXXN", "replica_provider": "pagerduty", "replica_provider_id": "PO8107X", "schedule_id": "01FDAG4SAP5TYPT98WGR2N7W91", "sources": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "user_statuses": [ { "external_user_id": "PJYTRGS", "user_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ] } }, "properties": { "schedule_replica": { "$ref": "#/components/schemas/ScheduleReplicaV2" } }, "required": [ "schedule_replica" ], "type": "object" }, "SchedulesShowScheduleReplicaResultV2": { "example": { "schedule_replica": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "last_sync_error": "Failed to find external user for Milly", "last_synced_at": "2023-11-07T13:33:30Z", "mirror_window_days": 14, "replica_fallback_user_id": "PA7AXXN", "replica_provider": "pagerduty", "replica_provider_id": "PO8107X", "schedule_id": "01FDAG4SAP5TYPT98WGR2N7W91", "sources": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ], "updated_at": "2021-08-17T13:28:57.801578Z", "user_statuses": [ { "external_user_id": "PJYTRGS", "user_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ] } }, "properties": { "schedule_replica": { "$ref": "#/components/schemas/ScheduleReplicaV2" } }, "required": [ "schedule_replica" ], "type": "object" }, "SchedulesListScheduleSyncRulesResultV2": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "schedule_sync_rules": [ { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000CD", "permanent_member_user_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rotation_id": "01JXYZ000000000000000000RT", "schedule_id": "01JXYZ000000000000000000EF", "schedule_sync_target": { "add_bot_to_group": true, "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000AB", "linked_schedules": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ] } ], "slack_team_id": "T02A1AZHG3J", "slack_user_group_id": "S06MNNU5BMK", "updated_at": "2021-08-17T13:28:57.801578Z" }, "schedule_sync_target_id": "01JXYZ000000000000000000AB", "sync_type": "on_call", "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" }, "schedule_sync_rules": { "example": [ { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000CD", "permanent_member_user_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rotation_id": "01JXYZ000000000000000000RT", "schedule_id": "01JXYZ000000000000000000EF", "schedule_sync_target": { "add_bot_to_group": true, "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000AB", "linked_schedules": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ] } ], "slack_team_id": "T02A1AZHG3J", "slack_user_group_id": "S06MNNU5BMK", "updated_at": "2021-08-17T13:28:57.801578Z" }, "schedule_sync_target_id": "01JXYZ000000000000000000AB", "sync_type": "on_call", "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/ScheduleSyncRuleV2" }, "type": "array" } }, "required": [ "schedule_sync_rules" ], "type": "object" }, "SchedulesCreateScheduleSyncRulePayloadV2": { "example": { "schedule_sync_rule": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "permanent_member_user_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rotation_id": "01JXYZ000000000000000000RT", "schedule_sync_target_id": "01JXYZ000000000000000000AB", "sync_type": "on_call" } }, "properties": { "schedule_sync_rule": { "$ref": "#/components/schemas/ScheduleSyncRuleCreatePayloadV2" } }, "required": [ "schedule_sync_rule" ], "type": "object" }, "SchedulesCreateScheduleSyncRuleResultV2": { "example": { "schedule_sync_rule": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000CD", "permanent_member_user_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rotation_id": "01JXYZ000000000000000000RT", "schedule_id": "01JXYZ000000000000000000EF", "schedule_sync_target": { "add_bot_to_group": true, "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000AB", "linked_schedules": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ] } ], "slack_team_id": "T02A1AZHG3J", "slack_user_group_id": "S06MNNU5BMK", "updated_at": "2021-08-17T13:28:57.801578Z" }, "schedule_sync_target_id": "01JXYZ000000000000000000AB", "sync_type": "on_call", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "schedule_sync_rule": { "$ref": "#/components/schemas/ScheduleSyncRuleV2" } }, "required": [ "schedule_sync_rule" ], "type": "object" }, "SchedulesShowScheduleSyncRuleResultV2": { "example": { "schedule_sync_rule": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000CD", "permanent_member_user_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rotation_id": "01JXYZ000000000000000000RT", "schedule_id": "01JXYZ000000000000000000EF", "schedule_sync_target": { "add_bot_to_group": true, "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000AB", "linked_schedules": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ] } ], "slack_team_id": "T02A1AZHG3J", "slack_user_group_id": "S06MNNU5BMK", "updated_at": "2021-08-17T13:28:57.801578Z" }, "schedule_sync_target_id": "01JXYZ000000000000000000AB", "sync_type": "on_call", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "schedule_sync_rule": { "$ref": "#/components/schemas/ScheduleSyncRuleV2" } }, "required": [ "schedule_sync_rule" ], "type": "object" }, "SchedulesUpdateScheduleSyncRulePayloadV2": { "example": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "permanent_member_user_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "sync_type": "on_call" }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that track metadata about this resource", "example": { "incident.io/terraform/version": "3.0.0" }, "type": "object" }, "permanent_member_user_ids": { "description": "IDs of users to always keep in the Slack user group, regardless of who is on call. Each must be an active user in your organisation. Replaces the rule's current permanent members: pass an empty array to remove them all, or omit the field to leave them unchanged.", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "sync_type": { "description": "Which schedule members sync to the user group", "enum": [ "on_call", "all_users", "next_on_call" ], "example": "on_call", "type": "string" } }, "required": [ "sync_type" ], "type": "object" }, "SchedulesUpdateScheduleSyncRuleResultV2": { "example": { "schedule_sync_rule": { "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000CD", "permanent_member_user_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rotation_id": "01JXYZ000000000000000000RT", "schedule_id": "01JXYZ000000000000000000EF", "schedule_sync_target": { "add_bot_to_group": true, "created_at": "2021-08-17T13:28:57.801578Z", "id": "01JXYZ000000000000000000AB", "linked_schedules": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ] } ], "slack_team_id": "T02A1AZHG3J", "slack_user_group_id": "S06MNNU5BMK", "updated_at": "2021-08-17T13:28:57.801578Z" }, "schedule_sync_target_id": "01JXYZ000000000000000000AB", "sync_type": "on_call", "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "schedule_sync_rule": { "$ref": "#/components/schemas/ScheduleSyncRuleV2" } }, "required": [ "schedule_sync_rule" ], "type": "object" }, "SecretsListResultV2": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "secrets": [ { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Auth token for the PagerDuty outgoing webhook", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_four_chars": "c123", "name": "PagerDuty webhook token", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 3 } ] }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" }, "secrets": { "example": [ { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Auth token for the PagerDuty outgoing webhook", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_four_chars": "c123", "name": "PagerDuty webhook token", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 3 } ], "items": { "$ref": "#/components/schemas/SecretV2" }, "type": "array" } }, "required": [ "secrets" ], "type": "object" }, "SecretsCreatePayloadV2": { "example": { "description": "Auth token for the PagerDuty outgoing webhook", "name": "PagerDuty webhook token", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "value": "sk_live_abc123" }, "properties": { "description": { "description": "Optional description of what this secret is for", "example": "Auth token for the PagerDuty outgoing webhook", "type": "string" }, "name": { "description": "Human-readable name, unique within the organisation amongst unarchived secrets", "example": "PagerDuty webhook token", "type": "string" }, "owning_team_ids": { "description": "IDs of the teams that own this secret. When empty or omitted, the secret is owned by the whole organisation.", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "value": { "description": "The secret's plaintext value. It's stored encrypted and never returned by the API.", "example": "sk_live_abc123", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "SecretsCreateResultV2": { "example": { "secret": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Auth token for the PagerDuty outgoing webhook", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_four_chars": "c123", "name": "PagerDuty webhook token", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 3 } }, "properties": { "secret": { "$ref": "#/components/schemas/SecretV2" } }, "required": [ "secret" ], "type": "object" }, "SecretsShowResultV2": { "example": { "secret": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Auth token for the PagerDuty outgoing webhook", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_four_chars": "c123", "name": "PagerDuty webhook token", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 3 }, "versions": [ { "created_at": "2021-08-17T13:28:57.801578Z", "created_by": { "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" } }, "last_four_chars": "c123", "version": 3 } ] }, "properties": { "secret": { "$ref": "#/components/schemas/SecretV2" }, "versions": { "description": "The secret's versions, newest first", "example": [ { "created_at": "2021-08-17T13:28:57.801578Z", "created_by": { "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" } }, "last_four_chars": "c123", "version": 3 } ], "items": { "$ref": "#/components/schemas/SecretVersionV2" }, "type": "array" } }, "required": [ "secret", "versions" ], "type": "object" }, "SecretsUpdatePayloadV2": { "example": { "description": "Auth token for the PagerDuty outgoing webhook", "name": "PagerDuty webhook token", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ] }, "properties": { "description": { "description": "Optional description of what this secret is for", "example": "Auth token for the PagerDuty outgoing webhook", "type": "string" }, "name": { "description": "Human-readable name, unique within the organisation amongst unarchived secrets", "example": "PagerDuty webhook token", "type": "string" }, "owning_team_ids": { "description": "IDs of the teams that own this secret. When omitted, the existing owning teams are left unchanged.", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" } }, "required": [ "name" ], "type": "object" }, "SecretsUpdateResultV2": { "example": { "secret": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Auth token for the PagerDuty outgoing webhook", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_four_chars": "c123", "name": "PagerDuty webhook token", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 3 } }, "properties": { "secret": { "$ref": "#/components/schemas/SecretV2" } }, "required": [ "secret" ], "type": "object" }, "SecretsRotatePayloadV2": { "example": { "value": "sk_live_def456" }, "properties": { "value": { "description": "The secret's new plaintext value. It's stored encrypted and never returned by the API.", "example": "sk_live_def456", "type": "string" } }, "required": [ "value" ], "type": "object" }, "SecretsRotateResultV2": { "example": { "secret": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Auth token for the PagerDuty outgoing webhook", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "last_four_chars": "c123", "name": "PagerDuty webhook token", "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "updated_at": "2021-08-17T13:28:57.801578Z", "version": 3 } }, "properties": { "secret": { "$ref": "#/components/schemas/SecretV2" } }, "required": [ "secret" ], "type": "object" }, "SeveritiesListResultV1": { "example": { "severities": [ { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "severities": { "example": [ { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/SeverityV1" }, "type": "array" } }, "required": [ "severities" ], "type": "object" }, "SeveritiesCreatePayloadV1": { "example": { "description": "Issues with **low impact**.", "name": "Minor", "rank": 1 }, "properties": { "description": { "description": "Description of the severity", "example": "Issues with **low impact**.", "type": "string" }, "name": { "description": "Human readable name of the severity", "example": "Minor", "maxLength": 50, "type": "string" }, "rank": { "description": "Rank to help sort severities (lower numbers are less severe)", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "name", "description" ], "type": "object" }, "SeveritiesCreateResultV1": { "example": { "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "severity": { "$ref": "#/components/schemas/SeverityV1" } }, "required": [ "severity" ], "type": "object" }, "SeveritiesShowResultV1": { "example": { "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "severity": { "$ref": "#/components/schemas/SeverityV1" } }, "required": [ "severity" ], "type": "object" }, "SeveritiesUpdatePayloadV1": { "example": { "description": "Issues with **low impact**.", "name": "Minor", "rank": 1 }, "properties": { "description": { "description": "Description of the severity", "example": "Issues with **low impact**.", "type": "string" }, "name": { "description": "Human readable name of the severity", "example": "Minor", "maxLength": 50, "type": "string" }, "rank": { "description": "Rank to help sort severities (lower numbers are less severe)", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "name", "description" ], "type": "object" }, "SeveritiesUpdateResultV1": { "example": { "severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" } }, "properties": { "severity": { "$ref": "#/components/schemas/SeverityV1" } }, "required": [ "severity" ], "type": "object" }, "StatusPagesListResponseIncidentsResultV1": { "example": { "incidents": [ { "id": "01FDAG4SAH3GYPT98WGR2N7W91", "linked_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "incidents": { "example": [ { "id": "01FDAG4SAH3GYPT98WGR2N7W91", "linked_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/StatusPageLinkedResponseIncidentV1" }, "type": "array" } }, "required": [ "incidents" ], "type": "object" }, "StatusPagesCreateStatusPageIncidentUpdatePayloadV2": { "example": { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "incident_status": "investigating", "message": "The fix has been deployed and we are monitoring the situation. Some users may still experience intermittent issues.", "notify_subscribers": true, "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" }, "properties": { "component_statuses": { "description": "An array of mappings from component ID to component status. This must not be set if the status page incident status is being set to \"resolved\", as all components statuses will update to \"operational\".", "example": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "items": { "$ref": "#/components/schemas/StatusPageIncidentAffectedComponentV2" }, "type": "array" }, "incident_status": { "description": "Optional new status for this status page incident. If not provided, the status will remain unchanged. Setting to \"resolved\" will end the incident and all component statuses will update to \"operational\".", "enum": [ "investigating", "identified", "monitoring", "resolved" ], "example": "investigating", "type": "string" }, "message": { "description": "Markdown update on what's changed about this status page incident", "example": "The fix has been deployed and we are monitoring the situation. Some users may still experience intermittent issues.", "maxLength": 4096, "type": "string" }, "notify_subscribers": { "description": "Whether to notify subscribers about this incident update. This will not work if your status page has more than 1000 subscribers.", "example": true, "type": "boolean" }, "status_page_incident_id": { "description": "ID of the status page incident", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } }, "required": [ "status_page_incident_id", "message", "notify_subscribers" ], "type": "object" }, "StatusPagesCreateStatusPageIncidentUpdateResultV2": { "example": { "status_page_incident_update": { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } }, "properties": { "status_page_incident_update": { "$ref": "#/components/schemas/StatusPageIncidentUpdateV2" } }, "type": "object" }, "StatusPagesListStatusPageIncidentsResultV2": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "status_page_incidents": [ { "component_impacts": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "name": "Elevated API latency", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } ] }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" }, "status_page_incidents": { "example": [ { "component_impacts": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "name": "Elevated API latency", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } ], "items": { "$ref": "#/components/schemas/StatusPageIncidentV2" }, "type": "array" } }, "required": [ "status_page_incidents", "pagination_meta" ], "type": "object" }, "StatusPagesCreateStatusPageIncidentPayloadV2": { "example": { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "idempotency_key": "alert-12345-abcde", "incident_status": "investigating", "message": "We are currently investigating reports of elevated error rates affecting our API.", "name": "Elevated API latency", "notify_subscribers": true, "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "component_statuses": { "description": "An array of mappings from component ID to current component status", "example": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "items": { "$ref": "#/components/schemas/StatusPageIncidentAffectedComponentV2" }, "type": "array" }, "idempotency_key": { "description": "A unique key to de-duplicate requests. If you send a request with an idempotency_key that was already used, the original response will be returned.", "example": "alert-12345-abcde", "type": "string" }, "incident_status": { "description": "Current status for this status page incident", "enum": [ "investigating", "identified", "monitoring", "resolved" ], "example": "investigating", "type": "string" }, "message": { "description": "Markdown initial update on this status page incident", "example": "We are currently investigating reports of elevated error rates affecting our API.", "maxLength": 4096, "type": "string" }, "name": { "description": "A title for the incident", "example": "Elevated API latency", "maxLength": 200, "type": "string" }, "notify_subscribers": { "description": "Whether to notify subscribers about this status page incident. This will not work if your status page has more than 1000 subscribers.", "example": true, "type": "boolean" }, "status_page_id": { "description": "ID of the status page. You can find this by calling the ListStatusPages endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "status_page_id", "name", "incident_status", "idempotency_key", "message", "notify_subscribers" ], "type": "object" }, "StatusPagesCreateStatusPageIncidentResultV2": { "example": { "status_page_incident": { "component_impacts": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "name": "Elevated API latency", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "properties": { "status_page_incident": { "$ref": "#/components/schemas/StatusPageIncidentV2" } }, "type": "object" }, "StatusPagesShowStatusPageIncidentResultV2": { "example": { "status_page_incident": { "component_impacts": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "name": "Elevated API latency", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "properties": { "status_page_incident": { "$ref": "#/components/schemas/StatusPageIncidentV2" } }, "type": "object" }, "StatusPagesUpdateStatusPageIncidentPayloadV2": { "example": { "name": "Elevated API latency" }, "properties": { "name": { "description": "A title for the incident", "example": "Elevated API latency", "maxLength": 200, "type": "string" } }, "required": [ "name" ], "type": "object" }, "StatusPagesUpdateStatusPageIncidentResultV2": { "example": { "status_page_incident": { "component_impacts": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "name": "Elevated API latency", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "properties": { "status_page_incident": { "$ref": "#/components/schemas/StatusPageIncidentV2" } }, "type": "object" }, "StatusPagesCreateStatusPageMaintenanceUpdatePayloadV2": { "example": { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "maintenance_status": "maintenance_scheduled", "message": "Scheduled maintenance is underway for our database infrastructure. Some services may experience brief interruptions during this window.", "notify_subscribers": true, "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" }, "properties": { "component_statuses": { "description": "An array of mappings from component ID to component status. This must not be set if the status page maintenance window status is being set to \"maintenance_complete\", as all components statuses will update to \"operational\".", "example": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "items": { "$ref": "#/components/schemas/StatusPageMaintenanceAffectedComponentV2" }, "type": "array" }, "maintenance_status": { "description": "Optional new status for this status page maintenance window. If not provided, the status will remain unchanged. Setting to \"maintenance_complete\" will end the maintenance window and all component statuses will update to \"operational\".", "enum": [ "maintenance_scheduled", "maintenance_in_progress", "maintenance_complete" ], "example": "maintenance_scheduled", "type": "string" }, "message": { "description": "Markdown update on what's changed about this status page maintenance window", "example": "Scheduled maintenance is underway for our database infrastructure. Some services may experience brief interruptions during this window.", "maxLength": 4096, "type": "string" }, "notify_subscribers": { "description": "Whether to notify subscribers about this status page maintenance update. This will not work if your status page has more than 1000 subscribers.", "example": true, "type": "boolean" }, "status_page_maintenance_id": { "description": "ID of the status page maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } }, "required": [ "status_page_maintenance_id", "message", "notify_subscribers" ], "type": "object" }, "StatusPagesCreateStatusPageMaintenanceUpdateResultV2": { "example": { "status_page_maintenance_update": { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } }, "properties": { "status_page_maintenance_update": { "$ref": "#/components/schemas/StatusPageMaintenanceUpdateV2" } }, "type": "object" }, "StatusPagesListStatusPageMaintenancesResultV2": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "status_page_maintenances": [ { "automate_maintenance_status": true, "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } ] }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" }, "status_page_maintenances": { "example": [ { "automate_maintenance_status": true, "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } ], "items": { "$ref": "#/components/schemas/StatusPageMaintenanceV2" }, "type": "array" } }, "required": [ "status_page_maintenances", "pagination_meta" ], "type": "object" }, "StatusPagesCreateStatusPageMaintenancePayloadV2": { "example": { "affected_component_ids": [ "01FCNDV6P870EA6S7TK1DSYDG2" ], "automate_maintenance_status": true, "end_at": "2025-01-28T12:00:00Z", "idempotency_key": "maintenance-12345-abcde", "maintenance_status": "maintenance_scheduled", "message": "Planned maintenance has been scheduled to upgrade our infrastructure. We expect minimal disruption, but some features may be briefly unavailable.", "name": "Routine infrastructure upgrade", "notify_subscribers": true, "start_at": "2025-01-28T10:00:00Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "affected_component_ids": { "description": "An array of IDs of component affected by the maintenance window", "example": [ "01FCNDV6P870EA6S7TK1DSYDG2" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "automate_maintenance_status": { "description": "Whether to publish updates automatically, moving this maintenance window to in progress at start_at and to complete at end_at. Defaults to false, which means you publish those updates yourself. When notify_subscribers is true, the automated updates notify subscribers too. Publishing your own update that sets maintenance_status turns automation off.", "example": true, "type": "boolean" }, "end_at": { "description": "The time the maintenance window ends", "example": "2025-01-28T12:00:00Z", "format": "date-time", "type": "string" }, "idempotency_key": { "description": "A unique key to de-duplicate requests. If you send a request with an idempotency_key that was already used, the original response will be returned.", "example": "maintenance-12345-abcde", "type": "string" }, "maintenance_status": { "description": "Current status for this status page maintenance window", "enum": [ "maintenance_scheduled", "maintenance_in_progress", "maintenance_complete" ], "example": "maintenance_scheduled", "type": "string" }, "message": { "description": "Markdown initial update on this status page maintenance window", "example": "Planned maintenance has been scheduled to upgrade our infrastructure. We expect minimal disruption, but some features may be briefly unavailable.", "maxLength": 4096, "type": "string" }, "name": { "description": "A title for the maintenance window", "example": "Routine infrastructure upgrade", "maxLength": 200, "type": "string" }, "notify_subscribers": { "description": "Whether to notify subscribers about this status page maintenance. This will not work if your status page has more than 1000 subscribers.", "example": true, "type": "boolean" }, "start_at": { "description": "The time the maintenance window starts", "example": "2025-01-28T10:00:00Z", "format": "date-time", "type": "string" }, "status_page_id": { "description": "ID of the status page. You can find this by calling the ListStatusPages endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "status_page_id", "name", "maintenance_status", "idempotency_key", "affected_component_ids", "start_at", "end_at", "message", "notify_subscribers" ], "type": "object" }, "StatusPagesCreateStatusPageMaintenanceResultV2": { "example": { "status_page_maintenance": { "automate_maintenance_status": true, "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "properties": { "status_page_maintenance": { "$ref": "#/components/schemas/StatusPageMaintenanceV2" } }, "type": "object" }, "StatusPagesShowStatusPageMaintenanceResultV2": { "example": { "status_page_maintenance": { "automate_maintenance_status": true, "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "properties": { "status_page_maintenance": { "$ref": "#/components/schemas/StatusPageMaintenanceV2" } }, "type": "object" }, "StatusPagesUpdateStatusPageMaintenancePayloadV2": { "example": { "end_at": "2025-01-28T12:00:00Z", "name": "Routine infrastructure upgrade", "start_at": "2025-01-28T10:00:00Z" }, "properties": { "end_at": { "description": "The time the maintenance window ends", "example": "2025-01-28T12:00:00Z", "format": "date-time", "type": "string" }, "name": { "description": "A title for the maintenance window", "example": "Routine infrastructure upgrade", "maxLength": 200, "type": "string" }, "start_at": { "description": "The time the maintenance window starts", "example": "2025-01-28T10:00:00Z", "format": "date-time", "type": "string" } }, "required": [ "name", "start_at", "end_at" ], "type": "object" }, "StatusPagesUpdateStatusPageMaintenanceResultV2": { "example": { "status_page_maintenance": { "automate_maintenance_status": true, "component_maintenance_periods": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "name": "Routine infrastructure upgrade", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "properties": { "status_page_maintenance": { "$ref": "#/components/schemas/StatusPageMaintenanceV2" } }, "type": "object" }, "StatusPagesCreateStatusPageRetrospectiveIncidentPayloadV2": { "example": { "idempotency_key": "historical-incident-2021-08-17", "name": "Elevated API latency", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "incident_status": "investigating", "message": "We are currently investigating reports of elevated error rates affecting our API.", "published_at": "2021-08-17T13:28:57.801578Z" } ] }, "properties": { "idempotency_key": { "description": "A unique key to de-duplicate requests. If you send a request with an idempotency_key that was already used, the original response will be returned.", "example": "historical-incident-2021-08-17", "type": "string" }, "name": { "description": "A title for the incident", "example": "Elevated API latency", "maxLength": 200, "type": "string" }, "status_page_id": { "description": "ID of the status page. You can find this by calling the ListStatusPages endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "updates": { "description": "The reconstructed timeline of updates for this incident, ordered chronologically (earliest first). The final update must set incident_status to \"resolved\".", "example": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "incident_status": "investigating", "message": "We are currently investigating reports of elevated error rates affecting our API.", "published_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/StatusPageRetrospectiveIncidentUpdateV2" }, "type": "array" } }, "required": [ "status_page_id", "name", "idempotency_key", "updates" ], "type": "object" }, "StatusPagesCreateStatusPageRetrospectiveIncidentResultV2": { "example": { "status_page_incident": { "component_impacts": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "name": "Elevated API latency", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0", "updates": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ] } }, "properties": { "status_page_incident": { "$ref": "#/components/schemas/StatusPageIncidentV2" } }, "type": "object" }, "StatusPagesShowStatusPageStructureResultV2": { "example": { "current_structure": { "items": [ { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" }, "sub_page": { "id": "01FCNDV6P870EA6S7TK1DSYDG1", "items": [ { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" } } ], "name": "United Kingdom" } } ] } }, "properties": { "current_structure": { "$ref": "#/components/schemas/StatusPageStructureV2" } }, "required": [ "current_structure" ], "type": "object" }, "StatusPagesListStatusPagesResultV2": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "status_pages": [ { "description": "This status page is our public status page.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Our public status page", "public_url": "https://statuspage.incident.io/our-public-status-page" } ] }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" }, "status_pages": { "example": [ { "description": "This status page is our public status page.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Our public status page", "public_url": "https://statuspage.incident.io/our-public-status-page" } ], "items": { "$ref": "#/components/schemas/StatusPageV2" }, "type": "array" } }, "required": [ "status_pages", "pagination_meta" ], "type": "object" }, "TeamsListResultV3": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "teams": [ { "catalog_entry": { "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "id": "abc123", "members": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "slack_user_id": "U02AYNF2XJM" } ], "name": "abc123" } ] }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV3" }, "teams": { "example": [ { "catalog_entry": { "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "id": "abc123", "members": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "slack_user_id": "U02AYNF2XJM" } ], "name": "abc123" } ], "items": { "$ref": "#/components/schemas/TeamV3" }, "type": "array" } }, "required": [ "teams", "pagination_meta" ], "type": "object" }, "TeamsShowResultV3": { "example": { "team": { "catalog_entry": { "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "id": "abc123", "members": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "slack_user_id": "U02AYNF2XJM" } ], "name": "abc123" } }, "properties": { "team": { "$ref": "#/components/schemas/TeamV3" } }, "required": [ "team" ], "type": "object" }, "TelemetryUpdateDataSourcePayloadV2": { "example": { "datadog_config": { "api_key": "abc123", "app_key": "abc123" }, "grafana_config": { "api_key": "glsa_123", "api_url": "grafana.example.com" }, "name": "Production Grafana" }, "properties": { "datadog_config": { "$ref": "#/components/schemas/TelemetryDatadogUpdateConfigV2" }, "grafana_config": { "$ref": "#/components/schemas/TelemetryGrafanaUpdateConfigV2" }, "name": { "description": "Updated display name", "example": "Production Grafana", "type": "string" } }, "type": "object" }, "TelemetryUpdateDataSourceResultV2": { "example": { "data_source": { "created_at": "2021-08-17T13:28:57.801578Z", "enabled": true, "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary Prometheus", "provider": "grafana", "source_type": "grafana", "updated_at": "2021-08-17T13:28:57.801578Z", "version": "8.5.27" } }, "properties": { "data_source": { "$ref": "#/components/schemas/TelemetryDataSourceV2" } }, "required": [ "data_source" ], "type": "object" }, "UsersListResultV2": { "example": { "pagination_meta": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "users": [ { "base_role": { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" }, "custom_roles": [ { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" } ], "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_active": true, "name": "Lisa Karlin Curtis", "role": "owner", "seats": { "on_call": "full_access", "response": "viewer_only" }, "slack_user_id": "U02AYNF2XJM" } ] }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/PaginationMetaResultV2" }, "users": { "example": [ { "base_role": { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" }, "custom_roles": [ { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" } ], "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_active": true, "name": "Lisa Karlin Curtis", "role": "owner", "seats": { "on_call": "full_access", "response": "viewer_only" }, "slack_user_id": "U02AYNF2XJM" } ], "items": { "$ref": "#/components/schemas/UserWithRolesV2" }, "type": "array" } }, "required": [ "users", "pagination_meta" ], "type": "object" }, "UsersShowResultV2": { "example": { "user": { "base_role": { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" }, "custom_roles": [ { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" } ], "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_active": true, "name": "Lisa Karlin Curtis", "role": "owner", "seats": { "on_call": "full_access", "response": "viewer_only" }, "slack_user_id": "U02AYNF2XJM" } }, "properties": { "user": { "$ref": "#/components/schemas/UserWithRolesV2" } }, "required": [ "user" ], "type": "object" }, "UsersListNotificationMethodsResultV2": { "example": { "notification_methods": [ { "address": "•••••••6789", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_usable": true, "method_type": "app", "phone_details": { "supports_sms": true, "supports_voice": true } } ] }, "properties": { "notification_methods": { "example": [ { "address": "•••••••6789", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "is_usable": true, "method_type": "app", "phone_details": { "supports_sms": true, "supports_voice": true } } ], "items": { "$ref": "#/components/schemas/OnCallNotificationMethodPublicV2" }, "type": "array" } }, "required": [ "notification_methods" ], "type": "object" }, "UsersListNotificationRulesResultV2": { "example": { "notification_rules": [ { "app": { "push_notification_criticality": "critical" }, "delay_seconds": 0, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "method_target": { "all": {}, "specific": { "id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "specific" }, "method_type": "app", "phone": { "channel": "voice" }, "rule_type": "low_urgency" } ] }, "properties": { "notification_rules": { "example": [ { "app": { "push_notification_criticality": "critical" }, "delay_seconds": 0, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "method_target": { "all": {}, "specific": { "id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "specific" }, "method_type": "app", "phone": { "channel": "voice" }, "rule_type": "low_urgency" } ], "items": { "$ref": "#/components/schemas/OnCallNotificationRulePublicV2" }, "type": "array" } }, "required": [ "notification_rules" ], "type": "object" }, "UsersShowPagingProviderResultV2": { "example": { "preferred_escalation_provider": "native" }, "properties": { "preferred_escalation_provider": { "description": "The user's effective escalation provider.", "enum": [ "native", "opsgenie", "pagerduty", "splunk_on_call" ], "example": "native", "type": "string" } }, "type": "object" }, "UsersUpdatePagingProviderPayloadV2": { "example": { "preferred_escalation_provider": "native" }, "properties": { "preferred_escalation_provider": { "description": "The preferred escalation provider for the user.", "enum": [ "native", "opsgenie", "pagerduty", "splunk_on_call" ], "example": "native", "type": "string" } }, "required": [ "preferred_escalation_provider" ], "type": "object" }, "UtilitiesIdentityResultV1": { "example": { "identity": { "dashboard_url": "https://app.incident.io/my-org", "name": "Alertmanager token", "roles": [ "viewer" ], "team_roles": [ "catalog_editor" ], "teams": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Platform" } ] } }, "properties": { "identity": { "$ref": "#/components/schemas/IdentityV1" } }, "required": [ "identity" ], "type": "object" }, "UtilitiesIPRangesResultV1": { "example": { "ip_ranges": [ { "cidr": "34.91.219.113/32", "description": "Requests to your systems from integrations and from workflow \"Send a webhook\" steps" } ] }, "properties": { "ip_ranges": { "description": "Every address our traffic to you may originate from", "example": [ { "cidr": "34.91.219.113/32", "description": "Requests to your systems from integrations and from workflow \"Send a webhook\" steps" } ], "items": { "$ref": "#/components/schemas/IPRangeV1" }, "type": "array" } }, "required": [ "ip_ranges" ], "type": "object" }, "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" }, "WorkflowsListWorkflowsResultV2": { "example": { "workflows": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "folder": "My folder 01", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -> Affected Team", "type": "IncidentSeverity" } ], "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incident_scope": "owning_teams", "runs_from": "2021-08-17T13:28:57.801578Z", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "label": "PagerDuty Escalate", "name": "pagerduty.escalate" } ], "trigger": { "label": "Incident Updated", "name": "incident.updated" }, "version": 3 } ] }, "properties": { "workflows": { "example": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "folder": "My folder 01", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -> Affected Team", "type": "IncidentSeverity" } ], "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incident_scope": "owning_teams", "runs_from": "2021-08-17T13:28:57.801578Z", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "label": "PagerDuty Escalate", "name": "pagerduty.escalate" } ], "trigger": { "label": "Incident Updated", "name": "incident.updated" }, "version": 3 } ], "items": { "$ref": "#/components/schemas/WorkflowSlimV2" }, "type": "array" } }, "required": [ "workflows" ], "type": "object" }, "WorkflowsCreateWorkflowPayloadV2": { "example": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "folder": "My folder 01", "form_fields": [ { "array": true, "description": "The customer affected by this incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "key": "affected_customer", "required": true, "title": "Affected customer", "type": "User" } ], "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ "incident.url" ], "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incident_scope": "owning_teams", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "for_each": "abc123", "id": "abc123", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ] } ], "trigger": "incident.updated" }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that track metadata about this resource", "example": { "incident.io/terraform/version": "3.0.0" }, "type": "object" }, "condition_groups": { "description": "Conditions that apply to the workflow trigger", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" }, "continue_on_step_error": { "description": "Whether to continue executing the workflow if a step fails", "example": true, "type": "boolean" }, "delay": { "$ref": "#/components/schemas/WorkflowDelayV2" }, "expressions": { "description": "The expressions to use in the workflow", "example": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionPayloadV2" }, "type": "array" }, "folder": { "description": "Folder to display the workflow in", "example": "My folder 01", "type": "string" }, "form_fields": { "description": "User-configured form fields available in the workflow scope (manual triggers only)", "example": [ { "array": true, "description": "The customer affected by this incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "key": "affected_customer", "required": true, "title": "Affected customer", "type": "User" } ], "items": { "$ref": "#/components/schemas/WorkflowFormFieldPayloadV2" }, "type": "array" }, "include_private_escalations": { "description": "Whether to include private escalations", "example": true, "type": "boolean" }, "include_private_incidents": { "description": "DEPRECATED: use `private_incident_scope` instead. May be sent alongside `private_incident_scope` only if they agree; contradictory values return a validation error.", "example": true, "type": "boolean" }, "name": { "description": "Name provided by the user when creating the workflow", "example": "My little workflow", "type": "string" }, "once_for": { "description": "This workflow will run 'once for' a list of references", "example": [ "incident.url" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "owning_team_ids": { "description": "IDs of the teams that own this workflow", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "private_incident_scope": { "description": "Which private incidents this workflow acts on: every private incident (all), those an owning team can see (owning_teams), or none", "enum": [ "all", "owning_teams", "none" ], "example": "owning_teams", "type": "string" }, "runs_on_incident_modes": { "description": "Which incident modes should this workflow run on? By default, workflows only run on standard incidents, but can also be configured to run on test and retrospective incidents.", "example": [ "standard", "test", "retrospective" ], "items": { "enum": [ "standard", "test", "retrospective" ], "example": "standard", "type": "string" }, "type": "array" }, "runs_on_incidents": { "description": "Which incidents should the workflow be applied to?", "enum": [ "newly_created", "newly_created_and_active" ], "example": "newly_created", "type": "string" }, "shortform": { "description": "The shortform used to trigger this workflow (only applicable for manual triggers)", "example": "page-the-ceo", "type": "string" }, "state": { "description": "What state this workflow is in", "enum": [ "active", "disabled", "draft", "error" ], "example": "active", "type": "string" }, "steps": { "description": "Steps that are executed as part of the workflow", "example": [ { "for_each": "abc123", "id": "abc123", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/StepConfigPayloadV2" }, "type": "array" }, "trigger": { "description": "Trigger to set on the workflow", "example": "incident.updated", "type": "string" } }, "required": [ "name", "trigger", "once_for", "condition_groups", "steps", "expressions", "runs_on_incident_modes", "continue_on_step_error", "runs_on_incidents" ], "type": "object" }, "WorkflowsCreateWorkflowResultV2": { "example": { "management_meta": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "managed_by": "dashboard", "source_url": "https://github.com/my-company/infrastructure" }, "workflow": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "folder": "My folder 01", "form_fields": [ { "array": true, "description": "The customer affected by this incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "key": "affected_customer", "required": true, "title": "Affected customer", "type": "User" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -> Affected Team", "type": "IncidentSeverity" } ], "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incident_scope": "owning_teams", "runs_from": "2021-08-17T13:28:57.801578Z", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "for_each": "abc123", "id": "abc123", "label": "PagerDuty Escalate", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ] } ], "trigger": { "label": "Incident Updated", "name": "incident.updated" }, "version": 3 } }, "properties": { "management_meta": { "$ref": "#/components/schemas/ManagementMetaV2" }, "workflow": { "$ref": "#/components/schemas/WorkflowV2" } }, "required": [ "workflow", "management_meta" ], "type": "object" }, "WorkflowsShowWorkflowResultV2": { "example": { "management_meta": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "managed_by": "dashboard", "source_url": "https://github.com/my-company/infrastructure" }, "workflow": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "folder": "My folder 01", "form_fields": [ { "array": true, "description": "The customer affected by this incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "key": "affected_customer", "required": true, "title": "Affected customer", "type": "User" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -> Affected Team", "type": "IncidentSeverity" } ], "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incident_scope": "owning_teams", "runs_from": "2021-08-17T13:28:57.801578Z", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "for_each": "abc123", "id": "abc123", "label": "PagerDuty Escalate", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ] } ], "trigger": { "label": "Incident Updated", "name": "incident.updated" }, "version": 3 } }, "properties": { "management_meta": { "$ref": "#/components/schemas/ManagementMetaV2" }, "workflow": { "$ref": "#/components/schemas/WorkflowV2" } }, "required": [ "workflow", "management_meta" ], "type": "object" }, "WorkflowsUpdateWorkflowPayloadV2": { "example": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "folder": "My folder 01", "form_fields": [ { "array": true, "description": "The customer affected by this incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "key": "affected_customer", "required": true, "title": "Affected customer", "type": "User" } ], "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ "incident.url" ], "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incident_scope": "owning_teams", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "skip_step_upgrades": false, "state": "active", "steps": [ { "for_each": "abc123", "id": "abc123", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ] } ] }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that track metadata about this resource", "example": { "incident.io/terraform/version": "3.0.0" }, "type": "object" }, "condition_groups": { "description": "Conditions that apply to the workflow trigger", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" }, "continue_on_step_error": { "description": "Whether to continue executing the workflow if a step fails", "example": true, "type": "boolean" }, "delay": { "$ref": "#/components/schemas/WorkflowDelayV2" }, "expressions": { "description": "The expressions to use in the workflow", "example": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionPayloadV2" }, "type": "array" }, "folder": { "description": "Folder to display the workflow in", "example": "My folder 01", "type": "string" }, "form_fields": { "description": "User-configured form fields available in the workflow scope (manual triggers only)", "example": [ { "array": true, "description": "The customer affected by this incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "key": "affected_customer", "required": true, "title": "Affected customer", "type": "User" } ], "items": { "$ref": "#/components/schemas/WorkflowFormFieldPayloadV2" }, "type": "array" }, "include_private_escalations": { "description": "Whether to include private escalations", "example": true, "type": "boolean" }, "include_private_incidents": { "description": "DEPRECATED: use `private_incident_scope` instead. May be sent alongside `private_incident_scope` only if they agree; contradictory values return a validation error.", "example": true, "type": "boolean" }, "name": { "description": "Name provided by the user when creating the workflow", "example": "My little workflow", "type": "string" }, "once_for": { "description": "This workflow will run 'once for' a list of references", "example": [ "incident.url" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "owning_team_ids": { "description": "IDs of the teams that own this workflow", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "private_incident_scope": { "description": "Which private incidents this workflow acts on: every private incident (all), those an owning team can see (owning_teams), or none", "enum": [ "all", "owning_teams", "none" ], "example": "owning_teams", "type": "string" }, "runs_on_incident_modes": { "description": "Which incident modes should this workflow run on? By default, workflows only run on standard incidents, but can also be configured to run on test and retrospective incidents.", "example": [ "standard", "test", "retrospective" ], "items": { "enum": [ "standard", "test", "retrospective" ], "example": "standard", "type": "string" }, "type": "array" }, "runs_on_incidents": { "description": "Which incidents should the workflow be applied to?", "enum": [ "newly_created", "newly_created_and_active" ], "example": "newly_created", "type": "string" }, "shortform": { "description": "The shortform used to trigger this workflow (only applicable for manual triggers)", "example": "page-the-ceo", "type": "string" }, "skip_step_upgrades": { "description": "Skips workflow step upgrades, when the parameters for an existing workflow step change", "example": false, "type": "boolean" }, "state": { "description": "What state this workflow is in", "enum": [ "active", "disabled", "draft", "error" ], "example": "active", "type": "string" }, "steps": { "description": "Steps that are executed as part of the workflow", "example": [ { "for_each": "abc123", "id": "abc123", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/StepConfigPayloadV2" }, "type": "array" } }, "required": [ "name", "once_for", "condition_groups", "steps", "expressions", "runs_on_incident_modes", "continue_on_step_error", "runs_on_incidents" ], "type": "object" }, "WorkflowsUpdateWorkflowResultV2": { "example": { "management_meta": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "managed_by": "dashboard", "source_url": "https://github.com/my-company/infrastructure" }, "workflow": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "folder": "My folder 01", "form_fields": [ { "array": true, "description": "The customer affected by this incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "key": "affected_customer", "required": true, "title": "Affected customer", "type": "User" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -> Affected Team", "type": "IncidentSeverity" } ], "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incident_scope": "owning_teams", "runs_from": "2021-08-17T13:28:57.801578Z", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "for_each": "abc123", "id": "abc123", "label": "PagerDuty Escalate", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ] } ], "trigger": { "label": "Incident Updated", "name": "incident.updated" }, "version": 3 } }, "properties": { "management_meta": { "$ref": "#/components/schemas/ManagementMetaV2" }, "workflow": { "$ref": "#/components/schemas/WorkflowV2" } }, "required": [ "workflow", "management_meta" ], "type": "object" }, "ActionV3": { "properties": { "assignee": { "$ref": "#/components/schemas/UserV2" }, "completed_at": { "description": "When the action was completed", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "created_at": { "description": "When the action was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "creator": { "$ref": "#/components/schemas/ActorV2" }, "description": { "description": "Description of the action", "example": "Call the fire brigade", "type": "string" }, "id": { "description": "Unique identifier for the action", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_id": { "description": "Unique identifier of the incident the action belongs to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "status": { "description": "Status of the action", "enum": [ "outstanding", "completed", "deleted", "not_doing" ], "example": "outstanding", "type": "string" }, "updated_at": { "description": "When the action was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "incident_id", "creator", "description", "status", "created_at", "updated_at" ], "type": "object" }, "PaginationMetaResultV3": { "example": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "properties": { "after": { "description": "If provided, pass this as the 'after' param to load the next page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "page_size": { "default": 25, "description": "What was the maximum number of results requested", "example": 25, "format": "int64", "maximum": 250, "type": "integer" } }, "required": [ "page_size" ], "type": "object" }, "ErrorDebug": { "example": { "message": "Something broke: and something else: and something else", "stacktrace": [ "thing.go:123" ] }, "properties": { "message": { "description": "Original internal error message", "example": "Something broke: and something else: and something else", "type": "string" }, "stacktrace": { "description": "Stacktrace of the error, if applicable", "example": [ "thing.go:123" ], "items": { "example": "thing.go:123", "type": "string" }, "type": "array" } }, "required": [ "message", "stacktrace" ], "type": "object" }, "ErrorSingle": { "example": { "code": "trial_expired", "message": "Default incident call link must be a valid URL", "metadata": { "abc123": "abc123" }, "source": { "field": "default_call_url", "pointer": "/settings/default_call_url" } }, "properties": { "code": { "description": "Machine-readable identifier for this specific error", "example": "trial_expired", "type": "string" }, "message": { "description": "Human readable description of the error", "example": "Default incident call link must be a valid URL", "type": "string" }, "metadata": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Additional metadata about the error, keyed by a string identifier", "example": { "abc123": "abc123" }, "type": "object" }, "source": { "$ref": "#/components/schemas/ErrorSource" } }, "required": [ "code", "message" ], "type": "object" }, "ErrorRateLimit": { "example": { "limit": 100, "name": "client_ip", "remaining": 98, "retry_after": "2020-01-01T00:00:00Z" }, "properties": { "limit": { "description": "The maximum number of requests that the consumer is permitted to make per minute", "example": 100, "format": "int64", "type": "integer" }, "name": { "description": "Which rate limit was exceeded", "example": "client_ip", "type": "string" }, "remaining": { "description": "The number of requests remaining in the current rate limit window", "example": 98, "format": "int64", "type": "integer" }, "retry_after": { "description": "When the client can retry, as an RFC3339 timestamp in UTC. Prefer the Retry-After response header, which carries the same instant as a number of seconds", "example": "2020-01-01T00:00:00Z", "type": "string" } }, "required": [ "name", "limit", "remaining", "retry_after" ], "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" }, "AlertNoteV1": { "properties": { "alert_group_id": { "description": "ID of the alert group this note is attached to. Exactly one of alert_id or alert_group_id is set; the other is null.", "example": "01HB9Z8WANK6P870EA6S7TK1DS", "type": "string" }, "alert_id": { "description": "ID of the alert this note is attached to. Exactly one of alert_id or alert_group_id is set; the other is null.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "content": { "description": "Markdown body of the note", "example": "Customer reports **checkout 500s** starting ~14:32 UTC. Investigating `payments-api`.\n\n- Error rate: ~12% on `/checkout`\n- Region: `eu-west-1`\n- See [dashboard](https://grafana.example.com/d/abc)\n", "type": "string" }, "created_at": { "description": "When this note was first created", "example": "2026-05-28T15:30:00Z", "format": "date-time", "type": "string" }, "creator": { "$ref": "#/components/schemas/ActorV1" }, "id": { "description": "Unique identifier for the alert note", "example": "01J1X9J85C7Y12G8P8W8K55Q5Y", "type": "string" }, "images": { "description": "Images attached to the current version of the note, with signed URLs valid for 10 minutes", "example": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "url": "https://storage.googleapis.com/incident-io/images/..." } ], "items": { "$ref": "#/components/schemas/ImageV1" }, "type": "array" }, "last_edited_at": { "description": "When this note was last edited, only set if it has been edited at least once since creation", "example": "2026-05-28T15:35:00Z", "format": "date-time", "type": "string" }, "updated_at": { "description": "When this note was last updated", "example": "2026-05-28T15:35:00Z", "format": "date-time", "type": "string" } }, "required": [ "id", "content", "creator", "images", "created_at", "updated_at" ], "type": "object" }, "PaginationMetaResultV1": { "example": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "properties": { "after": { "description": "If provided, pass this as the 'after' param to load the next page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "page_size": { "default": 25, "description": "What was the maximum number of results requested", "example": 25, "format": "int64", "maximum": 250, "type": "integer" } }, "required": [ "page_size" ], "type": "object" }, "AlertRouteSlimV3": { "example": { "enabled": false, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Production incidents" }, "properties": { "enabled": { "description": "Whether this alert route is enabled or not", "example": false, "type": "boolean" }, "id": { "description": "Unique identifier for this alert route config", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "The name of this alert route config, for the user's reference", "example": "Production incidents", "type": "string" } }, "required": [ "id", "name", "enabled" ], "type": "object" }, "AlertRouteAlertSourcePayloadV3": { "example": { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] }, "properties": { "alert_source_id": { "description": "The alert source ID that will match for the route", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "condition_groups": { "description": "What conditions should alerts from this source meet to be included in this alert route?", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV3" }, "type": "array" } }, "required": [ "alert_source_id", "condition_groups" ], "type": "object" }, "ConditionGroupPayloadV3": { "example": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] }, "properties": { "conditions": { "description": "All conditions in this list must be satisfied for the group to be satisfied", "example": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ], "items": { "$ref": "#/components/schemas/ConditionPayloadV3" }, "type": "array" } }, "required": [ "conditions" ], "type": "object" }, "AlertRouteEscalationConfigPayloadV3": { "example": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "when_alert_joins_group": { "grace_period_seconds": 60, "mode": "on_each_new_alert" } }, "properties": { "auto_cancel_escalations": { "description": "Should we auto cancel escalations when all alerts are resolved?", "example": false, "type": "boolean" }, "escalation_targets": { "description": "Targets for escalation", "example": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/AlertRouteEscalationTargetPayloadV3" }, "type": "array" }, "when_alert_joins_group": { "$ref": "#/components/schemas/AlertRouteWhenAlertJoinsGroupPayloadV3" } }, "required": [ "escalation_targets", "auto_cancel_escalations" ], "type": "object" }, "ExpressionPayloadV3": { "example": { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" }, "properties": { "else_branch": { "$ref": "#/components/schemas/ExpressionElseBranchPayloadV3" }, "label": { "description": "The human readable label of the expression", "example": "Team Slack channel", "type": "string" }, "operations": { "example": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "items": { "$ref": "#/components/schemas/ExpressionOperationPayloadV3" }, "type": "array" }, "reference": { "description": "A short ID that can be used to reference the expression", "example": "abc123", "type": "string" }, "root_reference": { "description": "The root reference for this expression (i.e. where the expression starts)", "example": "incident.status", "type": "string" } }, "required": [ "label", "reference", "root_reference", "operations" ], "type": "object" }, "AlertGroupingConfigV3": { "example": { "default": { "enabled": true, "grouping_keys": [ { "reference": "alert.title" } ], "window_seconds": 1800, "window_type": "rolling" } }, "properties": { "default": { "$ref": "#/components/schemas/GroupingSettingsV3" } }, "required": [ "default" ], "type": "object" }, "AlertRouteIncidentConfigPayloadV3": { "example": { "auto_decline_enabled": false, "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "enabled": false, "incident_template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "membership_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } } }, "properties": { "auto_decline_enabled": { "description": "Should triage incidents be declined when alerts are resolved? Required when incident creation is enabled, and must be unset otherwise.", "example": false, "type": "boolean" }, "condition_groups": { "description": "What condition groups must be true for this alert route to create an incident? Only set when incident creation is enabled.", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV3" }, "type": "array" }, "enabled": { "description": "Whether incident creation is enabled for this alert route", "example": false, "type": "boolean" }, "incident_template": { "$ref": "#/components/schemas/EngineParamBindingPayloadV3" }, "membership_teams": { "$ref": "#/components/schemas/EngineParamBindingPayloadV3" }, "template": { "$ref": "#/components/schemas/AlertRouteIncidentTemplatePayloadV3" } }, "required": [ "enabled" ], "type": "object" }, "AlertMessageConfigPayloadV3": { "example": { "destinations": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "public", "group_alerts_summary": false }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "public", "group_alerts_summary": false } } ], "template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "destinations": { "description": "The destinations (Slack/Teams channels) alert messages are sent to", "example": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "public", "group_alerts_summary": false }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "public", "group_alerts_summary": false } } ], "items": { "$ref": "#/components/schemas/AlertMessageDestinationPayloadV3" }, "type": "array" }, "template": { "$ref": "#/components/schemas/EngineParamBindingPayloadV3" } }, "required": [ "destinations" ], "type": "object" }, "AlertRouteV3": { "properties": { "alert_sources": { "description": "Which alert sources this route matches", "example": [ { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] } ], "items": { "$ref": "#/components/schemas/AlertRouteAlertSourceV3" }, "type": "array" }, "condition_groups": { "description": "Filter: the condition groups that must be true for this route to fire", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV3" }, "type": "array" }, "created_at": { "description": "When this alert route was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "enabled": { "description": "Whether this alert route is enabled", "example": false, "type": "boolean" }, "escalation_config": { "$ref": "#/components/schemas/AlertRouteEscalationConfigV3" }, "expressions": { "description": "The expressions used by bindings in this route", "example": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionV3" }, "type": "array" }, "grouping_config": { "$ref": "#/components/schemas/AlertGroupingConfigV3" }, "id": { "description": "Unique identifier for this alert route", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_config": { "$ref": "#/components/schemas/AlertRouteIncidentConfigV3" }, "is_private": { "description": "Whether this alert route is private. Private alert routes only create private incidents from alerts.", "example": false, "type": "boolean" }, "message_config": { "$ref": "#/components/schemas/AlertMessageConfigV3" }, "name": { "description": "The name of this alert route, for the user's reference", "example": "Production incidents", "type": "string" }, "owning_team_ids": { "description": "IDs of teams that own this alert route", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "updated_at": { "description": "When this alert route was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "version": { "description": "The version of this alert route", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "id", "name", "is_private", "enabled", "alert_sources", "condition_groups", "grouping_config", "escalation_config", "incident_config", "message_config", "expressions", "version" ], "type": "object" }, "AlertSourceV2": { "properties": { "alert_events_url": { "description": "URL that can be used to send alert events to this source. This is only set for sources that accept webhook/HTTP events; email sources use the email_address field, and integration-based sources (like Jira) receive events through their native integrations.", "example": "https://api.incident.io/v2/alert_events/http/01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "auto_resolve_incident_alerts": { "description": "Whether alerts from this source keep counting down to auto-resolve while attached to an incident. Defaults to true. Has no effect without auto_resolve_timeout_minutes.", "example": false, "type": "boolean" }, "auto_resolve_timeout_minutes": { "description": "When set, alerts from this source will automatically resolve after this many minutes.", "example": 1, "format": "int64", "type": "integer" }, "azure_devops_options": { "$ref": "#/components/schemas/AlertSourceAzureDevopsOptionsV2" }, "email_options": { "$ref": "#/components/schemas/AlertSourceEmailOptionsV2" }, "filter_condition_groups": { "description": "Conditions an incoming event must match to be ingested from this source, evaluated against the event's payload and this source's expressions.", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV2" }, "type": "array" }, "fixed_team_id": { "description": "When set, the team every alert from this source is attributed to. The team attribute is managed from this field: its binding is not returned in the template and cannot be edited directly.", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "heartbeat_options": { "$ref": "#/components/schemas/AlertSourceHeartbeatOptionsV2" }, "http_custom_options": { "$ref": "#/components/schemas/AlertSourceHTTPCustomOptionsV2" }, "id": { "description": "The ID of this alert source", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "jira_options": { "$ref": "#/components/schemas/AlertSourceJiraOptionsV2" }, "name": { "description": "Unique name of the alert source", "example": "Production Web Dashboard Alerts", "type": "string" }, "owning_team_ids": { "description": "IDs of teams that own this alert source", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "rate_limit_sharding": { "$ref": "#/components/schemas/AlertSourceRateLimitShardingV2" }, "secret_token": { "description": "Secret token used to authenticate this source, if applicable. If applicable, this is the token that must be included in either the query string or the 'Authorization' header when sending events to this alert source.", "example": "some-secret-token", "type": "string" }, "source_type": { "description": "Type of alert source", "enum": [ "alertmanager", "app_optics", "azure_monitor", "azure_devops", "big_panda", "bugsnag", "checkly", "chronosphere", "cloudwatch", "cloudflare", "coralogix", "cronitor", "crowdstrike_falcon", "dash0", "datadog", "dynatrace", "elasticsearch", "email", "expel", "github_issue", "google_cloud", "grafana", "heartbeat", "http", "http_custom", "honeycomb", "icinga2", "incoming_calls", "jira", "jsm", "monte_carlo", "nagios", "new_relic", "opsgenie", "prtg", "pager_duty", "panther", "pingdom", "runscope", "sns", "salesforce_case", "sentry", "sentry_metric", "service_now", "splunk", "status_cake", "status_page_views", "sumo_logic", "uptime", "vercel", "wiz", "zendesk" ], "example": "alertmanager", "type": "string", "x-public-api-version": "v2" }, "template": { "$ref": "#/components/schemas/AlertTemplateV2" } }, "required": [ "id", "name", "source_type", "template" ], "type": "object" }, "AlertSourceAzureDevopsOptionsV2": { "example": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "ba038695-f5f7-4490-a9ea-bf4ab3cbf483" ] }, "properties": { "project_ids": { "description": "Which Azure DevOps projects should this alert source watch for work item updates? IDs can either be IDs of the projects in Azure DevOps, or IDs of catalog entries in the 'Azure DevOps Project' catalog type.", "example": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "ba038695-f5f7-4490-a9ea-bf4ab3cbf483" ], "items": { "example": "abc123", "type": "string" }, "type": "array" } }, "required": [ "project_ids" ], "type": "object" }, "AlertSourceEmailOptionsPayloadV2": { "example": { "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "properties": { "redactions": { "description": "Which PII types to automatically redact from incoming email content before storage", "example": [ "credit_card_numbers" ], "items": { "description": "Which PII type to automatically redact from incoming email content before storage", "enum": [ "credit_card_numbers", "us_social_security_numbers", "phone_numbers" ], "example": "credit_card_numbers", "type": "string", "x-public-api-version": "v2" }, "type": "array" }, "transform_expression": { "description": "JavaScript expression to transform email fields into structured alert fields", "example": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}", "type": "string" } }, "required": [ "redactions" ], "type": "object" }, "ConditionGroupPayloadV2": { "example": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] }, "properties": { "conditions": { "description": "All conditions in this list must be satisfied for the group to be satisfied", "example": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "items": { "$ref": "#/components/schemas/ConditionPayloadV2" }, "type": "array" } }, "required": [ "conditions" ], "type": "object" }, "AlertSourceHeartbeatOptionsPayloadV2": { "example": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60 }, "properties": { "failure_threshold": { "default": 1, "description": "Number of consecutive missed pings before an alert fires.", "example": 1, "format": "int64", "type": "integer" }, "grace_period_seconds": { "default": 0, "description": "How long after a missed ping before the heartbeat is considered late, in seconds. If zero, it transitions directly to failing.", "example": 0, "format": "int64", "type": "integer" }, "interval_seconds": { "description": "How often a ping is expected, in seconds.", "example": 60, "format": "int64", "type": "integer" } }, "required": [ "interval_seconds" ], "type": "object" }, "AlertSourceHTTPCustomOptionsV2": { "example": { "deduplication_key_path": "$.alert_id", "transform_expression": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}" }, "properties": { "deduplication_key_path": { "description": "JSON path to extract the deduplication key from the payload", "example": "$.alert_id", "type": "string" }, "transform_expression": { "description": "JavaScript expression that returns an object with all alert fields", "example": "return {\n title: $.title || $.name || 'Unknown Alert',\n status: $.status === 'resolved' ? 'resolved' : 'firing',\n description: $.description || $.message || '',\n sourceURL: $.url || $.link || '',\n metadata: { team: $.team, severity: $.severity }\n}", "type": "string" } }, "required": [ "transform_expression", "deduplication_key_path" ], "type": "object" }, "AlertSourceJiraOptionsV2": { "example": { "project_ids": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ] }, "properties": { "project_ids": { "description": "Which projects in Jira should this alert source watch for new issues? IDs can either be IDs of the projects in Jira, or ID of catalog entries in the 'Jira Project' catalog type.", "example": [ "01GBSQF3FHF7FWZQNWGHAVQ804", "10043" ], "items": { "example": "abc123", "type": "string" }, "type": "array" } }, "required": [ "project_ids" ], "type": "object" }, "AlertSourceRateLimitShardingV2": { "description": "Controls how this source's ingest rate limit is split into buckets.", "example": { "rate_limit_shard_key_path": "$.priority" }, "properties": { "rate_limit_shard_key_path": { "default": "", "description": "JSON path to a value that splits this source's rate limit into per-value buckets.", "example": "$.priority", "type": "string" } }, "required": [ "rate_limit_shard_key_path" ], "type": "object" }, "AlertTemplatePayloadV2": { "example": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "is_private": false, "title": { "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "attributes": { "description": "Attributes to set on alerts coming from this source, with a binding describing how to set them.", "example": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/AlertTemplateAttributePayloadV2" }, "type": "array" }, "description": { "$ref": "#/components/schemas/EngineParamBindingValuePayloadV2" }, "expressions": { "description": "Expressions available for use in bindings within this template", "example": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionPayloadV2" }, "type": "array" }, "is_private": { "description": "Whether or not alerts produced by this source should be private", "example": false, "type": "boolean" }, "title": { "$ref": "#/components/schemas/EngineParamBindingValuePayloadV2" }, "visible_to_teams": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" } }, "required": [ "expressions", "title", "description", "attributes" ], "type": "object" }, "AlertTagV2": { "properties": { "id": { "description": "Unique identifier for the tag", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "name": { "description": "The tag name", "example": "noisy", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "PaginationMetaResultV2": { "example": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25 }, "properties": { "after": { "description": "If provided, pass this as the 'after' param to load the next page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "page_size": { "default": 25, "description": "What was the maximum number of results requested", "example": 25, "format": "int64", "maximum": 250, "type": "integer" } }, "required": [ "page_size" ], "type": "object" }, "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" }, "tags": { "description": "Tags someone has applied to this alert", "example": [ { "id": "01GW2G3V0S59R238FAHPDS1R66", "name": "noisy" } ], "items": { "$ref": "#/components/schemas/AlertTagV2" }, "type": "array" }, "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" }, "IncidentAlertV2": { "properties": { "alert": { "$ref": "#/components/schemas/AlertSlimV2" }, "alert_route_id": { "description": "The ID of the alert route that created this incident alert", "example": "01GW2G3V0S59R238FAHPDS1R67", "type": "string" }, "id": { "description": "The ID of this alert", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "incident": { "$ref": "#/components/schemas/IncidentSlimV2" } }, "required": [ "id", "alert", "incident" ], "type": "object" }, "APIKeyV1": { "properties": { "comments": { "description": "Freeform notes about this API key", "example": "Requested in https://example.slack.com/archives/C123/p456", "maxLength": 5000, "pattern": "^[^\u0000]*$", "type": "string" }, "created_at": { "description": "When the API key was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "creator": { "$ref": "#/components/schemas/ActorV1" }, "id": { "description": "Unique identifier for this API key", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "last_used_at": { "description": "When the key was last used to authenticate a request", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "name": { "description": "The name of the API key, for the user's reference", "example": "My test API key", "type": "string" }, "roles": { "description": "The account-level roles assigned to this API key", "example": [ { "description": "can view data, like public incidents and organization settings", "name": "viewer" } ], "items": { "$ref": "#/components/schemas/APIKeyRoleV1" }, "type": "array" }, "team_ids": { "description": "IDs of teams that this API key is scoped to", "example": [ "abc123" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "team_roles": { "description": "The team-level roles assigned to this API key", "example": [ { "description": "can view data, like public incidents and organization settings", "name": "catalog_editor" } ], "items": { "$ref": "#/components/schemas/APIKeyTeamRoleV1" }, "type": "array" }, "token_last_issued_at": { "description": "When the current token for this API was last issued. This is the last time the token was rotated, or when it was initially created. Older tokens may remain valid for up to an hour after they have been rotated, configured when you call the rotate endpoint.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "roles", "team_ids", "team_roles", "creator", "created_at", "token_last_issued_at" ], "type": "object" }, "CallRouteV2": { "description": "A call route is a phone number your customers can call to reach whoever is\non call, for an urgent support line or a regulator hotline.\n\nWhen a call comes in we work down the route's path, ringing each level's targets\nin turn until someone answers, then connect them to the caller. A trailing\nvoicemail node records a message instead. Every call raises an alert, so calls\ncan open incidents through an alert route.\n\nList and edit call routes here. Create and delete them in the dashboard.", "properties": { "allowed_callers": { "description": "The numbers allowed to call this route. Only enforced when use_caller_allowlist is true.", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Regulator duty desk", "phone_number": "+15551234567" } ], "items": { "$ref": "#/components/schemas/CallRouteAllowedCallerV2" }, "type": "array" }, "country_code": { "description": "The country this route's number belongs to", "example": "US", "type": "string" }, "created_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "current_state": { "description": "Where this route is in provisioning. Only an active route answers calls:\n* pending: created, and awaiting manual work from us\n* pending_regulatory_information: awaiting regulatory compliance information, collected in the dashboard\n* pending_number: compliance is settled, and we're provisioning a number\n* active: fully provisioned, and answering calls", "enum": [ "pending", "pending_regulatory_information", "pending_number", "active" ], "example": "active", "type": "string" }, "custom_language": { "description": "The language we speak voice prompts in, via text-to-speech", "enum": [ "en-US", "en-GB", "fr-FR", "es-ES", "pt-PT", "pt-BR", "de-DE", "nl-NL" ], "example": "en-US", "type": "string" }, "id": { "description": "Unique identifier for this call route", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Name for this call route", "example": "Regulator urgent request", "type": "string" }, "options": { "description": "The phone-tree menu this route presents. Empty when callers are routed down the route's path.", "example": [ { "digit": "1", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "path": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "prompt": "For an urgent production outage, press 1" } ], "items": { "$ref": "#/components/schemas/CallRouteOptionV2" }, "type": "array" }, "path": { "description": "Who we page when a call comes in. Empty when this route presents a phone-tree menu, in which case each menu option carries its own path.", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "items": { "$ref": "#/components/schemas/CallRoutePathNodeV2" }, "type": "array" }, "phone_number": { "description": "The number your customers call to reach this route, once one has been provisioned", "example": "+15551234567", "type": "string" }, "phone_number_type": { "description": "The type of phone number, which determines the regulatory requirements for provisioning it", "enum": [ "toll_free", "mobile", "national", "local" ], "example": "toll_free", "type": "string", "x-public-api-version": "v2" }, "responder_caller_id": { "description": "Which number responders see when we call them:\n* route_number: this route's own number\n* oncall_number: an incident.io on-call number", "enum": [ "route_number", "oncall_number" ], "example": "route_number", "type": "string" }, "updated_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "use_caller_allowlist": { "description": "Whether this route only answers calls from its allowed callers", "example": true, "type": "boolean" } }, "required": [ "id", "name", "current_state", "custom_language", "responder_caller_id", "path", "options", "use_caller_allowlist", "allowed_callers", "created_at", "updated_at" ], "type": "object" }, "CallRouteAllowedCallerV2": { "description": "A phone number allowed to reach a call route.", "properties": { "id": { "description": "Unique identifier for this allowed caller", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Label for whose number this is", "example": "Regulator duty desk", "type": "string" }, "phone_number": { "description": "The number allowed to call this route, in international format", "example": "+15551234567", "type": "string" } }, "required": [ "id", "phone_number" ], "type": "object" }, "CallRouteOptionV2": { "description": "One entry in a call route's phone-tree menu: the digit a caller presses, the\nprompt we read out to offer it, and who we page when they choose it.", "properties": { "digit": { "description": "The keypad digit a caller presses to choose this option", "enum": [ "1", "2", "3", "4", "5", "6", "7", "8", "9" ], "example": "1", "type": "string" }, "id": { "description": "Unique identifier for this option", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "path": { "description": "Who we page when a caller chooses this option", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } } ], "items": { "$ref": "#/components/schemas/CallRoutePathNodeV2" }, "type": "array" }, "prompt": { "description": "What we read out to offer this option, via text-to-speech in the route's language, exactly as written", "example": "For an urgent production outage, press 1", "maxLength": 250, "type": "string" } }, "required": [ "id", "digit", "prompt", "path" ], "type": "object" }, "CallRoutePathNodePayloadV2": { "example": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } }, "properties": { "id": { "description": "Unique identifier for this node. Omit it and we'll generate one.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "level": { "$ref": "#/components/schemas/CallRoutePathNodeLevelV2" }, "type": { "description": "The type of this node. Available types are:\n* level: page a set of targets, rotating between them\n* voicemail: record a message from the caller", "enum": [ "level", "voicemail" ], "example": "level", "type": "string" }, "voicemail": { "$ref": "#/components/schemas/CallRoutePathNodeVoicemailV2" } }, "required": [ "type" ], "type": "object" }, "CallSessionV2": { "description": "A call session is a single occurrence of a call that Scribe attended,\nfor example one Zoom or Google Meet meeting. Several call sessions can exist for\nthe same context: one for each time a call was started.\n\nUse the Call Transcript Entries endpoint to page through what Scribe transcribed\nduring a session.", "properties": { "ended_at": { "description": "When the call session ended. Absent while the call is still in progress.", "example": "2021-08-17T14:28:57.801578Z", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier for this call session", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_id": { "description": "The incident this call session belongs to", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "started_at": { "description": "When the call session started", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "incident_id", "started_at" ], "type": "object" }, "CallTranscriptEntryV2": { "description": "A single entry of a Scribe call transcript: one contiguous run of\nspeech, or one in-call chat message, from one participant.", "properties": { "content": { "description": "What was said", "example": "I think we should roll back the deploy.", "type": "string" }, "id": { "description": "Unique identifier for this transcript entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "medium": { "description": "Whether this entry was spoken aloud or sent as an in-call chat message", "enum": [ "spoken", "call_chat" ], "example": "spoken", "type": "string" }, "participant_name": { "description": "Name of the participant who spoke or sent the message, as reported by the call provider", "example": "Alice Smith", "type": "string" }, "timestamp": { "description": "When the participant started speaking", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "participant_name", "timestamp", "content", "medium" ], "type": "object" }, "CatalogEntryV3": { "properties": { "aliases": { "description": "Optional aliases that can be used to reference this entry", "example": [ "lawrence@incident.io", "lawrence" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "archived_at": { "description": "When this entry was archived", "example": "2021-08-17T14:28:57.801578Z", "format": "date-time", "type": "string" }, "attribute_values": { "additionalProperties": { "$ref": "#/components/schemas/CatalogEntryEngineParamBindingV3" }, "description": "Values of this entry", "example": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123" } } }, "type": "object" }, "catalog_type_id": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "created_at": { "description": "When this entry was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "external_id": { "description": "An optional alternative ID for this entry, which is ensured to be unique for the type", "example": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "type": "string" }, "id": { "description": "ID of this catalog entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Name is the human readable name of this entry", "example": "Primary On-call", "type": "string" }, "rank": { "description": "When catalog type is ranked, this is used to help order things", "example": 3, "format": "int32", "type": "integer" }, "updated_at": { "description": "When this entry was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "catalog_type_id", "name", "aliases", "rank", "attribute_values", "created_at", "updated_at" ], "type": "object" }, "CatalogTypeV3": { "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that can track metadata about this type", "example": { "incident.io/catalog-importer/id": "id-of-config" }, "type": "object" }, "categories": { "description": "What categories is this type considered part of", "example": [ "customer" ], "items": { "enum": [ "customer", "issue-tracker", "product-feature", "service", "on-call", "team", "user" ], "example": "customer", "type": "string", "x-public-api-version": "v3" }, "type": "array" }, "color": { "description": "Sets the display color of this type in the dashboard", "enum": [ "yellow", "green", "blue", "violet", "pink", "cyan", "orange" ], "example": "yellow", "type": "string" }, "created_at": { "description": "When this type was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "Human readble description of this type", "example": "Represents Kubernetes clusters that we run inside of GKE.", "type": "string" }, "dynamic_resource_parameter": { "description": "If this is a dynamic catalog type, this will be the unique parameter for identitfying this resource externally.", "example": "abc123", "type": "string" }, "engine_resource_type": { "description": "The way this resource type is referenced in the engine, as used when setting the type of an alert attribute", "example": "CatalogEntry[\"PagerDutyService\"]", "type": "string" }, "estimated_count": { "description": "If populated, gives an estimated count of entries for this type", "example": 7, "format": "int64", "type": "integer" }, "icon": { "description": "Sets the display icon of this type in the dashboard", "enum": [ "alert", "bolt", "box", "briefcase", "browser", "bulb", "calendar", "clock", "cog", "components", "database", "doc", "email", "escalation-path", "files", "flag", "folder", "globe", "incident-template", "money", "server", "severity", "status-page", "store", "star", "tag", "user", "users" ], "example": "alert", "type": "string" }, "id": { "description": "ID of this catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "is_editable": { "description": "Catalog types that are synced with external resources can't be edited", "example": false, "type": "boolean" }, "is_team_type": { "description": "Whether this catalog type is the designated team type in team settings", "example": false, "type": "boolean" }, "last_synced_at": { "description": "When this type was last synced (if it's ever been sync'd)", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "name": { "description": "Name is the human readable name of this type", "example": "Kubernetes Cluster", "type": "string" }, "owning_team_ids": { "description": "IDs of the teams that own this catalog type", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "ranked": { "description": "If this type should be ranked", "example": true, "type": "boolean" }, "registry_type": { "description": "The registry resource this type is synced from, if any", "example": "PagerDutyService", "type": "string" }, "required_integrations": { "description": "If populated, the integrations required for this type", "example": [ "pager_duty" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "schema": { "$ref": "#/components/schemas/CatalogTypeSchemaV3" }, "source_repo_url": { "description": "The url of the external repository where this type is managed", "example": "https://github.com/my-company/incident-io-catalog", "type": "string" }, "type_name": { "description": "The type name of this catalog type, to be used when defining attributes. This is immutable once a CatalogType has been created. For non-externally sync types, it must follow the pattern Custom[\"SomeName\"]", "example": "Custom[\"BackstageGroup\"]", "type": "string" }, "updated_at": { "description": "When this type was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "use_name_as_identifier": { "description": "If enabled, you can refer to entries of this type by their name, as well as their external ID and any aliases.", "example": true, "type": "boolean" } }, "required": [ "id", "name", "description", "type_name", "engine_resource_type", "ranked", "schema", "icon", "categories", "color", "is_editable", "annotations", "created_at", "updated_at", "use_name_as_identifier" ], "type": "object" }, "PaginationMetaResultWithTotalV3": { "example": { "after": "01FCNDV6P870EA6S7TK1DSYDG0", "page_size": 25, "total_record_count": 238 }, "properties": { "after": { "description": "If provided, pass this as the 'after' param to load the next page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "page_size": { "default": 25, "description": "What was the maximum number of results requested", "example": 25, "format": "int64", "maximum": 250, "type": "integer" }, "total_record_count": { "description": "How many matching records were there in total, if known", "example": 238, "format": "int64", "type": "integer" } }, "required": [ "page_size" ], "type": "object" }, "CatalogEngineParamBindingPayloadV3": { "example": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } }, "properties": { "array_value": { "description": "If set, this is the array value of the step parameter", "example": [ { "literal": "SEV123" } ], "items": { "$ref": "#/components/schemas/CatalogEngineParamBindingValuePayloadV3" }, "type": "array" }, "value": { "$ref": "#/components/schemas/CatalogEngineParamBindingValuePayloadV3" } }, "type": "object" }, "PartialEntryPayloadV3": { "description": "Represents a partial entry update, allowing selective field updates", "example": { "aliases": [ "abc123" ], "attribute_values": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "entry_id": "abc123", "external_id": "abc123", "name": "abc123", "rank": 1 }, "properties": { "aliases": { "description": "If specified, will update the aliases of the entry. When omitted, preserves the existing aliases.", "example": [ "abc123" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "attribute_values": { "additionalProperties": { "$ref": "#/components/schemas/CatalogEngineParamBindingPayloadV3" }, "description": "The attribute values to apply to this entry", "example": { "abc123": { "array_value": [ { "literal": "SEV123" } ], "value": { "literal": "SEV123" } } }, "type": "object" }, "entry_id": { "description": "ID of the relevant catalog entry", "example": "abc123", "type": "string" }, "external_id": { "description": "If specified, will update the external ID of the entry. When omitted, preserves the existing external ID.", "example": "abc123", "type": "string" }, "name": { "description": "If specified, will update the name of the entry. When omitted, preserves the existing name.", "example": "abc123", "type": "string" }, "rank": { "description": "If specified, will update the rank of the entry. When omitted, rank will be set to null (allowing rank removal).", "example": 1, "format": "int32", "type": "integer" } }, "required": [ "entry_id", "attribute_values" ], "type": "object" }, "CatalogResourceV3": { "properties": { "category": { "description": "Which category of resource", "enum": [ "primitive", "custom", "external" ], "example": "custom", "type": "string" }, "description": { "description": "Human readable description for this resource", "example": "Boolean true or false value", "type": "string" }, "engine_resource_type": { "description": "The way this resource type is referenced in the engine, as used when setting the type of an alert attribute", "example": "CatalogEntry[\"01GVGYJSD39FRKVDWACK9NDS4E\"]", "type": "string" }, "label": { "description": "Label for this catalog resource type", "example": "GitHub Repository", "type": "string" }, "type": { "description": "Catalog type name for this resource, as used when setting the type of a catalog type attribute", "example": "Custom[\"Team\"]", "type": "string" }, "value_docstring": { "description": "Documentation for the literal string value of this resource", "example": "Either the GraphQL node ID of the repository or a string of /, e.g. incident-io/website", "type": "string" } }, "required": [ "type", "engine_resource_type", "label", "description", "value_docstring", "category" ], "type": "object" }, "CatalogTypeAttributePayloadV3": { "example": { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123" } ], "type": "Custom[\"Service\"]" }, "properties": { "array": { "description": "Whether this attribute is an array", "example": false, "type": "boolean" }, "backlink_attribute": { "description": "The attribute to use (if this is a backlink)", "example": "abc123", "type": "string" }, "id": { "description": "The ID of this attribute", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "mode": { "description": "Controls how this attribute is modified", "enum": [ "", "api", "dashboard", "external", "internal", "dynamic", "backlink", "path" ], "example": "", "type": "string", "x-public-api-version": "v3" }, "name": { "description": "Unique name of this attribute", "example": "tier", "type": "string" }, "path": { "description": "The path to use (if this is an path)", "example": [ { "attribute_id": "abc123" } ], "items": { "$ref": "#/components/schemas/CatalogTypeAttributePathItemPayloadV3" }, "type": "array" }, "type": { "description": "Catalog type name for this attribute", "example": "Custom[\"Service\"]", "type": "string" } }, "required": [ "name", "type", "array" ], "type": "object" }, "CustomFieldOptionV1": { "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" }, "CustomFieldV2": { "properties": { "catalog_type_id": { "description": "For catalog fields, the ID of the associated catalog type", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "created_at": { "description": "When the action was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "Description of the custom field", "example": "Which team is impacted by this issue", "type": "string" }, "field_type": { "description": "Type of custom field", "enum": [ "single_select", "multi_select", "text", "link", "numeric" ], "example": "single_select", "type": "string" }, "filter_by": { "$ref": "#/components/schemas/CustomFieldFilterByOptionsV2" }, "fixed_filter": { "$ref": "#/components/schemas/CustomFieldFixedFilterOptionsV2" }, "group_by_catalog_attribute_id": { "description": "For catalog fields, the ID of the attribute used to group catalog entries (if applicable)", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "helptext_catalog_attribute_id": { "description": "Which catalog attribute provides helptext for the options", "example": "01H2FW182TAH0NHEVBY34SCAK0", "type": "string" }, "id": { "description": "Unique identifier for the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Human readable name for the custom field", "example": "Affected Team", "maxLength": 50, "type": "string" }, "updated_at": { "description": "When the action was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "description", "field_type", "created_at", "updated_at" ], "type": "object" }, "CustomFieldFilterByOptionsV2": { "example": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0" }, "properties": { "catalog_attribute_id": { "description": "This must be an attribute of the catalog type of this custom field. It must be an attribute that points to another catalog type (so not a plain string, number, or boolean attribute).", "example": "01H2FW182TAH0NHEVBY34SCAK0", "type": "string" }, "custom_field_id": { "description": "This must be the ID of a custom field, which must have values of the same type as the attribute you are filtering by.\n\nWhen this filtering field is set on an incident, the options for this custom field will be filtered to only those with the attribute value that matches the value of the filtering field.", "example": "01H2FW182TAH0NHEVBY34SCAK0", "type": "string" } }, "required": [ "custom_field_id", "catalog_attribute_id" ], "type": "object" }, "CustomFieldFixedFilterOptionsV2": { "example": { "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0", "values": [ "01H2FW182TAH0NHEVBY34SCAK0", "01H2FW182TAH0NHEVBY34SCAK1" ] }, "properties": { "catalog_attribute_id": { "description": "This must be an attribute of the catalog type of this custom field. It must be an attribute that points to another catalog type (so not a plain string, number, or boolean attribute).", "example": "01H2FW182TAH0NHEVBY34SCAK0", "type": "string" }, "values": { "description": "The catalog entry IDs (of the type the attribute points at) that the attribute must reference. The options for this custom field are restricted to entries matching one of these values.", "example": [ "01H2FW182TAH0NHEVBY34SCAK0", "01H2FW182TAH0NHEVBY34SCAK1" ], "items": { "example": "abc123", "type": "string" }, "type": "array" } }, "required": [ "catalog_attribute_id", "values" ], "type": "object" }, "EscalationPathTemplateV2": { "properties": { "description": { "description": "A description of what this template is for.", "example": "abc123", "type": "string" }, "expressions": { "description": "Expressions backing the template's binding targets.", "example": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionV2" }, "type": "array" }, "has_historical_escalation_path_versions": { "description": "Whether a previous escalation path version uses this template. You cannot restore those versions after the template is archived.", "example": false, "type": "boolean" }, "id": { "description": "Unique identifier for this template.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "The name of this template.", "example": "Team on-call", "type": "string" }, "params": { "description": "The parameters declared by this template.", "example": [ { "allowed_value_types": [ "literal" ], "array": true, "default_value": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "description": "What slack channel should we send the message to?", "label": "To date", "name": "severity", "optional": true, "type": "IncidentSeverity" } ], "items": { "$ref": "#/components/schemas/EngineParamV2" }, "type": "array" }, "path": { "description": "The nodes that form the levels and branches of this template.", "example": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "items": { "$ref": "#/components/schemas/EscalationPathTemplateNodeV2" }, "type": "array" }, "repeat_config": { "$ref": "#/components/schemas/EscalationPathRepeatConfigV2" }, "working_hours": { "description": "The working hours for this template.", "example": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ], "items": { "$ref": "#/components/schemas/WeekdayIntervalConfigV2" }, "type": "array" } }, "required": [ "id", "name", "params", "path", "expressions", "has_historical_escalation_path_versions" ], "type": "object" }, "ExpressionPayloadV2": { "example": { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "reference": "abc123", "root_reference": "incident.status" }, "properties": { "else_branch": { "$ref": "#/components/schemas/ExpressionElseBranchPayloadV2" }, "label": { "description": "The human readable label of the expression", "example": "Team Slack channel", "type": "string" }, "operations": { "example": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } } ], "items": { "$ref": "#/components/schemas/ExpressionOperationPayloadV2" }, "type": "array" }, "reference": { "description": "A short ID that can be used to reference the expression", "example": "abc123", "type": "string" }, "root_reference": { "description": "The root reference for this expression (i.e. where the expression starts)", "example": "incident.status", "type": "string" } }, "required": [ "label", "reference", "root_reference", "operations" ], "type": "object" }, "EngineParamV2": { "example": { "allowed_value_types": [ "literal" ], "array": true, "default_value": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "description": "What slack channel should we send the message to?", "label": "To date", "name": "severity", "optional": true, "type": "IncidentSeverity" }, "properties": { "allowed_value_types": { "description": "Which kinds of binding the dashboard should offer for this parameter. When empty, all types are allowed.", "example": [ "literal" ], "items": { "enum": [ "literal", "reference", "expression" ], "example": "literal", "type": "string" }, "type": "array" }, "array": { "description": "Whether this parameter is an array", "example": true, "type": "boolean" }, "default_value": { "$ref": "#/components/schemas/EngineParamBindingV2" }, "description": { "description": "A string describing the param", "example": "What slack channel should we send the message to?", "type": "string" }, "label": { "description": "Human readable label for this parameter", "example": "To date", "type": "string" }, "name": { "description": "The unique identifier for the parameter", "example": "severity", "type": "string" }, "optional": { "description": "Whether this parameter is optional", "example": true, "type": "boolean" }, "type": { "description": "The type of the parameter", "example": "IncidentSeverity", "type": "string" } }, "required": [ "name", "label", "type", "array", "optional", "description" ], "type": "object" }, "EscalationPathTemplateNodePayloadV2": { "example": { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" }, "properties": { "delay": { "$ref": "#/components/schemas/EscalationPathNodeDelayV2" }, "escalation_path": { "$ref": "#/components/schemas/EscalationPathNodeEscalationPathV2" }, "id": { "description": "An ID for this node, unique within the escalation path.\n\nThis allows you to reference the node in other nodes, such as when configuring a 'repeat' node.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "if_else": { "$ref": "#/components/schemas/EscalationPathTemplateNodeIfElsePayloadV2" }, "level": { "$ref": "#/components/schemas/EscalationPathNodeLevelWithBindingPayloadV2" }, "notify_channel": { "$ref": "#/components/schemas/EscalationPathNodeNotifyChannelWithBindingPayloadV2" }, "repeat": { "$ref": "#/components/schemas/EscalationPathNodeRepeatV2" }, "type": { "description": "The type of this node. Available types are:\n* level: A set of targets (users or schedules) that should be paged, either all at once, or with a round-robin configuration.\n* notify_channel: Send the escalation to a Slack channel, where it can be acked by anyone in the channel.\n* if_else: Branch the escalation based on a set of conditions.\n* repeat: Go back to a previous node and repeat the logic from there.\n* delay: Pause the escalation for a configured duration before advancing to the next node.\n* escalation_path: Reassign the escalation to another escalation path, continuing from that path's first node.\n* voicemail: Send an inbound caller to voicemail. Only valid inside a call route's path.", "enum": [ "if_else", "repeat", "level", "notify_channel", "delay", "voicemail", "escalation_path" ], "example": "if_else", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "EscalationPathRepeatConfigV2": { "example": { "delay_repeat_on_activity": false, "repeat_after_seconds": 1800 }, "properties": { "delay_repeat_on_activity": { "default": false, "description": "When true, incident activity resets the repeat timer.", "example": false, "type": "boolean" }, "repeat_after_seconds": { "description": "Number of seconds we'll wait before repeating an escalation.", "example": 1800, "format": "int32", "maximum": 345600, "minimum": 300, "type": "integer" } }, "required": [ "repeat_after_seconds", "delay_repeat_on_activity" ], "type": "object" }, "WeekdayIntervalConfigV2": { "example": { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] }, "properties": { "id": { "description": "The unique identifier for this set of working intervals", "example": "abc123", "type": "string" }, "name": { "description": "A human readable label for this set of working intervals", "example": "abc123", "type": "string" }, "timezone": { "description": "How to interpret all the intervals", "example": "abc123", "type": "string" }, "weekday_intervals": { "example": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "items": { "$ref": "#/components/schemas/WeekdayIntervalV2" }, "type": "array" } }, "required": [ "id", "name", "timezone", "weekday_intervals" ], "type": "object" }, "EscalationPathV2": { "properties": { "current_responders": { "description": "Users who are currently on-call for this escalation path", "example": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "items": { "$ref": "#/components/schemas/UserV2" }, "type": "array" }, "id": { "description": "Unique identifier for this escalation path.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "kind": { "description": "Whether this path carries its own nodes, or is built from an escalation path template.", "enum": [ "standalone", "templated" ], "example": "templated", "type": "string" }, "name": { "description": "The name of this escalation path, for the user's reference.", "example": "Urgent Support", "type": "string" }, "param_bindings": { "additionalProperties": { "$ref": "#/components/schemas/EngineParamBindingV2" }, "description": "For a templated path, the values bound to the template's declared parameters, keyed by parameter name.", "example": { "abc123": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "type": "object" }, "path": { "description": "The nodes that form the levels and branches of this escalation path. Empty for a templated path, which takes them from its template.", "example": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "items": { "$ref": "#/components/schemas/EscalationPathNodeV2" }, "type": "array" }, "repeat_config": { "$ref": "#/components/schemas/EscalationPathRepeatConfigV2" }, "team_ids": { "description": "IDs of the teams that own this escalation path. This will automatically sync escalation paths with the right teams in Catalog. If you have an escalation paths attribute on your Teams, this attribute is required.", "example": [ "01JPQA75EPNEES4479P16P4XAB" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "template_id": { "description": "For a templated path, the template it is built from.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "working_hours": { "description": "The working hours for this escalation path. Absent for a templated path, which takes them from its template.", "example": [ { "id": "abc123", "name": "abc123", "timezone": "abc123", "weekday_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ], "items": { "$ref": "#/components/schemas/WeekdayIntervalConfigV2" }, "type": "array" } }, "required": [ "id", "name", "path", "kind", "team_ids" ], "type": "object" }, "EngineParamBindingPayloadV2": { "example": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "properties": { "array_value": { "description": "If set, this is the array value of the step parameter", "example": [ { "literal": "SEV123", "reference": "incident.severity" } ], "items": { "$ref": "#/components/schemas/EngineParamBindingValuePayloadV2" }, "type": "array" }, "value": { "$ref": "#/components/schemas/EngineParamBindingValuePayloadV2" } }, "type": "object" }, "EscalationPathNodePayloadV2": { "example": { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" }, "properties": { "delay": { "$ref": "#/components/schemas/EscalationPathNodeDelayV2" }, "escalation_path": { "$ref": "#/components/schemas/EscalationPathNodeEscalationPathV2" }, "id": { "description": "An ID for this node, unique within the escalation path.\n\nThis allows you to reference the node in other nodes, such as when configuring a 'repeat' node.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "if_else": { "$ref": "#/components/schemas/EscalationPathNodeIfElsePayloadV2" }, "level": { "$ref": "#/components/schemas/EscalationPathNodeLevelV2" }, "notify_channel": { "$ref": "#/components/schemas/EscalationPathNodeNotifyChannelV2" }, "repeat": { "$ref": "#/components/schemas/EscalationPathNodeRepeatV2" }, "type": { "description": "The type of this node. Available types are:\n* level: A set of targets (users or schedules) that should be paged, either all at once, or with a round-robin configuration.\n* notify_channel: Send the escalation to a Slack channel, where it can be acked by anyone in the channel.\n* if_else: Branch the escalation based on a set of conditions.\n* repeat: Go back to a previous node and repeat the logic from there.\n* delay: Pause the escalation for a configured duration before advancing to the next node.\n* escalation_path: Reassign the escalation to another escalation path, continuing from that path's first node.\n* voicemail: Send an inbound caller to voicemail. Only valid inside a call route's path.", "enum": [ "if_else", "repeat", "level", "notify_channel", "delay", "voicemail", "escalation_path" ], "example": "if_else", "type": "string" } }, "required": [ "id", "type" ], "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" }, "description": { "description": "Additional detail provided with this escalation. When it isn't set explicitly, this is taken from the alert description or the incident summary, and is empty when neither applies.", "example": "Database CPU has been above 90% for 5 minutes", "type": "string" }, "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", "description", "priority", "creator", "events", "related_incidents", "related_alerts" ], "type": "object" }, "EscalationUserResponseOptionsV2": { "example": { "available_actions": [ "ack", "nack", "snooze" ], "user_id": "01G0J1EXE7AXZ2C93K61WBPYEH" }, "properties": { "available_actions": { "description": "The response actions this user can currently take on the escalation. Empty if the user can't respond to it at all.", "example": [ "ack", "nack", "snooze" ], "items": { "description": "An action a user can take in response to an escalation", "enum": [ "ack", "nack", "snooze" ], "example": "ack", "type": "string", "x-public-api-version": "v2" }, "type": "array" }, "user_id": { "description": "The ID of the user these response options are for", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } }, "required": [ "user_id", "available_actions" ], "type": "object" }, "EscalationRespondSnoozeDetailsPayloadV2": { "example": { "reason": "Waiting for deployment to complete", "snooze_until": "2025-01-01T12:00:00Z" }, "properties": { "reason": { "description": "Optional reason for snoozing the escalation", "example": "Waiting for deployment to complete", "type": "string" }, "snooze_until": { "description": "The time at which the snooze should end", "example": "2025-01-01T12:00:00Z", "format": "date-time", "type": "string" } }, "required": [ "snooze_until" ], "type": "object" }, "FollowUpV3": { "properties": { "assignee": { "$ref": "#/components/schemas/UserV2" }, "assignee_team": { "$ref": "#/components/schemas/TeamSlimV2" }, "category": { "$ref": "#/components/schemas/FollowUpCategoryV3" }, "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" }, "IncidentActivityLogEntryV2": { "description": "One thing that happened on an incident.\n\nThe activity log records everything. The timeline is the narrative, made of the entries\nsomeone promoted onto it and the items they wrote by hand.", "properties": { "content": { "$ref": "#/components/schemas/IncidentActivityLogContentV2" }, "created_at": { "description": "When we recorded the activity", "example": "2026-09-01T15:30:01Z", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the activity log entry", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_id": { "description": "ID of the incident this happened on. When the incident has streams, listing the parent also returns entries from its streams, and this is the stream's ID for those.", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "occurred_at": { "description": "When the activity happened. This is what the log is ordered by.", "example": "2026-09-01T15:30:00Z", "format": "date-time", "type": "string" }, "title": { "description": "Human-readable summary of what happened", "example": "Status changed from Investigating to Monitoring", "type": "string" }, "type": { "description": "What kind of activity this is. Switch on this rather than title, which is display copy we reword.", "enum": [ "slack_pin", "microsoft_teams_pinned_channel_message", "summary_update", "role_update", "handover", "slack_infer_sentry", "slack_image", "microsoft_teams_image", "slack_message", "incident_channel_join", "incident_channel_leave", "incident_escalate", "action_created", "action_updated", "follow_up_created", "follow_up_updated", "actions_shared_in_channel", "follow_ups_shared_in_channel", "status_change", "atlassian_statuspage_update", "incident_update", "custom_field_value_update", "incident_membership_revoked", "incident_visibility_changed", "incident_rename", "incident_attachment_added", "incident_attachment_removed", "alert_attached_to_incident", "alert_group_attached_to_incident", "alert_group_detached_from_incident", "pagerduty_incident_triggered", "pagerduty_incident_acknowledged", "pagerduty_incident_resolved", "incident_timestamp_set", "incident_timestamp_occurred", "incident_merged", "incident_type_changed", "status_page_incident_linked", "status_page_incident_updated", "user_intent_declared", "call_url_changed", "postmortem_changed", "postmortem_document_v2_changed", "incident_channel_created", "scrub", "escalation_created", "escalation_acknowledged", "incident_call_created", "incident_call_started", "incident_call_ended", "incident_call_participants_updated", "microsoft_teams_message", "microsoft_teams_announcement_reply", "incident_call_transcript_message", "incident_call_transcript_summary_generated", "incident_call_transcript_key_moment_generated", "incident_call_transcript_current_topic_generated", "incident_call_recall_bot_status_changed", "scribe_added", "scribe_removed", "external_issue_comment_synced", "investigation_hypothesis_update", "workflow_ran" ], "example": "incident_update", "type": "string" } }, "required": [ "id", "incident_id", "type", "title", "occurred_at", "created_at" ], "type": "object" }, "IncidentAttachmentV1": { "properties": { "id": { "description": "Unique identifier of this incident membership", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "incident_id": { "description": "Unique identifier of the incident", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "resource": { "$ref": "#/components/schemas/ExternalResourceV1" } }, "required": [ "id", "incident_id", "resource" ], "type": "object" }, "IncidentMembershipV1": { "properties": { "created_at": { "description": "When the membership was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of this incident membership", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "incident_id": { "description": "Unique identifier of the incident", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "updated_at": { "description": "When the membership was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "user": { "$ref": "#/components/schemas/UserV1" } }, "required": [ "id", "user", "incident_id", "created_at", "updated_at" ], "type": "object" }, "IncidentRelationshipV1": { "properties": { "id": { "description": "Unique identifier of this incident relationship", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "incident": { "$ref": "#/components/schemas/IncidentRelationshipDetailsV1" } }, "required": [ "id", "incident" ], "type": "object" }, "IncidentRoleV2": { "properties": { "created_at": { "description": "When the role was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "Describes the purpose of the role", "example": "The person currently coordinating the incident", "minLength": 1, "type": "string" }, "id": { "description": "Unique identifier for the role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "instructions": { "description": "Provided to whoever is nominated for the role. Note that this will be empty for the 'reporter' role.", "example": "Take point on the incident; Make sure people are clear on responsibilities", "type": "string" }, "name": { "description": "Human readable name of the incident role", "example": "Incident Lead", "minLength": 1, "type": "string" }, "role_type": { "description": "Type of incident role", "enum": [ "lead", "reporter", "custom" ], "example": "lead", "type": "string" }, "shortform": { "description": "Short human readable name for Slack. Note that this will be empty for the 'reporter' role.", "example": "lead", "type": "string" }, "updated_at": { "description": "When the role was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "name", "shortform", "description", "instructions", "id", "role_type", "created_at", "updated_at" ], "type": "object" }, "IncidentStatusV1": { "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" }, "IncidentTemplateV1": { "description": "A reusable set of values applied to incidents created from alerts.", "properties": { "created_at": { "description": "When this incident template was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "expressions": { "description": "The expressions used by bindings in this template", "example": [ { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionV3" }, "type": "array" }, "id": { "description": "Unique identifier for this incident template", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "The name of this incident template, for the user's reference", "example": "Payments incidents", "type": "string" }, "template": { "$ref": "#/components/schemas/IncidentTemplateConfigV1" }, "updated_at": { "description": "When this incident template was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "template", "created_at", "updated_at" ], "type": "object" }, "IncidentTemplateConfigPayloadV1": { "description": "The values an incident template applies to the incidents it creates.", "example": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "properties": { "custom_fields": { "description": "Custom fields configuration", "example": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "items": { "$ref": "#/components/schemas/IncidentTemplateCustomFieldBindingPayloadV1" }, "type": "array" }, "incident_mode": { "$ref": "#/components/schemas/IncidentTemplateBindingPayloadV1" }, "incident_type": { "$ref": "#/components/schemas/IncidentTemplateBindingPayloadV1" }, "name": { "$ref": "#/components/schemas/IncidentTemplateAutoGeneratedBindingPayloadV1" }, "severity": { "$ref": "#/components/schemas/IncidentTemplateSeverityBindingPayloadV1" }, "start_in_triage": { "$ref": "#/components/schemas/IncidentTemplateBindingPayloadV1" }, "summary": { "$ref": "#/components/schemas/IncidentTemplateAutoGeneratedBindingPayloadV1" }, "workspace": { "$ref": "#/components/schemas/IncidentTemplateBindingPayloadV1" } }, "required": [ "name" ], "type": "object" }, "IncidentTemplateValidateWarningV1": { "description": "Something suspect about a template config that isn't severe enough to reject it.", "example": { "detail": "Creating a new template with this name will fail. Updating the template that already has it keeps working.", "summary": "An incident template with this name already exists" }, "properties": { "detail": { "description": "More detail about the warning and what to do about it", "example": "Creating a new template with this name will fail. Updating the template that already has it keeps working.", "type": "string" }, "summary": { "description": "A short description of the warning", "example": "An incident template with this name already exists", "type": "string" } }, "required": [ "summary", "detail" ], "type": "object" }, "IncidentTimelineItemV2": { "description": "An item on an incident's curated timeline.\n\nThe timeline is the narrative of an incident, as opposed to the activity log, which records\neverything that happened. Some of that activity - a pinned message, an escalation, an event a\nworkflow added - is promoted onto the timeline, and those items carry the ID of the activity\nlog entry they came from. The rest are custom, written by hand in the dashboard or through\nthe API, and have no activity_log_id.", "properties": { "activity_log_id": { "description": "ID of the activity log entry this item was promoted from. Null for items written by hand, which are the items whose timestamp can be changed.", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" }, "created_at": { "description": "When this item was added to the timeline", "example": "2026-09-01T15:31:04Z", "format": "date-time", "type": "string" }, "creator": { "$ref": "#/components/schemas/ActorV2" }, "description": { "description": "Description of the timeline item, in markdown. Absent when the item has no description.", "example": "Rolled back **payments-api** to v411 after error rate hit 12%.", "type": "string" }, "id": { "description": "Unique identifier of the timeline item", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_id": { "description": "ID of the incident this item belongs to. When the incident has streams, listing the parent also returns items belonging to its streams, and this is the stream's ID for those.", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "timestamp": { "description": "When the thing this item describes happened. This is what the timeline is ordered by, and is not the same as created_at.", "example": "2026-09-01T15:30:00Z", "format": "date-time", "type": "string" }, "title": { "description": "Title of the timeline item", "example": "Rolled back payments-api", "type": "string" }, "updated_at": { "description": "When this item was last edited", "example": "2026-09-01T16:45:00Z", "format": "date-time", "type": "string" } }, "required": [ "id", "incident_id", "timestamp", "title", "creator", "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" }, "IncidentTypeV1": { "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" }, "owning_team_ids": { "description": "IDs of the teams that own this incident type", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "type": "array" }, "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" }, "IncidentUpdateV2": { "properties": { "created_at": { "description": "When the update was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier for this incident update", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_id": { "description": "The incident this update relates to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "merged_into_incident_id": { "description": "The ID of the incident this incident was merged into, if the to state of this update is 'merged'.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "message": { "description": "Message that explains the context behind the update", "example": "We're working on a fix, hoping to ship in the next 30 minutes", "type": "string" }, "new_incident_status": { "$ref": "#/components/schemas/IncidentStatusV2" }, "new_severity": { "$ref": "#/components/schemas/SeverityV2" }, "updater": { "$ref": "#/components/schemas/ActorV2" } }, "required": [ "id", "incident_id", "new_incident_status", "updater", "created_at" ], "type": "object" }, "IncidentParticipantsV2": { "example": { "active": [ { "participant_type": "observer", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "passive": [ { "participant_type": "observer", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ] }, "properties": { "active": { "description": "Participants who are actively helping with the incident", "example": [ { "participant_type": "observer", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "items": { "$ref": "#/components/schemas/IncidentParticipantV2" }, "type": "array" }, "passive": { "description": "Participants who are just observing the incident", "example": [ { "participant_type": "observer", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "items": { "$ref": "#/components/schemas/IncidentParticipantV2" }, "type": "array" } }, "required": [ "active", "passive" ], "type": "object" }, "IncidentParticipantWorkloadV2": { "properties": { "archived_at": { "description": "When the user left the incident, if they are no longer an active participant", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "participant_type": { "description": "The role they had in the incident", "enum": [ "observer", "collaborator", "responder" ], "example": "observer", "type": "string" }, "user": { "$ref": "#/components/schemas/UserV2" }, "workload": { "$ref": "#/components/schemas/WorkloadMinutesV2" } }, "required": [ "user", "workload" ], "type": "object" }, "WorkloadMetadataV2": { "example": { "data_synced_at": "2021-08-17T13:00:00Z" }, "properties": { "data_synced_at": { "description": "The time the workload figures are calculated up to. Workload is complete up to this time. Null if we have not calculated any workload for this incident yet.", "example": "2021-08-17T13:00:00Z", "format": "date-time", "type": "string" } }, "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" }, "last_activity_at": { "description": "When the incident last recorded 'activity'", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "mode": { "description": "Whether the incident is real, a test, a tutorial, or importing as a retrospective incident", "enum": [ "standard", "retrospective", "test", "tutorial" ], "example": "standard", "type": "string" }, "ms_teams_channel_url": { "description": "URL to link to the Microsoft Teams channel", "example": "https://teams.microsoft.com/l/channel/19%some-hex%40thread.tacv2/inc-123-title?groupId=some-uuid&tenantId=another-uuid", "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_channel_url": { "description": "URL to link to the slack channel", "example": "https://slack.com/app_redirect?team=T1234&channel=C5678", "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" }, "team_ids": { "description": "IDs of the teams that own this incident, resolved from your team settings. Empty when no teams match.", "example": [ "01JPQA75EPNEES4479P16P4XAB" ], "items": { "example": "01JPQA75EPNEES4479P16P4XAB", "type": "string" }, "type": "array" }, "updated_at": { "description": "When the incident was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "visibility": { "description": "Whether the incident should be open to anyone in your Slack workspace (public), or invite-only (private). For more information on Private Incidents see our [docs](https://docs.incident.io/incidents/sensitive-incidents).", "enum": [ "public", "private" ], "example": "public", "type": "string" }, "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", "last_activity_at", "team_ids", "id", "reference", "name", "visibility", "mode", "creator", "incident_role_assignments", "custom_field_entries", "slack_team_id", "slack_channel_id", "created_at", "updated_at" ], "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" }, "CustomFieldEntryPayloadV2": { "example": { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] }, "properties": { "custom_field_id": { "description": "ID of the custom field this entry is linked against", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "values": { "description": "List of values to associate with this entry. Use an empty array to unset the value of the custom field.", "example": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ], "items": { "$ref": "#/components/schemas/CustomFieldValuePayloadV2" }, "type": "array" } }, "required": [ "custom_field_id", "values" ], "type": "object" }, "IncidentRoleAssignmentPayloadV2": { "example": { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" }, "properties": { "assignee": { "$ref": "#/components/schemas/UserReferencePayloadV2" }, "incident_role_id": { "description": "Unique ID of an incident role. Note that the 'reporter' role can only be assigned when creating an incident.", "example": "01FH5TZRWMNAFB0DZ23FD1TV96", "type": "string" } }, "required": [ "incident_role_id" ], "type": "object" }, "IncidentTimestampValuePayloadV2": { "example": { "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYD5H", "value": "2021-08-17T13:28:57.801578Z" }, "properties": { "incident_timestamp_id": { "description": "The id of the incident timestamp that this incident timestamp value is associated with.", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "value": { "description": "The current value of this timestamp, for this incident", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "incident_timestamp_id" ], "type": "object" }, "RetrospectiveIncidentOptionsV2": { "example": { "external_id": 123, "postmortem_document_url": "https://docs.google.com/my_doc_id", "slack_channel_id": "abc123" }, "properties": { "external_id": { "description": "The external ID (e.g. the 123 in INC-123) to assign to the incident. This can be useful when importing incidents. If you want to use this field, you'll need to talk to us first.", "example": 123, "format": "int64", "type": "integer" }, "postmortem_document_url": { "description": "The URL of the postmortem, if there is one", "example": "https://docs.google.com/my_doc_id", "type": "string" }, "slack_channel_id": { "description": "Pass the ID of a Slack channel to attach the incident to an existing channel. If not provided, no Slack channel will be created for this retrospective incident.", "example": "abc123", "type": "string" } }, "type": "object" }, "IncidentEditPayloadV2": { "example": { "call_url": "https://zoom.us/foo", "custom_field_entries": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] } ], "incident_role_assignments": [ { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" } ], "incident_status_id": "abc123", "incident_timestamp_values": [ { "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYD5H", "value": "2021-08-17T13:28:57.801578Z" } ], "name": "Our database is sad", "severity_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_channel_name_override": "inc-123-database-down", "summary": "Our database is really really sad, and we don't know why yet." }, "properties": { "call_url": { "description": "The call URL attached to this incident", "example": "https://zoom.us/foo", "type": "string" }, "custom_field_entries": { "description": "Set the incident's custom fields to these values", "example": [ { "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "values": [ { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" } ] } ], "items": { "$ref": "#/components/schemas/CustomFieldEntryPayloadV2" }, "type": "array" }, "incident_role_assignments": { "description": "Assign incident roles to these people", "example": [ { "assignee": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "incident_role_id": "01FH5TZRWMNAFB0DZ23FD1TV96" } ], "items": { "$ref": "#/components/schemas/IncidentRoleAssignmentPayloadV2" }, "type": "array" }, "incident_status_id": { "description": "Incident status to move the incident to. Allowed transitions are:\n\n- Moving between statuses within the same category (e.g. between active statuses)\n- Resolving an incident by moving from active/triage to a post-incident or closed status\n- Closing an incident from a post-incident status\n\nWhen resolving to a post-incident status, the incident enters the post-incident flow and tasks are created. The status must belong to the post-incident flow that applies to this incident based on its severity, incident type, and other properties. If you specify a status from a different post-incident flow, the request will fail with a validation error.\n\nWhen resolving directly to closed, any configured post-incident flow is skipped entirely. This requires the 'Close incidents by opting out of post-incident flow' permission on the API key, if your incident lifecycle normally requires you to run a post-incident flow for this incident.\n\nNote: Once an incident is in the post-incident flow, its status is managed automatically based on task completion. Moving between post-incident statuses via the API is not recommended as the system will recalculate the correct status when tasks are updated.", "example": "abc123", "type": "string" }, "incident_timestamp_values": { "description": "Assign the incident's timestamps to these values", "example": [ { "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYD5H", "value": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/IncidentTimestampValuePayloadV2" }, "type": "array" }, "name": { "description": "Explanation of the incident", "example": "Our database is sad", "type": "string" }, "severity_id": { "description": "The ID of the current severity of this incident", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "slack_channel_name_override": { "description": "Override the name of the incident Slack channel", "example": "inc-123-database-down", "type": "string" }, "summary": { "description": "Detailed description of the incident", "example": "Our database is really really sad, and we don't know why yet.", "type": "string" } }, "type": "object" }, "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" }, "IPAllowlistV1": { "properties": { "allowlist": { "description": "A list of IP addresses or CIDR prefixes to allow", "example": [ { "label": "London HQ", "value": "192.0.2.0" } ], "items": { "$ref": "#/components/schemas/IPAllowlistItemV1" }, "type": "array" }, "enabled": { "description": "Whether this IP allowlist is enabled or not", "example": true, "type": "boolean" }, "updated_at": { "description": "The time this allowlist was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "version": { "description": "The version of this IP allowlist", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "version", "enabled", "allowlist" ], "type": "object" }, "IPAllowlistItemV1": { "example": { "label": "London HQ", "value": "192.0.2.0" }, "properties": { "label": { "description": "A label to help identify this IP or prefix", "example": "London HQ", "type": "string" }, "value": { "description": "An IP address or a CIDR IP prefix to allow", "example": "192.0.2.0", "type": "string" } }, "required": [ "value" ], "type": "object" }, "MaintenanceWindowV1": { "properties": { "alert_condition_groups": { "description": "Condition groups that determine which alerts this maintenance window applies to", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV2" }, "type": "array" }, "archived_at": { "description": "When this maintenance window was archived, if it has been", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "created_at": { "description": "When this maintenance window was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "end_at": { "description": "When the maintenance window ends", "example": "2021-08-17T14:28:57.801578Z", "format": "date-time", "type": "string" }, "escalation_targets": { "description": "If set, alerts matching this window will be escalated to these targets", "example": [ { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/MaintenanceWindowEscalationTargetV1" }, "type": "array" }, "id": { "description": "Unique identifier for this maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_id": { "description": "If set, alerts matching this window will be automatically attached to this incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "lead": { "$ref": "#/components/schemas/ActorV2" }, "name": { "description": "Human readable name for the maintenance window", "example": "Planned database migration", "type": "string" }, "notification_message": { "description": "Custom message included in notifications about this maintenance window", "example": "Scheduled downtime for database migration", "type": "string" }, "notify_channels": { "description": "Channels to notify about the maintenance window starting and ending", "example": [ { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false } ], "items": { "$ref": "#/components/schemas/MaintenanceWindowNotifyChannelV1" }, "type": "array" }, "notify_end_minutes_before": { "description": "Minutes before the end to send a notification to the configured channels", "example": 5, "format": "int64", "type": "integer" }, "notify_start_minutes_before": { "description": "Minutes before the start to send a notification to the configured channels", "example": 15, "format": "int64", "type": "integer" }, "reroute_on_end": { "description": "Whether to retrigger firing alerts through alert routing when the window ends", "example": false, "type": "boolean" }, "resolve_on_end": { "description": "Whether to automatically resolve all firing alerts that matched this window when it ends", "example": false, "type": "boolean" }, "show_in_sidebar": { "description": "Whether to show this maintenance window in the dashboard sidebar when active", "example": true, "type": "boolean" }, "start_at": { "description": "When the maintenance window starts", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "updated_at": { "description": "When this maintenance window was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "lead", "start_at", "end_at", "alert_condition_groups", "resolve_on_end", "reroute_on_end", "show_in_sidebar", "created_at", "updated_at" ], "type": "object" }, "MaintenanceWindowEscalationTargetPayloadV1": { "example": { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "escalation_paths": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "users": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" } }, "type": "object" }, "UserReferencePayloadV2": { "example": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "properties": { "email": { "description": "The user's email address, matching the email on their Slack account", "example": "bob@example.com", "type": "string" }, "id": { "description": "The incident.io ID of a user", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "slack_user_id": { "description": "The ID of the user's Slack account.", "example": "USER123", "type": "string" } }, "type": "object" }, "MaintenanceWindowNotifyChannelPayloadV1": { "description": "A channel to receive notifications about this maintenance window", "example": { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public" }, "properties": { "channel_id": { "description": "The external provider channel ID (e.g. Slack channel ID)", "example": "C0ACTHQMHS8", "type": "string" }, "channel_name": { "description": "Human readable name of the channel", "example": "general", "type": "string" }, "channel_type": { "description": "The type of channel (e.g. public, private)", "example": "public", "type": "string" } }, "required": [ "channel_id", "channel_type" ], "type": "object" }, "PolicyV2": { "properties": { "assignment_rules": { "$ref": "#/components/schemas/PolicyAssignmentRulesV2" }, "conditions": { "description": "Conditions which determine which resources are in scope for this policy", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV2" }, "type": "array" }, "created_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "debrief": { "$ref": "#/components/schemas/PolicyDebriefV2" }, "description": { "description": "Human readable description of the policy", "example": "All critical incidents must export follow-ups to an external issue tracker before 7 days has passed since closure.", "type": "string" }, "expressions": { "description": "The expressions relating to this policy", "example": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionV2" }, "type": "array" }, "follow_up": { "$ref": "#/components/schemas/PolicyFollowUpV2" }, "id": { "description": "Unique ID of the policy", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "name": { "description": "Human readable name of the policy", "example": "Critical incidents must export follow-ups", "type": "string" }, "on_call_readiness": { "$ref": "#/components/schemas/PolicyOnCallReadinessV2" }, "policy_type": { "description": "Type of the policy, specifying what this applies to", "enum": [ "debrief", "follow_up", "on_call_readiness", "post_mortem", "schedule", "vacation_conflict" ], "example": "follow_up", "type": "string" }, "post_mortem": { "$ref": "#/components/schemas/PolicyPostMortemV2" }, "schedule": { "$ref": "#/components/schemas/PolicyScheduleV2" }, "status": { "description": "Disabled policies stop evaluating but keep their config", "enum": [ "enabled", "disabled" ], "example": "enabled", "type": "string" }, "updated_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "policy_type", "status", "conditions", "created_at", "updated_at" ], "type": "object" }, "PolicyAssignmentRulesPayloadV2": { "example": { "bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "reminder_cadence_after": { "interval": "daily" }, "reminder_cadence_before": { "interval": "daily" }, "reminder_detected_date_offset_hours": [ 0, 48 ], "reminder_due_date_offset_hours": [ -24, 0, 24 ] }, "properties": { "bindings": { "description": "Bindings which define the user to be assigned. We will assign the first user which evaluates; the rest are fallback values", "example": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "items": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "type": "array" }, "reminder_cadence_after": { "$ref": "#/components/schemas/PolicyReminderCadenceV2" }, "reminder_cadence_before": { "$ref": "#/components/schemas/PolicyReminderCadenceV2" }, "reminder_detected_date_offset_hours": { "description": "List of hours relative to when the finding was detected to remind the assignee. Non-negative only; 0 means immediately on detection. Only valid for policy types that support detection reminders (e.g. schedule).", "example": [ 0, 48 ], "items": { "example": 1, "format": "int64", "type": "integer" }, "type": "array" }, "reminder_due_date_offset_hours": { "description": "List of hours relative to the due date to remind the assignee. Negative values are before the due date, positive after.", "example": [ -24, 0, 24 ], "items": { "example": 1, "format": "int64", "type": "integer" }, "type": "array" } }, "required": [ "bindings", "reminder_due_date_offset_hours" ], "type": "object" }, "PolicyDebriefPayloadV2": { "description": "Set when policy_type is debrief.", "example": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "run_on_private_incidents": false }, "properties": { "due_date_config": { "$ref": "#/components/schemas/PolicyDueDateConfigPayloadV2" }, "requirements": { "description": "Conditions a debrief must satisfy to be compliant", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" }, "run_on_private_incidents": { "description": "Requires the policies.run_on_private scope", "example": false, "type": "boolean" } }, "required": [ "requirements" ], "type": "object" }, "PolicyFollowUpPayloadV2": { "description": "Set when policy_type is follow_up.", "example": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "run_on_private_incidents": false }, "properties": { "due_date_config": { "$ref": "#/components/schemas/PolicyDueDateConfigPayloadV2" }, "requirements": { "description": "Conditions a follow-up must satisfy to be compliant, e.g. 'is exported to Jira'", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" }, "run_on_private_incidents": { "description": "Requires the policies.run_on_private scope", "example": false, "type": "boolean" } }, "required": [ "requirements" ], "type": "object" }, "PolicyOnCallReadinessV2": { "description": "Set when policy_type is on_call_readiness. The assignee is always the user the finding is about and cannot be configured.", "example": { "enforcement": "advisory", "high_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ] }, "properties": { "enforcement": { "description": "advisory reports only; blocking also prevents users saving non-compliant notification rules. Defaults to advisory.", "enum": [ "advisory", "blocking" ], "example": "advisory", "type": "string" }, "high_urgency": { "example": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ], "items": { "$ref": "#/components/schemas/PolicyReadinessRuleV2" }, "type": "array" }, "low_urgency": { "example": [ { "max_delay_seconds": 300, "method_types": [ "slack" ] } ], "items": { "$ref": "#/components/schemas/PolicyReadinessRuleV2" }, "type": "array" } }, "type": "object" }, "PolicyPostMortemPayloadV2": { "description": "Set when policy_type is post_mortem.", "example": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "run_on_private_incidents": false }, "properties": { "due_date_config": { "$ref": "#/components/schemas/PolicyDueDateConfigPayloadV2" }, "requirements": { "description": "Conditions a post-mortem must satisfy to be compliant", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" }, "run_on_private_incidents": { "description": "Requires the policies.run_on_private scope", "example": false, "type": "boolean" } }, "required": [ "requirements" ], "type": "object" }, "PolicyScheduleV2": { "description": "Detects gaps in on-call coverage. Set when policy_type is schedule.", "example": { "evaluation_level": "schedule", "requirement_type": "contiguous" }, "properties": { "evaluation_level": { "description": "Evaluate coverage across the whole schedule, or per rotation. Defaults to schedule.", "enum": [ "schedule", "rotation" ], "example": "schedule", "type": "string" }, "requirement_type": { "enum": [ "contiguous" ], "example": "contiguous", "type": "string" } }, "required": [ "requirement_type" ], "type": "object" }, "PolicyFindingV2": { "properties": { "created_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "days": { "description": "Days outside the policy's due date", "example": 3, "format": "int64", "type": "integer" }, "debrief": { "$ref": "#/components/schemas/PolicyFindingDebriefV2" }, "dismissal": { "$ref": "#/components/schemas/PolicyFindingDismissalV2" }, "due_at": { "description": "When this finding becomes overdue", "example": "2025-10-14T00:00:00.000000Z", "format": "date-time", "type": "string" }, "follow_up": { "$ref": "#/components/schemas/PolicyFindingFollowUpV2" }, "id": { "description": "Unique ID of the finding", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "last_checked_at": { "description": "When this finding was last re-evaluated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "on_call_readiness": { "$ref": "#/components/schemas/PolicyFindingOnCallReadinessV2" }, "policy_id": { "description": "The policy this finding was raised against", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "policy_type": { "description": "Type of the policy this finding was raised against", "enum": [ "debrief", "follow_up", "on_call_readiness", "post_mortem", "schedule", "vacation_conflict" ], "example": "follow_up", "type": "string" }, "post_mortem": { "$ref": "#/components/schemas/PolicyFindingPostMortemV2" }, "responsible_users": { "description": "Who is expected to resolve this finding", "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/PolicyFindingScheduleV2" }, "state": { "description": "Where this finding is in its lifecycle", "enum": [ "pending", "active", "resolved", "cancelled", "dismissed" ], "example": "active", "type": "string" }, "updated_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "vacation_conflict": { "$ref": "#/components/schemas/PolicyFindingVacationConflictV2" } }, "required": [ "id", "policy_id", "policy_type", "state", "responsible_users", "last_checked_at", "created_at", "updated_at" ], "type": "object" }, "ScheduleSyncTargetResourceV2": { "description": "A sync target is the link between incident.io and a single Slack user group,\nused to keep that group's membership in step with who is currently on call.\n\nA target identifies the group by its Slack user group ID and Slack team ID,\nand remembers whether the incident.io bot should be added to the group so it\ncan manage membership. On its own a target does nothing: you link it to a\nschedule by creating a schedule sync rule (see the Schedules service), and\nthat rule decides which schedule members flow into the group. As the\nschedule's shifts change hands, we update the Slack user group to match.\n\nA single target can be referenced by sync rules on several schedules at once;\nlinked_schedules lists every schedule with an active rule pointing at it.", "properties": { "add_bot_to_group": { "description": "Whether the incident.io bot should be added to the group as a member. This is needed for some Slack configurations to let us manage the group's membership.", "example": true, "type": "boolean" }, "created_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the sync target", "example": "01JXYZ000000000000000000AB", "type": "string" }, "linked_schedules": { "description": "Schedules with an active sync rule pointing at this target", "example": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ] } ], "items": { "$ref": "#/components/schemas/LinkedScheduleV2" }, "type": "array" }, "slack_team_id": { "description": "Slack team (workspace) ID the user group lives in. On Enterprise Grid this identifies which workspace within the org the group belongs to.", "example": "T02A1AZHG3J", "type": "string" }, "slack_user_group_id": { "description": "Slack ID of the user group whose membership is kept in sync. This is the Slack-assigned group ID (starting with 'S'), not the @-handle.", "example": "S06MNNU5BMK", "type": "string" }, "updated_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "slack_user_group_id", "slack_team_id", "add_bot_to_group", "linked_schedules", "created_at", "updated_at" ], "type": "object" }, "ScheduleSyncTargetCreatePayloadV2": { "example": { "add_bot_to_group": true, "annotations": { "incident.io/terraform/version": "3.0.0" }, "new_slack_user_group": { "description": "The team responsible for Project A", "handle": "project-team-a", "name": "Project Team A", "slack_team_id": "T01234567" }, "slack_user_group_id": "S06MNNU5BMK" }, "properties": { "add_bot_to_group": { "description": "Whether the incident.io bot should be added to the group", "example": true, "type": "boolean" }, "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that track metadata about this resource", "example": { "incident.io/terraform/version": "3.0.0" }, "type": "object" }, "new_slack_user_group": { "$ref": "#/components/schemas/NewSlackUserGroupPayloadV2" }, "slack_user_group_id": { "description": "Slack ID of an existing user group to sync to. Mutually exclusive with new_slack_user_group; exactly one must be set.", "example": "S06MNNU5BMK", "type": "string" } }, "required": [ "add_bot_to_group" ], "type": "object" }, "AfterPaginationMetaResultV2": { "example": { "after": "abc123", "after_url": "abc123" }, "properties": { "after": { "description": "The time, if it exists, of the last entry's end time", "example": "abc123", "type": "string" }, "after_url": { "description": "The URL to fetch the next page of entries", "example": "abc123", "type": "string" } }, "required": [ "after", "after_url" ], "type": "object" }, "ScheduleEntriesListPayloadV2": { "description": "The schedule entries for a window of time, grouped by where they come from.\n\n`scheduled` are the entries produced by the schedule's rotation rules before\nany overrides are taken into account. `overrides` are the one-off changes that\napply within the window. `final` is the effective schedule after overrides\nhave been merged in — this is normally the list to use when working out who\nis on-call.", "example": { "final": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "overrides": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "scheduled": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ] }, "properties": { "final": { "description": "The effective schedule after overrides have been merged in", "example": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "items": { "$ref": "#/components/schemas/ScheduleEntryV2" }, "type": "array" }, "overrides": { "description": "Overrides that apply within the requested window", "example": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "items": { "$ref": "#/components/schemas/ScheduleEntryV2" }, "type": "array" }, "scheduled": { "description": "Entries from the schedule's rotation rules, before overrides are applied", "example": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "items": { "$ref": "#/components/schemas/ScheduleEntryV2" }, "type": "array" } }, "required": [ "scheduled", "overrides", "final" ], "type": "object" }, "ScheduleOverrideV2": { "properties": { "created_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "end_at": { "description": "End of the override", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "id": { "description": "Unique internal ID of the schedule override", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "layer_id": { "description": "The layer on the rotation on the schedule that this override applies to", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "rotation_id": { "description": "The rotation on the schedule that this override applies to", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "schedule_id": { "description": "The schedule that this override applies to", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "start_at": { "description": "Start of the override", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "updated_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "user": { "$ref": "#/components/schemas/UserV2" } }, "required": [ "id", "schedule_id", "rotation_id", "layer_id", "start_at", "end_at", "created_at", "updated_at" ], "type": "object" }, "ScheduleV2": { "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that track metadata about this resource", "example": { "incident.io/terraform/version": "3.0.0" }, "type": "object" }, "config": { "$ref": "#/components/schemas/ScheduleConfigV2" }, "created_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "current_shifts": { "description": "Shifts that are ongoing for this schedule", "example": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "items": { "$ref": "#/components/schemas/ScheduleEntryV2" }, "type": "array" }, "holidays_public_config": { "$ref": "#/components/schemas/ScheduleHolidaysPublicConfigV2" }, "id": { "description": "Unique internal ID of the schedule", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "name": { "description": "Human readable name synced from external provider", "example": "Primary On-Call Schedule", "type": "string" }, "next_shifts": { "description": "The shifts after the next changeover. Note that on the list schedules endpoint, this will always be empty if the page size requested is greater than 25.", "example": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "items": { "$ref": "#/components/schemas/ScheduleEntryV2" }, "type": "array" }, "permalink": { "description": "A permanent link to this schedule in the incident.io dashboard", "example": "https://app.incident.io/acme/on-call/schedules/01G0J1EXE7AXZ2C93K61WBPYEH", "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", "team_ids", "permalink", "created_at", "updated_at", "annotations" ], "type": "object" }, "ScheduleCreatePayloadV2": { "example": { "annotations": { "incident.io/terraform/version": "version-of-terraform" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "holidays_public_config": { "country_codes": [ "abc123" ] }, "name": "Primary On-call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "America/Los_Angeles" }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that can track metadata about the schedule", "example": { "incident.io/terraform/version": "version-of-terraform" }, "type": "object" }, "config": { "$ref": "#/components/schemas/ScheduleConfigCreatePayloadV2" }, "holidays_public_config": { "$ref": "#/components/schemas/ScheduleHolidaysPublicConfigPayloadV2" }, "name": { "description": "Name of the schedule", "example": "Primary On-call Schedule", "type": "string" }, "team_ids": { "description": "IDs of teams that own this schedule", "example": [ "01JPQA75EPNEES4479P16P4XAB" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "timezone": { "description": "Timezone of the schedule", "example": "America/Los_Angeles", "type": "string" } }, "type": "object" }, "ScheduleUpdatePayloadV2": { "example": { "annotations": { "incident.io/terraform/version": "version-of-terraform" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "holidays_public_config": { "country_codes": [ "abc123" ] }, "name": "Primary On-call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "America/Los_Angeles" }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that can track metadata about the schedule", "example": { "incident.io/terraform/version": "version-of-terraform" }, "type": "object" }, "config": { "$ref": "#/components/schemas/ScheduleConfigUpdatePayloadV2" }, "holidays_public_config": { "$ref": "#/components/schemas/ScheduleHolidaysPublicConfigPayloadV2" }, "name": { "description": "Name of the schedule", "example": "Primary On-call Schedule", "type": "string" }, "team_ids": { "description": "IDs of teams that own this schedule", "example": [ "01JPQA75EPNEES4479P16P4XAB" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "timezone": { "description": "Timezone of the schedule", "example": "America/Los_Angeles", "type": "string" } }, "type": "object" }, "ScheduleReplicaV2": { "properties": { "created_at": { "description": "When this schedule replica was first created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the schedule replica", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "last_sync_error": { "description": "The most recent error encountered while syncing this replica to the external provider, if any. Common errors include unmapped users or connectivity issues with the external provider. Null if the last sync was successful.", "example": "Failed to find external user for Milly", "type": "string" }, "last_synced_at": { "description": "When the replica was last successfully synced to the external provider. Null if the replica has never been successfully synced.", "example": "2023-11-07T13:33:30Z", "format": "date-time", "type": "string" }, "mirror_window_days": { "description": "How many days ahead to mirror this schedule into the external provider. Defaults to 14 if not set; maximum 90.", "example": 14, "format": "int64", "maximum": 90, "minimum": 1, "type": "integer" }, "replica_fallback_user_id": { "description": "The ID of a user in the external provider that will be assigned whenever nobody is on-call in the incident.io schedule. External providers typically require someone to always be on-call, so this user fills gaps where incident.io has no one scheduled.", "example": "PA7AXXN", "type": "string" }, "replica_provider": { "description": "The external provider where this schedule is replicated to", "enum": [ "native", "pagerduty", "opsgenie", "jsm" ], "example": "pagerduty", "type": "string" }, "replica_provider_id": { "description": "The ID of the schedule in the external provider that this replica syncs to. For PagerDuty this is the schedule ID (e.g. PO8107X), for Opsgenie the schedule ID, and for Jira Service Management the schedule ID.", "example": "PO8107X", "type": "string" }, "schedule_id": { "description": "The ID of the incident.io schedule that this replica is syncing from", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" }, "sources": { "description": "The specific rotation and layer combinations from the schedule that are being replicated. Each source identifies a single layer within a rotation to sync to the external provider.", "example": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ], "items": { "$ref": "#/components/schemas/ScheduleReplicaSourceV2" }, "type": "array" }, "updated_at": { "description": "When this schedule replica was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "user_statuses": { "description": "The mapping status of each incident.io user in the schedule to their corresponding user in the external provider. Users must be mapped for the replica to sync their on-call shifts correctly.", "example": [ { "external_user_id": "PJYTRGS", "user_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ], "items": { "$ref": "#/components/schemas/ScheduleReplicaUserStatusV2" }, "type": "array" } }, "required": [ "id", "schedule_id", "sources", "replica_provider", "replica_provider_id", "replica_fallback_user_id", "user_statuses", "created_at", "updated_at" ], "type": "object" }, "ScheduleReplicaCreatePayloadV2": { "example": { "mirror_window_days": 14, "replica_fallback_user_id": "PA7AXXN", "replica_provider": "pagerduty", "replica_provider_id": "PO8107X", "sources": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ] }, "properties": { "mirror_window_days": { "description": "How many days ahead to mirror this schedule into the external provider. Defaults to 14 if not set; maximum 90.", "example": 14, "format": "int64", "maximum": 90, "minimum": 1, "type": "integer" }, "replica_fallback_user_id": { "description": "The ID of a user in the external provider that will be assigned whenever nobody is on-call in the incident.io schedule. External providers typically require someone to always be on-call, so this user fills gaps where incident.io has no one scheduled.", "example": "PA7AXXN", "type": "string" }, "replica_provider": { "description": "The external provider where this schedule is replicated to", "enum": [ "native", "pagerduty", "opsgenie", "jsm" ], "example": "pagerduty", "type": "string" }, "replica_provider_id": { "description": "The ID of the schedule in the external provider that this replica syncs to. For PagerDuty this is the schedule ID (e.g. PO8107X), for Opsgenie the schedule ID, and for Jira Service Management the schedule ID.", "example": "PO8107X", "type": "string" }, "sources": { "description": "The specific rotation and layer combinations from the schedule to replicate. Each source identifies a single layer within a rotation to sync to the external provider.", "example": [ { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" } ], "items": { "$ref": "#/components/schemas/ScheduleReplicaSourceV2" }, "type": "array" } }, "required": [ "sources", "replica_provider", "replica_provider_id", "replica_fallback_user_id" ], "type": "object" }, "ScheduleSyncRuleV2": { "description": "A sync rule links a schedule to a sync target, telling us which of the\nschedule's members should flow into the target's Slack user group.\n\nsync_type decides who is synced: on_call syncs only the people currently on\ncall, next_on_call syncs the people on the next upcoming shift, and all_users\nsyncs everyone on the schedule. By default every rotation on the schedule is\nincluded; set rotation_id to scope the rule to a single rotation. As the\nschedule's shifts change hands, we keep the target's Slack user group\nmembership in step with the rule.\n\nA user group's members are the union of every rule feeding it, so one schedule\ncan have several rules for the same target as long as they differ on\nrotation_id or sync_type. Point an on_call and a next_on_call rule at one group\nand it holds both the current and the next on-call.\n\npermanent_member_user_ids names users who stay in the group whichever way the\nshifts fall, on top of whoever sync_type selects.", "properties": { "created_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the sync rule", "example": "01JXYZ000000000000000000CD", "type": "string" }, "permanent_member_user_ids": { "description": "IDs of users always kept in the Slack user group, regardless of who is on call. Useful for keeping e.g. a manager in the group so they see mentions without being paged. Scoped to this rule: when several rules feed the same group, we sync the union of their permanent members.", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "rotation_id": { "description": "If set, only members of this rotation sync to the user group. When unset, all rotations on the schedule are synced.", "example": "01JXYZ000000000000000000RT", "type": "string" }, "schedule_id": { "description": "The schedule this rule belongs to", "example": "01JXYZ000000000000000000EF", "type": "string" }, "schedule_sync_target": { "$ref": "#/components/schemas/ScheduleSyncTargetResourceV2" }, "schedule_sync_target_id": { "description": "The sync target ID this rule links to", "example": "01JXYZ000000000000000000AB", "type": "string" }, "sync_type": { "description": "Which schedule members sync to the user group", "enum": [ "on_call", "all_users", "next_on_call" ], "example": "on_call", "type": "string" }, "updated_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "schedule_id", "schedule_sync_target_id", "schedule_sync_target", "sync_type", "permanent_member_user_ids", "created_at", "updated_at" ], "type": "object" }, "ScheduleSyncRuleCreatePayloadV2": { "example": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "permanent_member_user_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "rotation_id": "01JXYZ000000000000000000RT", "schedule_sync_target_id": "01JXYZ000000000000000000AB", "sync_type": "on_call" }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that track metadata about this resource", "example": { "incident.io/terraform/version": "3.0.0" }, "type": "object" }, "permanent_member_user_ids": { "description": "IDs of users to always keep in the Slack user group, regardless of who is on call. Each must be an active user in your organisation. Defaults to none.", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "rotation_id": { "description": "If set, scopes the rule to a single rotation on the schedule. When unset, all rotations are synced.", "example": "01JXYZ000000000000000000RT", "type": "string" }, "schedule_sync_target_id": { "description": "The sync target to link to", "example": "01JXYZ000000000000000000AB", "type": "string" }, "sync_type": { "description": "Which schedule members sync to the user group", "enum": [ "on_call", "all_users", "next_on_call" ], "example": "on_call", "type": "string" } }, "required": [ "schedule_sync_target_id", "sync_type" ], "type": "object" }, "SecretV2": { "description": "A secret is a named credential that workflows can reference, for example\nan auth token for an outgoing webhook.\n\nIts value can be set and rotated but never read back: the API stores it\nencrypted and only ever returns masked metadata (the last four characters of\nthe current value). Update the value with the rotate action, which appends a\nnew version and retires the previous one.", "properties": { "created_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "Optional description of what this secret is for", "example": "Auth token for the PagerDuty outgoing webhook", "type": "string" }, "id": { "description": "Unique identifier for this secret", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "last_four_chars": { "description": "The last four characters of the current value, for masked display. Absent when the value is four characters or shorter.", "example": "c123", "type": "string" }, "name": { "description": "Human-readable name, unique within the organisation amongst unarchived secrets", "example": "PagerDuty webhook token", "type": "string" }, "owning_team_ids": { "description": "IDs of the teams that own this secret. Empty means the secret is owned by the whole organisation.", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "updated_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "version": { "description": "The current version number, incremented on each rotation", "example": 3, "format": "int64", "type": "integer" } }, "required": [ "id", "name", "version", "owning_team_ids", "created_at", "updated_at" ], "type": "object" }, "SecretVersionV2": { "description": "A single version of a secret's value. Only metadata is exposed; the value itself is never returned.", "example": { "created_at": "2021-08-17T13:28:57.801578Z", "created_by": { "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" } }, "last_four_chars": "c123", "version": 3 }, "properties": { "created_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "created_by": { "$ref": "#/components/schemas/ActorV2" }, "last_four_chars": { "description": "The last four characters of this version's value, for masked display. Absent when the value was four characters or shorter.", "example": "c123", "type": "string" }, "version": { "description": "The version number, incremented on each rotation", "example": 3, "format": "int64", "type": "integer" } }, "required": [ "version", "created_at" ], "type": "object" }, "SeverityV1": { "properties": { "created_at": { "description": "When the action was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "description": { "description": "Description of the severity", "example": "Issues with **low impact**.", "type": "string" }, "id": { "description": "Unique identifier of the severity", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Human readable name of the severity", "example": "Minor", "maxLength": 50, "type": "string" }, "rank": { "description": "Rank to help sort severities (lower numbers are less severe)", "example": 1, "format": "int64", "type": "integer" }, "updated_at": { "description": "When the action was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "rank", "created_at", "updated_at", "id", "name", "description" ], "type": "object" }, "StatusPageLinkedResponseIncidentV1": { "properties": { "id": { "description": "ID of the Response incident", "example": "01FDAG4SAH3GYPT98WGR2N7W91", "type": "string" }, "linked_at": { "description": "When the Response incident was linked to the status page incident", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "id", "linked_at" ], "type": "object" }, "StatusPageIncidentAffectedComponentV2": { "example": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" }, "properties": { "component_id": { "description": "The ID of the affected component. This may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG2", "type": "string" }, "component_status": { "description": "The status of the relevant component in a status page incident", "enum": [ "operational", "degraded_performance", "partial_outage", "full_outage" ], "example": "operational", "type": "string", "x-public-api-version": "v2" } }, "required": [ "component_id", "component_status" ], "type": "object" }, "StatusPageIncidentUpdateV2": { "properties": { "component_statuses": { "description": "The updated statuses of affected components", "example": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "items": { "$ref": "#/components/schemas/StatusPageIncidentAffectedComponentV2" }, "type": "array" }, "id": { "description": "A unique ID for this status page incident update", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_status": { "description": "Current status for this incident", "enum": [ "investigating", "identified", "monitoring", "resolved" ], "example": "investigating", "type": "string", "x-public-api-version": "v2" }, "message": { "description": "Markdown update on what's changed about this status page incident", "example": "abc123", "type": "string" }, "published_at": { "description": "When this status page incident update was published to the status page", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "status_page_incident_id": { "description": "The ID of the corresponding status page incident", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } }, "required": [ "id", "status_page_incident_id", "published_at", "message", "incident_status", "component_statuses" ], "type": "object" }, "StatusPageIncidentV2": { "properties": { "component_impacts": { "description": "A list of time periods that this status page incident had an impact on a component", "example": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/StatusPageIncidentComponentImpactV2" }, "type": "array" }, "id": { "description": "A unique ID for this status page incident", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_status": { "description": "Current status for this incident", "enum": [ "investigating", "identified", "monitoring", "resolved" ], "example": "investigating", "type": "string", "x-public-api-version": "v2" }, "name": { "description": "A title for the incident", "example": "Elevated API latency", "type": "string" }, "published_at": { "description": "When this status page incident was published to the status page", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "status_page_id": { "description": "The ID of the corresponding status page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "updates": { "description": "A list of updates posted to this status page incident", "example": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_status": "investigating", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ], "items": { "$ref": "#/components/schemas/StatusPageIncidentUpdateV2" }, "type": "array" } }, "required": [ "id", "status_page_id", "name", "published_at", "incident_status", "updates", "component_impacts" ], "type": "object" }, "StatusPageMaintenanceAffectedComponentV2": { "example": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" }, "properties": { "component_id": { "description": "The ID of the affected component. This may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG2", "type": "string" }, "component_status": { "description": "The status of the relevant component in a status page maintenance window", "enum": [ "operational", "under_maintenance" ], "example": "operational", "type": "string", "x-public-api-version": "v2" } }, "required": [ "component_id", "component_status" ], "type": "object" }, "StatusPageMaintenanceUpdateV2": { "properties": { "component_statuses": { "description": "The updated statuses of affected components", "example": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "items": { "$ref": "#/components/schemas/StatusPageMaintenanceAffectedComponentV2" }, "type": "array" }, "id": { "description": "A unique ID for this status page maintenance update", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "maintenance_status": { "description": "Current status for this maintenance window", "enum": [ "maintenance_scheduled", "maintenance_in_progress", "maintenance_complete" ], "example": "maintenance_scheduled", "type": "string", "x-public-api-version": "v2" }, "message": { "description": "Markdown update on what's changed about this status page maintenance window", "example": "abc123", "type": "string" }, "published_at": { "description": "When this status page maintenance update was published to the status page", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "status_page_maintenance_id": { "description": "The ID of the corresponding status page maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } }, "required": [ "id", "status_page_maintenance_id", "published_at", "message", "maintenance_status", "component_statuses" ], "type": "object" }, "StatusPageMaintenanceV2": { "properties": { "automate_maintenance_status": { "description": "Whether updates are published automatically, moving this maintenance window to in progress at its start time and to complete at its end time", "example": true, "type": "boolean" }, "component_maintenance_periods": { "description": "A list of time periods where components were under maintenance during this status page maintenance window", "example": [ { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" } ], "items": { "$ref": "#/components/schemas/StatusPageMaintenanceComponentMaintenancePeriodV2" }, "type": "array" }, "id": { "description": "A unique ID for this status page maintenance window", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "maintenance_status": { "description": "Current status for this maintenance window", "enum": [ "maintenance_scheduled", "maintenance_in_progress", "maintenance_complete" ], "example": "maintenance_scheduled", "type": "string", "x-public-api-version": "v2" }, "name": { "description": "A title for the maintenance window", "example": "Routine infrastructure upgrade", "type": "string" }, "published_at": { "description": "When this status page maintenance window was published to the status page", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "status_page_id": { "description": "The ID of the corresponding status page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "updates": { "description": "A list of updates posted to this status page maintenance window", "example": [ { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG0", "maintenance_status": "maintenance_scheduled", "message": "abc123", "published_at": "2021-08-17T13:28:57.801578Z", "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1" } ], "items": { "$ref": "#/components/schemas/StatusPageMaintenanceUpdateV2" }, "type": "array" } }, "required": [ "id", "status_page_id", "name", "published_at", "maintenance_status", "updates", "component_maintenance_periods", "automate_maintenance_status" ], "type": "object" }, "StatusPageRetrospectiveIncidentUpdateV2": { "description": "A single update in the reconstructed timeline of a retrospective status page incident.", "example": { "component_statuses": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "incident_status": "investigating", "message": "We are currently investigating reports of elevated error rates affecting our API.", "published_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "component_statuses": { "description": "An array of mappings from component ID to component status at the time this update was published", "example": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG2", "component_status": "operational" } ], "items": { "$ref": "#/components/schemas/StatusPageIncidentAffectedComponentV2" }, "type": "array" }, "incident_status": { "description": "Current status for this incident", "enum": [ "investigating", "identified", "monitoring", "resolved" ], "example": "investigating", "type": "string", "x-public-api-version": "v2" }, "message": { "description": "Markdown update on what's changed about this status page incident", "example": "We are currently investigating reports of elevated error rates affecting our API.", "maxLength": 4096, "type": "string" }, "published_at": { "description": "When this update was published. Must be in the past.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "incident_status", "message", "published_at" ], "type": "object" }, "StatusPageStructureV2": { "example": { "items": [ { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" }, "sub_page": { "id": "01FCNDV6P870EA6S7TK1DSYDG1", "items": [ { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" } } ], "name": "United Kingdom" } } ] }, "properties": { "items": { "description": "Array of components and groups to display in the status page", "example": [ { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" }, "sub_page": { "id": "01FCNDV6P870EA6S7TK1DSYDG1", "items": [ { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" } } ], "name": "United Kingdom" } } ], "items": { "$ref": "#/components/schemas/StatusPageStructureItemV2" }, "type": "array" } }, "required": [ "items" ], "type": "object" }, "StatusPageV2": { "properties": { "description": { "description": "The description of this status page", "example": "This status page is our public status page.", "type": "string" }, "id": { "description": "Unique ID of this status page", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "The title of this status page", "example": "Our public status page", "type": "string" }, "public_url": { "description": "The public URL of this status page", "example": "https://statuspage.incident.io/our-public-status-page", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "TeamV3": { "properties": { "catalog_entry": { "$ref": "#/components/schemas/CatalogEntrySlimV3V3" }, "id": { "description": "Unique ID of the team", "example": "abc123", "type": "string" }, "members": { "description": "Members of the team", "example": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "slack_user_id": "U02AYNF2XJM" } ], "items": { "$ref": "#/components/schemas/UserV3" }, "type": "array" }, "name": { "description": "Name of the team", "example": "abc123", "type": "string" } }, "required": [ "id", "name", "catalog_entry", "members" ], "type": "object" }, "TelemetryDatadogUpdateConfigV2": { "description": "Datadog-specific credential updates", "example": { "api_key": "abc123", "app_key": "abc123" }, "properties": { "api_key": { "description": "New Datadog API key", "example": "abc123", "type": "string" }, "app_key": { "description": "New Datadog Application key", "example": "abc123", "type": "string" } }, "type": "object" }, "TelemetryGrafanaUpdateConfigV2": { "description": "Grafana-specific credential and endpoint updates", "example": { "api_key": "glsa_123", "api_url": "grafana.example.com" }, "properties": { "api_key": { "description": "New Grafana service account token", "example": "glsa_123", "type": "string" }, "api_url": { "description": "Grafana API URL (without protocol)", "example": "grafana.example.com", "type": "string" } }, "type": "object" }, "TelemetryDataSourceV2": { "description": "A telemetry data source integration", "properties": { "created_at": { "description": "When this data source was created", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "enabled": { "description": "Whether this data source is enabled", "example": true, "type": "boolean" }, "id": { "description": "Unique identifier for this data source", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "name": { "description": "Human-readable name of the data source", "example": "Primary Prometheus", "type": "string" }, "provider": { "description": "Provider that hosts this data source", "example": "grafana", "type": "string" }, "source_type": { "description": "Type of data source (e.g., prometheus, loki, tempo)", "example": "grafana", "type": "string" }, "updated_at": { "description": "When this data source was last updated", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "version": { "description": "Upstream tool version captured at probe time (e.g. \"8.5.27\" for Grafana, \"2.9.4\" for Loki). Empty for SaaS providers and until the first successful probe.", "example": "8.5.27", "type": "string" } }, "required": [ "id", "name", "provider", "source_type", "enabled", "created_at", "updated_at" ], "type": "object" }, "UserWithRolesV2": { "properties": { "base_role": { "$ref": "#/components/schemas/RBACRoleV2" }, "custom_roles": { "example": [ { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" } ], "items": { "$ref": "#/components/schemas/RBACRoleV2" }, "type": "array" }, "email": { "description": "Email address of the user.", "example": "lisa@incident.io", "type": "string" }, "id": { "description": "Unique identifier of the user", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "is_active": { "description": "Whether the user is active. False if the user has been deactivated (e.g. offboarded) or is not yet active.", "example": true, "type": "boolean" }, "name": { "description": "Name of the user", "example": "Lisa Karlin Curtis", "type": "string" }, "role": { "description": "DEPRECATED: Role of the user as of March 9th 2023, this value is no longer updated.", "enum": [ "viewer", "responder", "administrator", "owner", "unset" ], "example": "owner", "type": "string" }, "seats": { "$ref": "#/components/schemas/UserSeatsV2" }, "slack_user_id": { "description": "Slack ID of the user", "example": "U02AYNF2XJM", "type": "string" } }, "required": [ "base_role", "custom_roles", "seats", "is_active", "role", "id", "name" ], "type": "object" }, "OnCallNotificationMethodPublicV2": { "properties": { "address": { "description": "The address of this method (e.g. redacted phone number, email address, device name, Slack user name)", "example": "•••••••6789", "type": "string" }, "id": { "description": "Unique identifier for this notification method", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "is_usable": { "description": "Whether this method is ready to receive notifications. For phone, this means verified. For app devices, this means push notifications can be sent. For email, Slack, and Microsoft Teams this is always true.", "example": true, "type": "boolean" }, "method_type": { "description": "The high-level type of notification method. Phone rules include phone details that distinguish SMS from voice calls.", "enum": [ "app", "email", "microsoft_teams", "phone", "slack", "whatsapp_message" ], "example": "app", "type": "string", "x-public-api-version": "v2" }, "phone_details": { "$ref": "#/components/schemas/OnCallNotificationMethodPhoneDetailsPublicV2" } }, "required": [ "id", "method_type", "is_usable", "address" ], "type": "object" }, "OnCallNotificationRulePublicV2": { "properties": { "app": { "$ref": "#/components/schemas/OnCallNotificationRuleAppDetailsPublicV2" }, "delay_seconds": { "description": "Delay in seconds before this rule activates. 0 means immediate.", "example": 0, "format": "int64", "maximum": 1200, "minimum": 0, "type": "integer" }, "id": { "description": "Unique identifier for this notification rule", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "method_target": { "$ref": "#/components/schemas/OnCallNotificationRuleMethodTargetPublicV2" }, "method_type": { "description": "The high-level type of notification method. Phone rules include phone details that distinguish SMS from voice calls.", "enum": [ "app", "email", "microsoft_teams", "phone", "slack", "whatsapp_message" ], "example": "app", "type": "string", "x-public-api-version": "v2" }, "phone": { "$ref": "#/components/schemas/OnCallNotificationRulePhoneDetailsPublicV2" }, "rule_type": { "description": "The urgency level this rule applies to", "enum": [ "high_urgency", "low_urgency" ], "example": "low_urgency", "type": "string", "x-public-api-version": "v2" } }, "required": [ "id", "method_type", "method_target", "rule_type" ], "type": "object" }, "IdentityV1": { "example": { "dashboard_url": "https://app.incident.io/my-org", "name": "Alertmanager token", "roles": [ "viewer" ], "team_roles": [ "catalog_editor" ], "teams": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Platform" } ] }, "properties": { "dashboard_url": { "description": "The dashboard URL for this organisation", "example": "https://app.incident.io/my-org", "type": "string" }, "name": { "description": "The name assigned to the current API Key", "example": "Alertmanager token", "type": "string" }, "roles": { "description": "Which roles have been enabled for this key", "example": [ "viewer" ], "items": { "description": "API key roles", "enum": [ "viewer", "incident_creator", "incident_editor", "manage_settings", "global_access", "catalog_viewer", "catalog_editor", "incident_memberships_editor", "schedules_editor", "schedules_reader", "schedule_overrides_editor", "workflows_editor", "workflows_viewer", "private_workflows_editor", "private_escalation_workflows_editor", "on_call_editor", "on_call_viewer", "escalation_creator", "post_incident_flow_opt_out", "security_settings_editor", "investigation_download", "team_memberships_manage", "status_page_publisher", "postmortems_manage", "api_keys_manage", "notification_methods_manage", "notification_methods_unredacted_viewer", "incident_workload_viewer", "incident_workload_private_viewer", "act_on_behalf_of_users", "secrets_manage", "secrets_use", "call_transcripts_viewer", "heartbeats_ping", "telemetry_query_restricted", "telemetry_data_source_update", "policies_viewer", "policy_findings_manage", "pay_reports_viewer", "pay_reports_editor", "pay_configs_viewer", "pay_configs_editor" ], "example": "viewer", "type": "string", "x-public-api-version": "v1" }, "type": "array" }, "team_roles": { "description": "If set, these roles apply to requests that operate on resources owned by any of the teams in the 'teams' array. These are in addition to any 'roles' which are applied on all requests.", "example": [ "catalog_editor" ], "items": { "description": "API key team roles", "enum": [ "catalog_editor", "schedules_editor", "schedules_reader", "schedule_overrides_editor", "on_call_editor", "escalation_creator", "api_keys_manage", "workflows_editor", "private_workflows_editor", "secrets_manage", "secrets_use", "heartbeats_ping", "telemetry_query_restricted", "telemetry_data_source_update" ], "example": "catalog_editor", "type": "string", "x-public-api-version": "v1" }, "type": "array" }, "teams": { "description": "Teams that this API key is scoped to. If this is not empty, the current API key has additional roles within these teams (see team_roles).", "example": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Platform" } ], "items": { "$ref": "#/components/schemas/IdentityTeamV1" }, "type": "array" } }, "required": [ "name", "roles", "dashboard_url", "team_roles", "teams" ], "type": "object" }, "IPRangeV1": { "description": "One address our requests to your systems come from.", "properties": { "cidr": { "description": "The address in CIDR notation. Single addresses are given as a /32.", "example": "34.91.219.113/32", "type": "string" }, "description": { "description": "Which of our traffic reaches you from this address", "example": "Requests to your systems from integrations and from workflow \"Send a webhook\" steps", "type": "string" } }, "required": [ "cidr", "description" ], "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" }, "WorkflowSlimV2": { "example": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "continue_on_step_error": true, "delay": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "folder": "My folder 01", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "include_private_escalations": true, "include_private_incidents": true, "name": "My little workflow", "once_for": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -> Affected Team", "type": "IncidentSeverity" } ], "owning_team_ids": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "private_incident_scope": "owning_teams", "runs_from": "2021-08-17T13:28:57.801578Z", "runs_on_incident_modes": [ "standard", "test", "retrospective" ], "runs_on_incidents": "newly_created", "shortform": "page-the-ceo", "state": "active", "steps": [ { "label": "PagerDuty Escalate", "name": "pagerduty.escalate" } ], "trigger": { "label": "Incident Updated", "name": "incident.updated" }, "version": 3 }, "properties": { "condition_groups": { "description": "Conditions that apply to the workflow trigger", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV2" }, "type": "array" }, "continue_on_step_error": { "description": "Whether to continue executing the workflow if a step fails", "example": true, "type": "boolean" }, "delay": { "$ref": "#/components/schemas/WorkflowDelayV2" }, "expressions": { "description": "Expressions that make variables available in the scope", "example": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionV2" }, "type": "array" }, "folder": { "description": "Folder to display the workflow in", "example": "My folder 01", "type": "string" }, "id": { "description": "Unique identifier for the workflow", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "include_private_escalations": { "description": "Whether to include private escalations", "example": true, "type": "boolean" }, "include_private_incidents": { "description": "DEPRECATED: use `private_incident_scope` instead. `true` when the workflow runs on private incidents (a `private_incident_scope` of `all` or `owning_teams`), `false` when the scope is `none`.", "example": true, "type": "boolean" }, "name": { "description": "Name provided by the user when creating the workflow", "example": "My little workflow", "type": "string" }, "once_for": { "description": "This workflow will run 'once for' a list of references", "example": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -> Affected Team", "type": "IncidentSeverity" } ], "items": { "$ref": "#/components/schemas/EngineReferenceV2" }, "type": "array" }, "owning_team_ids": { "description": "IDs of the teams that own this workflow", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "private_incident_scope": { "description": "Which private incidents this workflow acts on: every private incident (all), those an owning team can see (owning_teams), or none", "enum": [ "all", "owning_teams", "none" ], "example": "owning_teams", "type": "string" }, "runs_from": { "description": "The time from which this workflow will run on incidents", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "runs_on_incident_modes": { "description": "Which incident modes should this workflow run on? By default, workflows only run on standard incidents, but can also be configured to run on test and retrospective incidents.", "example": [ "standard", "test", "retrospective" ], "items": { "description": "Incident mode that workflows can run on", "enum": [ "standard", "test", "retrospective" ], "example": "standard", "type": "string", "x-public-api-version": "v2" }, "type": "array" }, "runs_on_incidents": { "description": "Which incidents should the workflow be applied to?", "enum": [ "newly_created", "newly_created_and_active" ], "example": "newly_created", "type": "string" }, "shortform": { "description": "The shortform used to trigger this workflow (only applicable for manual triggers)", "example": "page-the-ceo", "type": "string" }, "state": { "description": "What state this workflow is in", "enum": [ "active", "disabled", "draft", "error" ], "example": "active", "type": "string" }, "steps": { "description": "Steps that are executed as part of the workflow", "example": [ { "label": "PagerDuty Escalate", "name": "pagerduty.escalate" } ], "items": { "$ref": "#/components/schemas/StepConfigSlimV2" }, "type": "array" }, "trigger": { "$ref": "#/components/schemas/TriggerSlimV2" }, "version": { "description": "Revision of the workflow, uniquely identifying it's version", "example": 3, "format": "int64", "type": "integer" } }, "required": [ "include_private_incidents", "id", "name", "trigger", "once_for", "version", "expressions", "condition_groups", "steps", "private_incident_scope", "include_private_escalations", "runs_on_incident_modes", "continue_on_step_error", "runs_on_incidents", "state" ], "type": "object" }, "WorkflowDelayV2": { "example": { "conditions_apply_over_delay": false, "for_seconds": 60 }, "properties": { "conditions_apply_over_delay": { "description": "If this workflow is delayed, whether the conditions should be rechecked between trigger firing and execution", "example": false, "type": "boolean" }, "for_seconds": { "description": "Delay in seconds between trigger firing and running the workflow", "example": 60, "format": "int64", "minimum": 0, "type": "integer" } }, "required": [ "for_seconds", "conditions_apply_over_delay" ], "type": "object" }, "WorkflowFormFieldPayloadV2": { "example": { "array": true, "description": "The customer affected by this incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "key": "affected_customer", "required": true, "title": "Affected customer", "type": "User" }, "properties": { "array": { "description": "Whether this field holds a list of values rather than a single value", "example": true, "type": "boolean" }, "description": { "description": "Optional help text shown beneath the field", "example": "The customer affected by this incident", "type": "string" }, "id": { "description": "Stable identifier for this field; omit to create a new field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "key": { "description": "The key used to reference this field in the workflow scope", "example": "affected_customer", "type": "string" }, "required": { "description": "Whether this field must be filled in when running the workflow", "example": true, "type": "boolean" }, "title": { "description": "Human readable title shown in the form", "example": "Affected customer", "type": "string" }, "type": { "description": "The engine resource type of this field", "example": "User", "type": "string" } }, "required": [ "key", "title", "type" ], "type": "object" }, "StepConfigPayloadV2": { "example": { "for_each": "abc123", "id": "abc123", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ] }, "properties": { "for_each": { "description": "Reference to an expression that returns resources to run this step over", "example": "abc123", "type": "string" }, "id": { "description": "Unique ID of this step in a workflow", "example": "abc123", "type": "string" }, "name": { "description": "Unique name of the step in the engine", "example": "pagerduty.escalate", "type": "string" }, "param_bindings": { "description": "List of parameter bindings", "example": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "items": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "type": "array" } }, "required": [ "id", "name", "param_bindings" ], "type": "object" }, "ManagementMetaV2": { "example": { "annotations": { "incident.io/terraform/version": "3.0.0" }, "managed_by": "dashboard", "source_url": "https://github.com/my-company/infrastructure" }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that track metadata about this resource", "example": { "incident.io/terraform/version": "3.0.0" }, "type": "object" }, "managed_by": { "description": "How is this resource managed", "enum": [ "dashboard", "terraform", "external" ], "example": "dashboard", "type": "string" }, "source_url": { "description": "The url of the external repository where this resource is managed (if there is one)", "example": "https://github.com/my-company/infrastructure", "type": "string" } }, "required": [ "annotations", "managed_by" ], "type": "object" }, "WorkflowV2": { "properties": { "condition_groups": { "description": "Conditions that apply to the workflow trigger", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV2" }, "type": "array" }, "continue_on_step_error": { "description": "Whether to continue executing the workflow if a step fails", "example": true, "type": "boolean" }, "delay": { "$ref": "#/components/schemas/WorkflowDelayV2" }, "expressions": { "description": "Expressions that make variables available in the scope", "example": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionV2" }, "type": "array" }, "folder": { "description": "Folder to display the workflow in", "example": "My folder 01", "type": "string" }, "form_fields": { "description": "User-configured form fields available in the workflow scope (manual triggers only)", "example": [ { "array": true, "description": "The customer affected by this incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "key": "affected_customer", "required": true, "title": "Affected customer", "type": "User" } ], "items": { "$ref": "#/components/schemas/WorkflowFormFieldV2" }, "type": "array" }, "id": { "description": "Unique identifier for the workflow", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "include_private_escalations": { "description": "Whether to include private escalations", "example": true, "type": "boolean" }, "include_private_incidents": { "description": "DEPRECATED: use `private_incident_scope` instead. `true` when the workflow runs on private incidents (a `private_incident_scope` of `all` or `owning_teams`), `false` when the scope is `none`.", "example": true, "type": "boolean" }, "name": { "description": "Name provided by the user when creating the workflow", "example": "My little workflow", "type": "string" }, "once_for": { "description": "This workflow will run 'once for' a list of references", "example": [ { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -> Affected Team", "type": "IncidentSeverity" } ], "items": { "$ref": "#/components/schemas/EngineReferenceV2" }, "type": "array" }, "owning_team_ids": { "description": "IDs of the teams that own this workflow", "example": [ "01G0J1EXE7AXZ2C93K61WBPYEH" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "private_incident_scope": { "description": "Which private incidents this workflow acts on: every private incident (all), those an owning team can see (owning_teams), or none", "enum": [ "all", "owning_teams", "none" ], "example": "owning_teams", "type": "string" }, "runs_from": { "description": "The time from which this workflow will run on incidents", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "runs_on_incident_modes": { "description": "Which incident modes should this workflow run on? By default, workflows only run on standard incidents, but can also be configured to run on test and retrospective incidents.", "example": [ "standard", "test", "retrospective" ], "items": { "description": "Incident mode that workflows can run on", "enum": [ "standard", "test", "retrospective" ], "example": "standard", "type": "string", "x-public-api-version": "v2" }, "type": "array" }, "runs_on_incidents": { "description": "Which incidents should the workflow be applied to?", "enum": [ "newly_created", "newly_created_and_active" ], "example": "newly_created", "type": "string" }, "shortform": { "description": "The shortform used to trigger this workflow (only applicable for manual triggers)", "example": "page-the-ceo", "type": "string" }, "state": { "description": "What state this workflow is in", "enum": [ "active", "disabled", "draft", "error" ], "example": "active", "type": "string" }, "steps": { "description": "Steps that are executed as part of the workflow", "example": [ { "for_each": "abc123", "id": "abc123", "label": "PagerDuty Escalate", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/StepConfigV2" }, "type": "array" }, "trigger": { "$ref": "#/components/schemas/TriggerSlimV2" }, "version": { "description": "Revision of the workflow, uniquely identifying it's version", "example": 3, "format": "int64", "type": "integer" } }, "required": [ "include_private_incidents", "id", "name", "trigger", "once_for", "version", "expressions", "condition_groups", "steps", "private_incident_scope", "include_private_escalations", "runs_on_incident_modes", "continue_on_step_error", "runs_on_incidents", "state" ], "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" }, "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" }, "ErrorSource": { "example": { "field": "default_call_url", "pointer": "/settings/default_call_url" }, "properties": { "field": { "description": "Field name that is the source of the error", "example": "default_call_url", "type": "string" }, "pointer": { "description": "JSON pointer to the request field that is the source of the error", "example": "/settings/default_call_url", "type": "string" } }, "required": [ "field", "pointer" ], "type": "object" }, "ActorV1": { "example": { "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "viewer", "slack_user_id": "U02AYNF2XJM" } }, "properties": { "api_key": { "$ref": "#/components/schemas/APIKeyActorV1" }, "user": { "$ref": "#/components/schemas/UserV1" } }, "type": "object" }, "ImageV1": { "example": { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "url": "https://storage.googleapis.com/incident-io/images/..." }, "properties": { "id": { "description": "Unique identifier for the image", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "url": { "description": "Pre-signed URL to fetch the image, valid for 10 minutes", "example": "https://storage.googleapis.com/incident-io/images/...", "type": "string" } }, "required": [ "id", "url" ], "type": "object" }, "ConditionPayloadV3": { "example": { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" }, "properties": { "operation": { "description": "The name of the operation on the subject", "example": "one_of", "type": "string" }, "param_bindings": { "description": "List of parameter bindings", "example": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "items": { "$ref": "#/components/schemas/EngineParamBindingPayloadV3" }, "type": "array" }, "subject": { "description": "The reference of the subject in the trigger scope", "example": "alert.priority", "type": "string" } }, "required": [ "subject", "operation", "param_bindings" ], "type": "object" }, "AlertRouteEscalationTargetPayloadV3": { "example": { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "escalation_paths": { "$ref": "#/components/schemas/EngineParamBindingPayloadV3" }, "users": { "$ref": "#/components/schemas/EngineParamBindingPayloadV3" } }, "type": "object" }, "AlertRouteWhenAlertJoinsGroupPayloadV3": { "example": { "grace_period_seconds": 60, "mode": "on_each_new_alert" }, "properties": { "grace_period_seconds": { "description": "How long to wait before escalating once an alert joins the group, in seconds. Only applies when mode is 'on_each_new_alert', and must be unset when mode is 'on_priority_increase'. Must be between 0 and 3600 (1 hour).", "example": 60, "format": "int32", "maximum": 3600, "minimum": 0, "type": "integer" }, "mode": { "description": "When a subsequent alert joins an existing group, when should we escalate again?", "enum": [ "on_priority_increase", "on_each_new_alert" ], "example": "on_each_new_alert", "type": "string" } }, "required": [ "mode" ], "type": "object" }, "ExpressionElseBranchPayloadV3": { "example": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "result": { "$ref": "#/components/schemas/EngineParamBindingPayloadV3" } }, "required": [ "result" ], "type": "object" }, "ExpressionOperationPayloadV3": { "example": { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } }, "properties": { "branches": { "$ref": "#/components/schemas/ExpressionBranchesOptsPayloadV3" }, "cast": { "$ref": "#/components/schemas/ExpressionCastOptsPayloadV3" }, "concatenate": { "$ref": "#/components/schemas/ExpressionConcatenateOptsPayloadV3" }, "filter": { "$ref": "#/components/schemas/ExpressionFilterOptsPayloadV3" }, "navigate": { "$ref": "#/components/schemas/ExpressionNavigateOptsPayloadV3" }, "operation_type": { "description": "The type of the operation", "enum": [ "navigate", "filter", "concatenate", "count", "min", "max", "sum", "random", "first", "parse", "branches", "cast" ], "example": "navigate", "type": "string" }, "parse": { "$ref": "#/components/schemas/ExpressionParseOptsPayloadV3" } }, "required": [ "operation_type" ], "type": "object" }, "GroupingSettingsV3": { "example": { "enabled": true, "grouping_keys": [ { "reference": "alert.title" } ], "window_seconds": 1800, "window_type": "rolling" }, "properties": { "enabled": { "description": "Whether grouping is enabled", "example": true, "type": "boolean" }, "grouping_keys": { "description": "Which attributes should this alert route use to group alerts? Only set when grouping is enabled.", "example": [ { "reference": "alert.title" } ], "items": { "$ref": "#/components/schemas/GroupingKeyV3" }, "type": "array" }, "window_seconds": { "description": "How long the grouping window is, in seconds. Must be between 60 (1 minute) and 172800 (48 hours). Only set when grouping is enabled.", "example": 1800, "format": "int32", "maximum": 172800, "minimum": 60, "type": "integer" }, "window_type": { "description": "Controls how the grouping window behaves. 'rolling' keeps the window open for window_seconds after the most recent alert, so the group stays open as long as alerts keep arriving. 'fixed' opens the window when the first alert arrives and always closes window_seconds later, regardless of any subsequent alerts. Only set when grouping is enabled.", "enum": [ "rolling", "fixed" ], "example": "rolling", "type": "string" } }, "required": [ "enabled" ], "type": "object" }, "EngineParamBindingPayloadV3": { "example": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "properties": { "array_value": { "description": "If set, this is the array value of the step parameter", "example": [ { "literal": "SEV123", "reference": "incident.severity" } ], "items": { "$ref": "#/components/schemas/EngineParamBindingValuePayloadV3" }, "type": "array" }, "value": { "$ref": "#/components/schemas/EngineParamBindingValuePayloadV3" } }, "type": "object" }, "AlertRouteIncidentTemplatePayloadV3": { "description": "The template this alert route applies to the incidents it creates. It must be unset when incident creation is disabled. Disabling incident creation clears a template the route already has.", "example": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "properties": { "custom_fields": { "description": "Custom fields configuration", "example": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "items": { "$ref": "#/components/schemas/AlertRouteCustomFieldBindingPayloadV3" }, "type": "array" }, "incident_mode": { "$ref": "#/components/schemas/AlertRouteTemplateBindingPayloadV3" }, "incident_type": { "$ref": "#/components/schemas/AlertRouteTemplateBindingPayloadV3" }, "membership_teams": { "$ref": "#/components/schemas/AlertRouteTemplateBindingPayloadV3" }, "name": { "$ref": "#/components/schemas/AlertRouteAutoGeneratedTemplateBindingPayloadV3" }, "severity": { "$ref": "#/components/schemas/AlertRouteSeverityBindingPayloadV3" }, "start_in_triage": { "$ref": "#/components/schemas/AlertRouteTemplateBindingPayloadV3" }, "summary": { "$ref": "#/components/schemas/AlertRouteAutoGeneratedTemplateBindingPayloadV3" } }, "required": [ "name" ], "type": "object" }, "AlertMessageDestinationPayloadV3": { "example": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "public", "group_alerts_summary": false }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "public", "group_alerts_summary": false } }, "properties": { "condition_groups": { "description": "The conditions that must be met for this channel config to be used", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV3" }, "type": "array" }, "ms_teams_targets": { "$ref": "#/components/schemas/AlertRouteChannelTargetPayloadV3" }, "slack_targets": { "$ref": "#/components/schemas/AlertRouteChannelTargetPayloadV3" } }, "required": [ "condition_groups" ], "type": "object" }, "AlertRouteAlertSourceV3": { "example": { "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0", "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] }, "properties": { "alert_source_id": { "description": "The alert source ID that will match for the route", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "condition_groups": { "description": "What conditions should alerts from this source meet to be included in this alert route?", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV3" }, "type": "array" } }, "required": [ "alert_source_id", "condition_groups" ], "type": "object" }, "ConditionGroupV3": { "example": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] }, "properties": { "conditions": { "description": "All conditions in this list must be satisfied for the group to be satisfied", "example": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ], "items": { "$ref": "#/components/schemas/ConditionV3" }, "type": "array" } }, "required": [ "conditions" ], "type": "object" }, "AlertRouteEscalationConfigV3": { "example": { "auto_cancel_escalations": false, "escalation_targets": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "when_alert_joins_group": { "grace_period_seconds": 60, "mode": "on_each_new_alert" } }, "properties": { "auto_cancel_escalations": { "description": "Should we auto cancel escalations when all alerts are resolved?", "example": false, "type": "boolean" }, "escalation_targets": { "description": "Targets for escalation", "example": [ { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/AlertRouteEscalationTargetV3" }, "type": "array" }, "when_alert_joins_group": { "$ref": "#/components/schemas/AlertRouteWhenAlertJoinsGroupV3" } }, "required": [ "escalation_targets", "auto_cancel_escalations" ], "type": "object" }, "ExpressionV3": { "example": { "else_branch": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" }, "properties": { "else_branch": { "$ref": "#/components/schemas/ExpressionElseBranchV3" }, "label": { "description": "The human readable label of the expression", "example": "Team Slack channel", "type": "string" }, "operations": { "example": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "items": { "$ref": "#/components/schemas/ExpressionOperationV3" }, "type": "array" }, "reference": { "description": "A short ID that can be used to reference the expression", "example": "abc123", "type": "string" }, "returns": { "$ref": "#/components/schemas/ReturnsMetaV3" }, "root_reference": { "description": "The root reference for this expression (i.e. where the expression starts)", "example": "incident.status", "type": "string" } }, "required": [ "label", "reference", "returns", "root_reference", "operations" ], "type": "object" }, "AlertRouteIncidentConfigV3": { "example": { "auto_decline_enabled": false, "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "enabled": false, "incident_template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "membership_teams": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "template": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } } }, "properties": { "auto_decline_enabled": { "description": "Should triage incidents be declined when alerts are resolved? Only set when incident creation is enabled.", "example": false, "type": "boolean" }, "condition_groups": { "description": "What condition groups must be true for this alert route to create an incident? Only set when incident creation is enabled.", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV3" }, "type": "array" }, "enabled": { "description": "Whether incident creation is enabled for this alert route", "example": false, "type": "boolean" }, "incident_template": { "$ref": "#/components/schemas/EngineParamBindingV3" }, "membership_teams": { "$ref": "#/components/schemas/EngineParamBindingV3" }, "template": { "$ref": "#/components/schemas/AlertRouteIncidentTemplateV3" } }, "required": [ "enabled" ], "type": "object" }, "AlertMessageConfigV3": { "example": { "destinations": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123", "group_alerts_summary": false }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123", "group_alerts_summary": false } } ], "template": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "destinations": { "description": "The destinations (Slack/Teams channels) alert messages are sent to", "example": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123", "group_alerts_summary": false }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123", "group_alerts_summary": false } } ], "items": { "$ref": "#/components/schemas/AlertMessageDestinationV3" }, "type": "array" }, "template": { "$ref": "#/components/schemas/EngineParamBindingV3" } }, "required": [ "destinations" ], "type": "object" }, "AlertSourceEmailOptionsV2": { "example": { "email_address": "lawrence@example.com", "redactions": [ "credit_card_numbers" ], "transform_expression": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}" }, "properties": { "email_address": { "description": "Email address this alert source receives alerts to", "example": "lawrence@example.com", "type": "string" }, "redactions": { "description": "Which PII types to automatically redact from incoming email content before storage", "example": [ "credit_card_numbers" ], "items": { "description": "Which PII type to automatically redact from incoming email content before storage", "enum": [ "credit_card_numbers", "us_social_security_numbers", "phone_numbers" ], "example": "credit_card_numbers", "type": "string", "x-public-api-version": "v2" }, "type": "array" }, "transform_expression": { "description": "JavaScript expression to transform email fields into structured alert fields", "example": "return {\n title: $.subject,\n description: $.text,\n status: $.subject.startsWith('[RESOLVED]') ? 'resolved' : 'firing',\n deduplication_key: $.header_message_id,\n}", "type": "string" } }, "required": [ "email_address", "redactions" ], "type": "object" }, "ConditionGroupV2": { "example": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] }, "properties": { "conditions": { "description": "All conditions in this list must be satisfied for the group to be satisfied", "example": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "items": { "$ref": "#/components/schemas/ConditionV2" }, "type": "array" } }, "required": [ "conditions" ], "type": "object" }, "AlertSourceHeartbeatOptionsV2": { "example": { "failure_threshold": 1, "grace_period_seconds": 0, "interval_seconds": 60, "ping_url": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping" }, "properties": { "failure_threshold": { "description": "Number of consecutive missed pings before an alert fires.", "example": 1, "format": "int64", "type": "integer" }, "grace_period_seconds": { "description": "How long after a missed ping before the heartbeat is considered late, in seconds. If zero, it transitions directly to failing.", "example": 0, "format": "int64", "type": "integer" }, "interval_seconds": { "description": "How often a ping is expected, in seconds.", "example": 60, "format": "int64", "type": "integer" }, "ping_url": { "description": "The URL to POST to in order to send a heartbeat ping.", "example": "https://api.incident.io/v2/heartbeat/01GW2G3V0S59R238FAHPDS1R66/ping", "type": "string" } }, "required": [ "interval_seconds", "grace_period_seconds", "failure_threshold", "ping_url" ], "type": "object" }, "AlertTemplateV2": { "example": { "attributes": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "description": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "expressions": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "is_private": false, "title": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "visible_to_teams": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "attributes": { "description": "Attributes to set on alerts coming from this source, with a binding describing how to set them.", "example": [ { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/AlertTemplateAttributeV2" }, "type": "array" }, "description": { "$ref": "#/components/schemas/EngineParamBindingValueV2" }, "expressions": { "description": "Expressions available for use in bindings within this template", "example": [ { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" } ], "items": { "$ref": "#/components/schemas/ExpressionV2" }, "type": "array" }, "is_private": { "description": "Whether or not alerts produced by this source should be private", "example": false, "type": "boolean" }, "title": { "$ref": "#/components/schemas/EngineParamBindingValueV2" }, "visible_to_teams": { "$ref": "#/components/schemas/EngineParamBindingV2" } }, "required": [ "expressions", "title", "description", "attributes", "is_private" ], "type": "object" }, "ConditionPayloadV2": { "example": { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" }, "properties": { "operation": { "description": "The name of the operation on the subject", "example": "one_of", "type": "string" }, "param_bindings": { "description": "List of parameter bindings", "example": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "items": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "type": "array" }, "subject": { "description": "The reference of the subject in the trigger scope", "example": "incident.severity", "type": "string" } }, "required": [ "subject", "operation", "param_bindings" ], "type": "object" }, "AlertTemplateAttributePayloadV2": { "example": { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "alert_attribute_id": { "description": "ID of the alert attribute to set with this binding", "example": "abc123", "type": "string" }, "binding": { "$ref": "#/components/schemas/AlertTemplateAttributeBindingPayloadV2" } }, "required": [ "alert_attribute_id", "binding" ], "type": "object" }, "EngineParamBindingValuePayloadV2": { "example": { "literal": "SEV123", "reference": "incident.severity" }, "properties": { "literal": { "description": "If set, this is the literal value of the step parameter", "example": "SEV123", "type": "string" }, "reference": { "description": "If set, this is the reference into the trigger scope that is the value of this parameter", "example": "incident.severity", "type": "string" } }, "type": "object" }, "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" }, "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" }, "APIKeyRoleV1": { "example": { "description": "can view data, like public incidents and organization settings", "name": "viewer" }, "properties": { "description": { "description": "Human readable description of the role", "example": "can view data, like public incidents and organization settings", "type": "string" }, "name": { "description": "API key role name", "enum": [ "viewer", "incident_creator", "incident_editor", "manage_settings", "global_access", "catalog_viewer", "catalog_editor", "incident_memberships_editor", "schedules_editor", "schedules_reader", "schedule_overrides_editor", "workflows_editor", "workflows_viewer", "private_workflows_editor", "private_escalation_workflows_editor", "on_call_editor", "on_call_viewer", "escalation_creator", "post_incident_flow_opt_out", "security_settings_editor", "investigation_download", "team_memberships_manage", "status_page_publisher", "postmortems_manage", "api_keys_manage", "notification_methods_manage", "notification_methods_unredacted_viewer", "incident_workload_viewer", "incident_workload_private_viewer", "act_on_behalf_of_users", "secrets_manage", "secrets_use", "call_transcripts_viewer", "heartbeats_ping", "telemetry_query_restricted", "telemetry_data_source_update", "policies_viewer", "policy_findings_manage", "pay_reports_viewer", "pay_reports_editor", "pay_configs_viewer", "pay_configs_editor" ], "example": "viewer", "type": "string", "x-public-api-version": "v1" } }, "required": [ "name", "description" ], "type": "object" }, "APIKeyTeamRoleV1": { "example": { "description": "can view data, like public incidents and organization settings", "name": "catalog_editor" }, "properties": { "description": { "description": "Human readable description of the role", "example": "can view data, like public incidents and organization settings", "type": "string" }, "name": { "description": "API key role name that may be granted for team-scoped access", "enum": [ "catalog_editor", "schedules_editor", "schedules_reader", "schedule_overrides_editor", "on_call_editor", "escalation_creator", "api_keys_manage", "workflows_editor", "private_workflows_editor", "secrets_manage", "secrets_use", "heartbeats_ping", "telemetry_query_restricted", "telemetry_data_source_update" ], "example": "catalog_editor", "type": "string", "x-public-api-version": "v1" } }, "required": [ "name", "description" ], "type": "object" }, "CallRoutePathNodeV2": { "description": "A single step in a call route's path.\n\nLevels page a set of targets, and a trailing voicemail node records a message\nfrom the caller. A path made up of only a voicemail node sends callers straight\nto voicemail without paging anyone.", "example": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "level": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "type": "level", "voicemail": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." } }, "properties": { "id": { "description": "Unique identifier for this node", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "level": { "$ref": "#/components/schemas/CallRoutePathNodeLevelV2" }, "type": { "description": "The type of this node. Available types are:\n* level: page a set of targets, rotating between them\n* voicemail: record a message from the caller", "enum": [ "level", "voicemail" ], "example": "level", "type": "string" }, "voicemail": { "$ref": "#/components/schemas/CallRoutePathNodeVoicemailV2" } }, "required": [ "id", "type" ], "type": "object" }, "CallRoutePathNodeLevelV2": { "description": "The targets a level pages.\n\nWe call each target for 30 seconds, rotating to the next after 60 seconds, and\nmove to the next node if nobody acknowledges within 5 minutes. Those timings are\nfixed for call routes.", "example": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ] }, "properties": { "targets": { "description": "The users and schedules to page", "example": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "items": { "$ref": "#/components/schemas/CallRouteTargetV2" }, "type": "array" } }, "required": [ "targets" ], "type": "object" }, "CallRoutePathNodeVoicemailV2": { "description": "Records a message from the caller, and enriches the resulting alert with the transcript.", "example": { "greeting_text": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded." }, "properties": { "greeting_text": { "description": "What we read to the caller before recording, via text-to-speech in the route's language, exactly as written", "example": "Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded.", "maxLength": 250, "type": "string" } }, "required": [ "greeting_text" ], "type": "object" }, "CatalogEntryEngineParamBindingV3": { "example": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123" } }, "properties": { "array_value": { "description": "If the attribute is multi-valued, the value will be returned here.", "example": [ { "label": "Lawrence Jones", "literal": "SEV123" } ], "items": { "$ref": "#/components/schemas/CatalogEntryEngineParamBindingValueV3" }, "type": "array" }, "value": { "$ref": "#/components/schemas/CatalogEntryEngineParamBindingValueV3" } }, "type": "object" }, "CatalogTypeSchemaV3": { "example": { "attributes": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "version": 1 }, "properties": { "attributes": { "description": "Attributes of this catalog type", "example": [ { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" } ], "items": { "$ref": "#/components/schemas/CatalogTypeAttributeV3" }, "type": "array" }, "version": { "description": "The version number of this schema", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "attributes", "version" ], "type": "object" }, "CatalogEngineParamBindingValuePayloadV3": { "example": { "literal": "SEV123" }, "properties": { "literal": { "description": "If set, this is the literal value of the step parameter", "example": "SEV123", "type": "string" } }, "type": "object" }, "CatalogTypeAttributePathItemPayloadV3": { "example": { "attribute_id": "abc123" }, "properties": { "attribute_id": { "description": "the ID of the attribute to use", "example": "abc123", "type": "string" } }, "required": [ "attribute_id" ], "type": "object" }, "ExpressionV2": { "example": { "else_branch": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "label": "Team Slack channel", "operations": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "reference": "abc123", "returns": { "array": true, "type": "IncidentStatus" }, "root_reference": "incident.status" }, "properties": { "else_branch": { "$ref": "#/components/schemas/ExpressionElseBranchV2" }, "label": { "description": "The human readable label of the expression", "example": "Team Slack channel", "type": "string" }, "operations": { "example": [ { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } } ], "items": { "$ref": "#/components/schemas/ExpressionOperationV2" }, "type": "array" }, "reference": { "description": "A short ID that can be used to reference the expression", "example": "abc123", "type": "string" }, "returns": { "$ref": "#/components/schemas/ReturnsMetaV2" }, "root_reference": { "description": "The root reference for this expression (i.e. where the expression starts)", "example": "incident.status", "type": "string" } }, "required": [ "label", "reference", "returns", "root_reference", "operations" ], "type": "object" }, "EscalationPathTemplateNodeV2": { "example": { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" }, "properties": { "delay": { "$ref": "#/components/schemas/EscalationPathNodeDelayV2" }, "escalation_path": { "$ref": "#/components/schemas/EscalationPathNodeEscalationPathV2" }, "id": { "description": "An ID for this node, unique within the escalation path.\n\nThis allows you to reference the node in other nodes, such as when configuring a 'repeat' node.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "if_else": { "$ref": "#/components/schemas/EscalationPathTemplateNodeIfElseV2" }, "level": { "$ref": "#/components/schemas/EscalationPathNodeLevelWithBindingV2" }, "notify_channel": { "$ref": "#/components/schemas/EscalationPathNodeNotifyChannelWithBindingV2" }, "repeat": { "$ref": "#/components/schemas/EscalationPathNodeRepeatV2" }, "type": { "description": "The type of this node. Available types are:\n* level: A set of targets (users or schedules) that should be paged, either all at once, or with a round-robin configuration.\n* notify_channel: Send the escalation to a Slack channel, where it can be acked by anyone in the channel.\n* if_else: Branch the escalation based on a set of conditions.\n* repeat: Go back to a previous node and repeat the logic from there.\n* delay: Pause the escalation for a configured duration before advancing to the next node.\n* escalation_path: Reassign the escalation to another escalation path, continuing from that path's first node.\n* voicemail: Send an inbound caller to voicemail. Only valid inside a call route's path.", "enum": [ "if_else", "repeat", "level", "notify_channel", "delay", "voicemail", "escalation_path" ], "example": "if_else", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "ExpressionElseBranchPayloadV2": { "example": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "result": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" } }, "required": [ "result" ], "type": "object" }, "ExpressionOperationPayloadV2": { "example": { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "navigate": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" } }, "properties": { "branches": { "$ref": "#/components/schemas/ExpressionBranchesOptsPayloadV2" }, "cast": { "$ref": "#/components/schemas/ExpressionCastOptsPayloadV2" }, "concatenate": { "$ref": "#/components/schemas/ExpressionConcatenateOptsPayloadV2" }, "filter": { "$ref": "#/components/schemas/ExpressionFilterOptsPayloadV2" }, "navigate": { "$ref": "#/components/schemas/ExpressionNavigateOptsPayloadV2" }, "operation_type": { "description": "The type of the operation", "enum": [ "navigate", "filter", "concatenate", "count", "min", "max", "sum", "random", "first", "parse", "branches", "cast" ], "example": "navigate", "type": "string" }, "parse": { "$ref": "#/components/schemas/ExpressionParseOptsPayloadV2" } }, "required": [ "operation_type" ], "type": "object" }, "EngineParamBindingV2": { "example": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "properties": { "array_value": { "description": "If array_value is set, this helps render the values", "example": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "items": { "$ref": "#/components/schemas/EngineParamBindingValueV2" }, "type": "array" }, "value": { "$ref": "#/components/schemas/EngineParamBindingValueV2" } }, "type": "object" }, "EscalationPathNodeDelayV2": { "example": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "delay_interval_condition": { "description": "If the delay is relative to a time window, this defines whether we advance when the window is active or inactive", "enum": [ "active", "inactive" ], "example": "active", "type": "string" }, "delay_seconds": { "description": "How long to delay before advancing to the next node in the path, in seconds", "example": 300, "format": "int64", "type": "integer" }, "delay_weekday_interval_config_id": { "description": "If the delay is relative to a time window, this identifies which window it is relative to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "type": "object" }, "EscalationPathNodeEscalationPathV2": { "example": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "escalation_path_id": { "description": "The ID of the escalation path to reassign to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "escalation_path_id" ], "type": "object" }, "EscalationPathTemplateNodeIfElsePayloadV2": { "example": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "then_path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ] }, "properties": { "conditions": { "description": "The condition that defines which branch to take", "example": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "items": { "$ref": "#/components/schemas/ConditionPayloadV2" }, "type": "array" }, "else_path": { "description": "The nodes taken if the condition is not met", "example": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "items": { "$ref": "#/components/schemas/EscalationPathTemplateNodePayloadV2" }, "type": "array" }, "then_path": { "description": "The nodes taken if the condition is met", "example": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "items": { "$ref": "#/components/schemas/EscalationPathTemplateNodePayloadV2" }, "type": "array" } }, "required": [ "then_path", "else_path" ], "type": "object" }, "EscalationPathNodeLevelWithBindingPayloadV2": { "example": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "ack_mode": { "description": "Controls the behaviour of acknowledgements for this level, with 'first' cancelling all other escalations on the same level when someone acks", "enum": [ "all", "first" ], "example": "all", "type": "string" }, "retry_config": { "$ref": "#/components/schemas/EscalationPathRetryConfigV2" }, "round_robin_config": { "$ref": "#/components/schemas/EscalationPathRoundRobinConfigV2" }, "targets": { "description": "The targets (users or schedules), each concrete or a parameter binding.", "example": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "items": { "$ref": "#/components/schemas/EscalationPathTargetWithBindingPayloadV2" }, "type": "array" }, "time_to_ack_interval_condition": { "description": "If the time to ack is relative to a time window, this defines whether we move when the window is active or inactive", "enum": [ "active", "inactive" ], "example": "active", "type": "string" }, "time_to_ack_seconds": { "description": "How long should we wait for this level to acknowledge before proceeding to the next node in the path?", "example": 1800, "format": "int64", "type": "integer" }, "time_to_ack_weekday_interval_config_id": { "description": "If the time to ack is relative to a time window, this identifies which window it is relative to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "targets" ], "type": "object" }, "EscalationPathNodeNotifyChannelWithBindingPayloadV2": { "example": { "targets": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "targets": { "description": "The channels to notify, each concrete or a parameter binding.", "example": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "items": { "$ref": "#/components/schemas/EscalationPathTargetWithBindingPayloadV2" }, "type": "array" }, "time_to_ack_interval_condition": { "description": "If the time to ack is relative to a time window, this defines whether we move when the window is active or inactive", "enum": [ "active", "inactive" ], "example": "active", "type": "string" }, "time_to_ack_seconds": { "description": "How long should we wait for this level to acknowledge before moving on to the next node in the path?", "example": 1800, "format": "int64", "type": "integer" }, "time_to_ack_weekday_interval_config_id": { "description": "If the time to ack is relative to a time window, this identifies which window it is relative to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "targets" ], "type": "object" }, "EscalationPathNodeRepeatV2": { "example": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "repeat_times": { "description": "How many times to repeat these nodes", "example": 3, "format": "int64", "type": "integer" }, "to_node": { "description": "Which node ID we begin repeating from.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "to_node", "repeat_times" ], "type": "object" }, "WeekdayIntervalV2": { "example": { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" }, "properties": { "end_time": { "description": "End time of the interval, in 24hr format", "example": "17:00", "type": "string" }, "start_time": { "description": "Start time of the interval, in 24hr format", "example": "09:00", "type": "string" }, "weekday": { "description": "Weekdays for use within a schedule or escalation path", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "example": "monday", "type": "string", "x-public-api-version": "v2" } }, "required": [ "weekday", "start_time", "end_time" ], "type": "object" }, "EscalationPathNodeV2": { "example": { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" }, "properties": { "delay": { "$ref": "#/components/schemas/EscalationPathNodeDelayV2" }, "escalation_path": { "$ref": "#/components/schemas/EscalationPathNodeEscalationPathV2" }, "id": { "description": "An ID for this node, unique within the escalation path.\n\nThis allows you to reference the node in other nodes, such as when configuring a 'repeat' node.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "if_else": { "$ref": "#/components/schemas/EscalationPathNodeIfElseV2" }, "level": { "$ref": "#/components/schemas/EscalationPathNodeLevelV2" }, "notify_channel": { "$ref": "#/components/schemas/EscalationPathNodeNotifyChannelV2" }, "repeat": { "$ref": "#/components/schemas/EscalationPathNodeRepeatV2" }, "type": { "description": "The type of this node. Available types are:\n* level: A set of targets (users or schedules) that should be paged, either all at once, or with a round-robin configuration.\n* notify_channel: Send the escalation to a Slack channel, where it can be acked by anyone in the channel.\n* if_else: Branch the escalation based on a set of conditions.\n* repeat: Go back to a previous node and repeat the logic from there.\n* delay: Pause the escalation for a configured duration before advancing to the next node.\n* escalation_path: Reassign the escalation to another escalation path, continuing from that path's first node.\n* voicemail: Send an inbound caller to voicemail. Only valid inside a call route's path.", "enum": [ "if_else", "repeat", "level", "notify_channel", "delay", "voicemail", "escalation_path" ], "example": "if_else", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "EscalationPathNodeIfElsePayloadV2": { "example": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "then_path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ] }, "properties": { "conditions": { "description": "The condition that defines which branch to take", "example": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "items": { "$ref": "#/components/schemas/ConditionPayloadV2" }, "type": "array" }, "else_path": { "description": "The nodes that form the levels if our condition is not met", "example": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "items": { "$ref": "#/components/schemas/EscalationPathNodePayloadV2" }, "type": "array" }, "then_path": { "description": "The nodes that form the levels if our condition is met", "example": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "items": { "$ref": "#/components/schemas/EscalationPathNodePayloadV2" }, "type": "array" } }, "required": [ "then_path", "else_path" ], "type": "object" }, "EscalationPathNodeLevelV2": { "example": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "ack_mode": { "description": "Controls the behaviour of acknowledgements for this level, with 'first' cancelling all other escalations on the same level when someone acks", "enum": [ "all", "first" ], "example": "all", "type": "string" }, "retry_config": { "$ref": "#/components/schemas/EscalationPathRetryConfigV2" }, "round_robin_config": { "$ref": "#/components/schemas/EscalationPathRoundRobinConfigV2" }, "targets": { "description": "The targets (users or schedules) for this level", "example": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "items": { "$ref": "#/components/schemas/EscalationPathTargetV2" }, "type": "array" }, "time_to_ack_interval_condition": { "description": "If the time to ack is relative to a time window, this defines whether we move when the window is active or inactive", "enum": [ "active", "inactive" ], "example": "active", "type": "string" }, "time_to_ack_seconds": { "description": "How long should we wait for this level to acknowledge before proceeding to the next node in the path?", "example": 1800, "format": "int64", "type": "integer" }, "time_to_ack_weekday_interval_config_id": { "description": "If the time to ack is relative to a time window, this identifies which window it is relative to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "targets" ], "type": "object" }, "EscalationPathNodeNotifyChannelV2": { "example": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "targets": { "description": "The targets (Slack channels) for this level", "example": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "items": { "$ref": "#/components/schemas/EscalationPathTargetV2" }, "type": "array" }, "time_to_ack_interval_condition": { "description": "If the time to ack is relative to a time window, this defines whether we move when the window is active or inactive", "enum": [ "active", "inactive" ], "example": "active", "type": "string" }, "time_to_ack_seconds": { "description": "How long should we wait for this level to acknowledge before moving on to the next node in the path?", "example": 1800, "format": "int64", "type": "integer" }, "time_to_ack_weekday_interval_config_id": { "description": "If the time to ack is relative to a time window, this identifies which window it is relative to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "targets" ], "type": "object" }, "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" }, "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" }, "FollowUpCategoryV3": { "example": { "description": "Follow-ups related to infrastructure changes.", "id": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "name": "Infrastructure", "rank": 10 }, "properties": { "description": { "description": "Description of the follow-up category", "example": "Follow-ups related to infrastructure changes.", "type": "string" }, "id": { "description": "Unique identifier for the follow-up category", "example": "01GNW4BAQ7XRMFF6FHKNXDFPRW", "type": "string" }, "name": { "description": "Name of the follow-up category", "example": "Infrastructure", "type": "string" }, "rank": { "description": "Rank is used to order the follow-up categories correctly", "example": 10, "format": "int64", "type": "integer" } }, "required": [ "id", "name", "rank" ], "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", "freshservice", "linear", "jira", "salesforce", "jira_server", "github", "gitlab", "service_now", "shortcut", "notion" ], "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" }, "IncidentActivityLogContentV2": { "description": "Details of an activity log entry.\n\nAt most one key is set, and it matches the entry's type. Types not listed here carry no\ncontent: the entry's type and title are all there is.", "example": { "action_created": { "action_id": "01FCNDV6P870EA6S7TK1DSYDG0", "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" } } }, "action_updated": { "action_id": "01FCNDV6P870EA6S7TK1DSYDG0", "new_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "new_status": "completed", "previous_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "previous_status": "outstanding", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "alert_attached_to_incident": { "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" } }, "alert_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "custom_field_value_update": { "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" } ] }, "new_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" } ], "new_values_count": 4, "previous_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" } ], "previous_values_count": 3, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "escalation_acknowledged": { "acknowledger": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "escalation_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_created": { "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" } }, "escalated_to_users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "escalation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG1" }, "follow_up_created": { "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" } }, "follow_up_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "follow_up_updated": { "follow_up_id": "01FCNDV6P870EA6S7TK1DSYDG0", "new_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "new_status": "completed", "new_title": "Add a payments-api rollback runbook", "previous_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "previous_status": "outstanding", "previous_title": "Add a runbook", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "incident_merged": { "incident_update_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merger": { "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" } }, "source_incident": { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } }, "incident_rename": { "new_name": "EU checkout failing after 14:02 deploy", "previous_name": "Checkout errors", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "incident_timestamp_set": { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "new_value": "2026-09-01T13:42:00Z", "previous_value": "2026-09-01T14:00:00Z", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "incident_type_changed": { "new_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" }, "previous_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" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "incident_update": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "message": "Rolled back **payments-api** to v411, error rate recovering.", "new_severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "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" }, "next_update_in_minutes": 30, "previous_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" }, "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" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "incident_visibility_changed": { "new_visibility": "private", "previous_visibility": "public", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "role_update": { "new_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "previous_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", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "status_change": { "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" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "summary_update": { "new_summary": "Checkout is failing for all EU customers since the 14:02 deploy.", "previous_summary": "Checkout is failing for some customers.", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "workflow_ran": { "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" } }, "event_description": "Stopped the synthetic load test in staging.", "event_title": "Load test halted" } }, "properties": { "action_created": { "$ref": "#/components/schemas/ActivityActionRefV2" }, "action_updated": { "$ref": "#/components/schemas/ActivityActionUpdatedV2" }, "alert_attached_to_incident": { "$ref": "#/components/schemas/ActivityAlertRefV2" }, "custom_field_value_update": { "$ref": "#/components/schemas/ActivityCustomFieldValueUpdateV2" }, "escalation_acknowledged": { "$ref": "#/components/schemas/ActivityEscalationAcknowledgedV2" }, "escalation_created": { "$ref": "#/components/schemas/ActivityEscalationCreatedV2" }, "follow_up_created": { "$ref": "#/components/schemas/ActivityFollowUpRefV2" }, "follow_up_updated": { "$ref": "#/components/schemas/ActivityFollowUpUpdatedV2" }, "incident_merged": { "$ref": "#/components/schemas/ActivityIncidentMergedV2" }, "incident_rename": { "$ref": "#/components/schemas/ActivityIncidentRenameV2" }, "incident_timestamp_set": { "$ref": "#/components/schemas/ActivityIncidentTimestampSetV2" }, "incident_type_changed": { "$ref": "#/components/schemas/ActivityIncidentTypeChangedV2" }, "incident_update": { "$ref": "#/components/schemas/ActivityIncidentUpdateV2" }, "incident_visibility_changed": { "$ref": "#/components/schemas/ActivityIncidentVisibilityChangedV2" }, "role_update": { "$ref": "#/components/schemas/ActivityRoleUpdateV2" }, "status_change": { "$ref": "#/components/schemas/ActivityStatusChangeV2" }, "summary_update": { "$ref": "#/components/schemas/ActivitySummaryUpdateV2" }, "workflow_ran": { "$ref": "#/components/schemas/ActivityWorkflowRanV2" } }, "type": "object" }, "ExternalResourceV1": { "example": { "external_id": "123", "permalink": "https://my.pagerduty.com/incidents/ABC", "resource_type": "pager_duty_incident", "title": "The database has gone down" }, "properties": { "external_id": { "description": "ID of the resource in the external system", "example": "123", "type": "string" }, "permalink": { "description": "URL of the resource", "example": "https://my.pagerduty.com/incidents/ABC", "type": "string" }, "resource_type": { "description": "E.g. PagerDuty: the external system that holds the resource", "enum": [ "pager_duty_incident", "opsgenie_alert", "datadog_monitor_alert", "github_pull_request", "gitlab_merge_request", "sentry_issue", "jira_issue", "jsm_alert", "atlassian_statuspage_incident", "zendesk_ticket", "google_calendar_event", "outlook_calendar_event", "slack_file", "salesforce_case", "arbitrary_url", "scrubbed", "statuspage_incident" ], "example": "pager_duty_incident", "type": "string" }, "title": { "description": "Title of resource", "example": "The database has gone down", "type": "string" } }, "required": [ "permalink", "external_id", "title", "resource_type" ], "type": "object" }, "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" }, "IncidentRelationshipDetailsV1": { "example": { "external_id": 123, "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "The database is down" }, "properties": { "external_id": { "description": "External ID of this incident often prepended with 'INC-'", "example": 123, "format": "int64", "type": "integer" }, "id": { "description": "Unique identifier of this incident", "example": "01FCNDV6P870EA6S7TK1DSYD5H", "type": "string" }, "name": { "description": "Name of this incident", "example": "The database is down", "type": "string" } }, "required": [ "id", "name", "external_id" ], "type": "object" }, "IncidentTemplateConfigV1": { "description": "The values an incident template applies to the incidents it creates.", "example": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "workspace": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "properties": { "custom_fields": { "description": "Custom fields configuration", "example": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "items": { "$ref": "#/components/schemas/IncidentTemplateCustomFieldBindingV1" }, "type": "array" }, "incident_mode": { "$ref": "#/components/schemas/IncidentTemplateBindingV1" }, "incident_type": { "$ref": "#/components/schemas/IncidentTemplateBindingV1" }, "name": { "$ref": "#/components/schemas/IncidentTemplateAutoGeneratedBindingV1" }, "severity": { "$ref": "#/components/schemas/IncidentTemplateSeverityBindingV1" }, "start_in_triage": { "$ref": "#/components/schemas/IncidentTemplateBindingV1" }, "summary": { "$ref": "#/components/schemas/IncidentTemplateAutoGeneratedBindingV1" }, "workspace": { "$ref": "#/components/schemas/IncidentTemplateBindingV1" } }, "required": [ "name" ], "type": "object" }, "IncidentTemplateCustomFieldBindingPayloadV1": { "example": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingPayloadV3" }, "custom_field_id": { "description": "ID of the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "merge_strategy": { "description": "The strategy to use when multiple alerts match this route", "enum": [ "first-wins", "last-wins", "append" ], "example": "first-wins", "type": "string" } }, "required": [ "custom_field_id", "binding", "merge_strategy" ], "type": "object" }, "IncidentTemplateBindingPayloadV1": { "example": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingPayloadV3" } }, "type": "object" }, "IncidentTemplateAutoGeneratedBindingPayloadV1": { "example": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "autogenerated": { "description": "Whether this attribute is autogenerated using AI or not", "example": false, "type": "boolean" }, "binding": { "$ref": "#/components/schemas/EngineParamBindingPayloadV3" } }, "type": "object" }, "IncidentTemplateSeverityBindingPayloadV1": { "example": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingPayloadV3" }, "merge_strategy": { "description": "Strategy for merging severity when multiple alerts create/update the same incident", "enum": [ "first-wins", "max" ], "example": "first-wins", "type": "string" } }, "required": [ "merge_strategy" ], "type": "object" }, "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" }, "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" }, "IncidentParticipantV2": { "properties": { "participant_type": { "description": "The role they took in the incident", "enum": [ "observer", "collaborator", "responder" ], "example": "observer", "type": "string" }, "user": { "$ref": "#/components/schemas/UserV2" } }, "required": [ "user", "participant_type" ], "type": "object" }, "WorkloadMinutesV2": { "example": { "minutes_spent_on_incident": 125.5, "minutes_spent_on_incident_in_late_hours": 20.5, "minutes_spent_on_incident_in_sleeping_hours": 15, "minutes_spent_on_incident_in_working_hours": 90 }, "properties": { "minutes_spent_on_incident": { "description": "Total minutes the user spent on the incident", "example": 125.5, "format": "double", "type": "number" }, "minutes_spent_on_incident_in_late_hours": { "description": "Minutes spent during the user's late hours", "example": 20.5, "format": "double", "type": "number" }, "minutes_spent_on_incident_in_sleeping_hours": { "description": "Minutes spent during the user's sleeping hours", "example": 15, "format": "double", "type": "number" }, "minutes_spent_on_incident_in_working_hours": { "description": "Minutes spent during the user's working hours", "example": 90, "format": "double", "type": "number" } }, "required": [ "minutes_spent_on_incident", "minutes_spent_on_incident_in_working_hours", "minutes_spent_on_incident_in_late_hours", "minutes_spent_on_incident_in_sleeping_hours" ], "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" }, "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" }, "CustomFieldValuePayloadV2": { "example": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_catalog_entry_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_link": "https://google.com/", "value_numeric": "123.456", "value_option_id": "01FCNDV6P870EA6S7TK1DSYDG0", "value_text": "This is my text field, I hope you like it", "value_timestamp": "" }, "properties": { "id": { "description": "Unique identifier for the custom field value", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "value_catalog_entry_id": { "description": "ID of the catalog entry. You can also use an ExternalID or an Alias of the catalog entry.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "value_link": { "description": "If the custom field type is 'link', this will contain the value assigned.", "example": "https://google.com/", "type": "string" }, "value_numeric": { "description": "If the custom field type is 'numeric', this will contain the value assigned.", "example": "123.456", "type": "string" }, "value_option_id": { "description": "ID of the custom field option", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "value_text": { "description": "If the custom field type is 'text', this will contain the value assigned.", "example": "This is my text field, I hope you like it", "type": "string" }, "value_timestamp": { "description": "Deprecated: please use incident timestamp values instead", "example": "", "type": "string" } }, "type": "object" }, "MaintenanceWindowEscalationTargetV1": { "example": { "escalation_paths": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "escalation_paths": { "$ref": "#/components/schemas/EngineParamBindingV2" }, "users": { "$ref": "#/components/schemas/EngineParamBindingV2" } }, "type": "object" }, "MaintenanceWindowNotifyChannelV1": { "description": "A channel that will receive notifications about this maintenance window", "example": { "channel_id": "C0ACTHQMHS8", "channel_name": "general", "channel_type": "public", "is_private": false }, "properties": { "channel_id": { "description": "The external provider channel ID (e.g. Slack channel ID)", "example": "C0ACTHQMHS8", "type": "string" }, "channel_name": { "description": "Human readable name of the channel", "example": "general", "type": "string" }, "channel_type": { "description": "The type of channel (e.g. public, private)", "example": "public", "type": "string" }, "is_private": { "description": "Whether the channel is private", "example": false, "type": "boolean" } }, "required": [ "channel_id", "channel_type" ], "type": "object" }, "PolicyAssignmentRulesV2": { "example": { "bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "reminder_cadence_after": { "interval": "daily" }, "reminder_cadence_before": { "interval": "daily" }, "reminder_detected_date_offset_hours": [ 0, 48 ], "reminder_due_date_offset_hours": [ -24, 0, 24 ] }, "properties": { "bindings": { "description": "Bindings which define the user to be assigned. We will assign the first user which evaluates; the rest are fallback values", "example": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "items": { "$ref": "#/components/schemas/EngineParamBindingV2" }, "type": "array" }, "reminder_cadence_after": { "$ref": "#/components/schemas/PolicyReminderCadenceV2" }, "reminder_cadence_before": { "$ref": "#/components/schemas/PolicyReminderCadenceV2" }, "reminder_detected_date_offset_hours": { "description": "List of hours relative to when the finding was detected to remind the assignee. Non-negative only; 0 means immediately on detection. Only valid for policy types that support detection reminders (e.g. schedule).", "example": [ 0, 48 ], "items": { "example": 1, "format": "int64", "type": "integer" }, "type": "array" }, "reminder_due_date_offset_hours": { "description": "List of hours relative to the due date to remind the assignee. Negative values are before the due date, positive after.", "example": [ -24, 0, 24 ], "items": { "example": 1, "format": "int64", "type": "integer" }, "type": "array" } }, "required": [ "bindings", "reminder_due_date_offset_hours" ], "type": "object" }, "PolicyDebriefV2": { "description": "Set when policy_type is debrief.", "example": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "properties": { "due_date_config": { "$ref": "#/components/schemas/PolicyDueDateConfigV2" }, "requirements": { "description": "Conditions a debrief must satisfy to be compliant", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV2" }, "type": "array" }, "run_on_private_incidents": { "description": "Requires the policies.run_on_private scope", "example": false, "type": "boolean" } }, "required": [ "requirements" ], "type": "object" }, "PolicyFollowUpV2": { "description": "Set when policy_type is follow_up.", "example": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "properties": { "due_date_config": { "$ref": "#/components/schemas/PolicyDueDateConfigV2" }, "requirements": { "description": "Conditions a follow-up must satisfy to be compliant, e.g. 'is exported to Jira'", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV2" }, "type": "array" }, "run_on_private_incidents": { "description": "Requires the policies.run_on_private scope", "example": false, "type": "boolean" } }, "required": [ "requirements" ], "type": "object" }, "PolicyPostMortemV2": { "description": "Set when policy_type is post_mortem.", "example": { "due_date_config": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "requirements": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "run_on_private_incidents": false }, "properties": { "due_date_config": { "$ref": "#/components/schemas/PolicyDueDateConfigV2" }, "requirements": { "description": "Conditions a post-mortem must satisfy to be compliant", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV2" }, "type": "array" }, "run_on_private_incidents": { "description": "Requires the policies.run_on_private scope", "example": false, "type": "boolean" } }, "required": [ "requirements" ], "type": "object" }, "PolicyReminderCadenceV2": { "description": "A recurring reminder, which repeats once per interval until the finding is resolved.", "example": { "interval": "daily" }, "properties": { "interval": { "description": "How often to send the reminder, stepping in fixed durations from the due date.", "enum": [ "daily", "weekly" ], "example": "daily", "type": "string" } }, "required": [ "interval" ], "type": "object" }, "PolicyDueDateConfigPayloadV2": { "example": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "applies_from": { "description": "If set, the policy only applies to resources from this timestamp onwards", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "calculation_timezone": { "description": "Timezone the due date is calculated in. Only meaningful when calculation_type is weekdays.", "example": "Europe/London", "type": "string" }, "calculation_type": { "enum": [ "seven_days", "weekdays" ], "example": "weekdays", "type": "string" }, "days": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "incident_timestamp_id": { "description": "Timestamp the due date counts from", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "incident_timestamp_id", "days", "calculation_type" ], "type": "object" }, "PolicyReadinessRuleV2": { "example": { "max_delay_seconds": 300, "method_types": [ "slack" ] }, "properties": { "max_delay_seconds": { "description": "How quickly the method must fire to count", "example": 300, "format": "int64", "type": "integer" }, "method_types": { "example": [ "slack" ], "items": { "enum": [ "slack", "email", "app", "sms", "phone", "live_call", "slack_channel", "microsoft_teams", "microsoft_teams_channel", "whatsapp_message" ], "example": "slack", "type": "string" }, "type": "array" } }, "required": [ "method_types" ], "type": "object" }, "PolicyFindingDebriefV2": { "description": "Set when policy_type is debrief.", "example": { "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "incident_id": { "description": "The incident the debrief belongs to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "incident_id" ], "type": "object" }, "PolicyFindingDismissalV2": { "example": { "dismissed_at": "2021-08-17T13:28:57.801578Z", "dismissed_by": { "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" } }, "reason": "This incident is special." }, "properties": { "dismissed_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "dismissed_by": { "$ref": "#/components/schemas/ActorV2" }, "reason": { "description": "Why it was dismissed", "example": "This incident is special.", "type": "string" } }, "required": [ "dismissed_at", "dismissed_by", "reason" ], "type": "object" }, "PolicyFindingFollowUpV2": { "description": "Set when policy_type is follow_up.", "example": { "follow_up_id": "01FCNDV6P870EA6S7TK1DSYDG0", "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "follow_up_id": { "description": "The follow-up that fell short of the policy", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "incident_id": { "description": "The incident the follow-up belongs to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "incident_id", "follow_up_id" ], "type": "object" }, "PolicyFindingOnCallReadinessV2": { "description": "Set when policy_type is on_call_readiness. The user is always the one the finding is about.", "example": { "high_urgency": [ { "max_delay_seconds": 300, "met": false, "method_types": [ "slack" ] } ], "low_urgency": [ { "max_delay_seconds": 300, "met": false, "method_types": [ "slack" ] } ], "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "high_urgency": { "description": "The high urgency rules the policy requires, and whether each was met", "example": [ { "max_delay_seconds": 300, "met": false, "method_types": [ "slack" ] } ], "items": { "$ref": "#/components/schemas/PolicyFindingReadinessRuleV2" }, "type": "array" }, "low_urgency": { "description": "The low urgency rules the policy requires, and whether each was met", "example": [ { "max_delay_seconds": 300, "met": false, "method_types": [ "slack" ] } ], "items": { "$ref": "#/components/schemas/PolicyFindingReadinessRuleV2" }, "type": "array" }, "user_id": { "description": "The user whose notification rules fell short", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "user_id", "high_urgency", "low_urgency" ], "type": "object" }, "PolicyFindingPostMortemV2": { "description": "Set when policy_type is post_mortem.", "example": { "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "incident_id": { "description": "The incident whose post-mortem fell short of the policy", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "incident_id" ], "type": "object" }, "PolicyFindingScheduleV2": { "description": "Set when policy_type is schedule. Describes a gap in on-call cover.", "example": { "cause": "nobody_scheduled", "end_at": "2021-08-17T13:28:57.801578Z", "has_unscheduled_time": true, "impacted_users": [ { "cause": "no_on_call_seat", "name": "Alice Green", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" } ], "rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0", "start_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "cause": { "description": "Why the gap exists", "enum": [ "nobody_scheduled", "no_on_call_seat", "user_deactivated" ], "example": "nobody_scheduled", "type": "string" }, "end_at": { "description": "When the gap ends", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "has_unscheduled_time": { "description": "Whether part of the gap has nobody scheduled at all, so impacted_users doesn't fully explain it", "example": true, "type": "boolean" }, "impacted_users": { "description": "Users scheduled across the gap whose entries don't count as cover", "example": [ { "cause": "no_on_call_seat", "name": "Alice Green", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" } ], "items": { "$ref": "#/components/schemas/PolicyFindingScheduleImpactedUserV2" }, "type": "array" }, "rotation_id": { "description": "The rotation with the gap, when the policy evaluates per rotation", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "schedule_id": { "description": "The schedule with the gap", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "start_at": { "description": "When the gap starts", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "schedule_id", "start_at", "end_at" ], "type": "object" }, "PolicyFindingVacationConflictV2": { "description": "Set when policy_type is vacation_conflict. Someone is on call while on holiday.", "example": { "end_at": "2021-08-17T13:28:57.801578Z", "holiday_name": "Joe Bloggs - Holiday", "rotation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_id": "01FCNDV6P870EA6S7TK1DSYDG0", "start_at": "2021-08-17T13:28:57.801578Z", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "end_at": { "description": "When the conflict ends", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "holiday_name": { "description": "What the holiday is called in the external system", "example": "Joe Bloggs - Holiday", "type": "string" }, "rotation_id": { "description": "The rotation the holiday conflicts with", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "schedule_id": { "description": "The schedule the holiday conflicts with", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "start_at": { "description": "When the conflict starts", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "user_id": { "description": "The user on holiday", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "user_id", "schedule_id", "start_at", "end_at" ], "type": "object" }, "LinkedScheduleV2": { "example": { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Primary On-Call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ] }, "properties": { "id": { "description": "Unique internal ID of the schedule", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "name": { "description": "Human readable name of the schedule", "example": "Primary On-Call Schedule", "type": "string" }, "team_ids": { "description": "IDs of teams that own this schedule", "example": [ "01JPQA75EPNEES4479P16P4XAB" ], "items": { "example": "abc123", "type": "string" }, "type": "array" } }, "required": [ "id", "name", "team_ids" ], "type": "object" }, "NewSlackUserGroupPayloadV2": { "example": { "description": "The team responsible for Project A", "handle": "project-team-a", "name": "Project Team A", "slack_team_id": "T01234567" }, "properties": { "description": { "description": "Description of the user group", "example": "The team responsible for Project A", "type": "string" }, "handle": { "description": "Handle of the user group", "example": "project-team-a", "type": "string" }, "name": { "description": "Name of the user group", "example": "Project Team A", "type": "string" }, "slack_team_id": { "description": "Slack workspace ID where the user group should be created. Required for Enterprise Grid organizations with multiple workspaces.", "example": "T01234567", "type": "string" } }, "required": [ "name", "handle", "description" ], "type": "object" }, "ScheduleEntryV2": { "description": "A single shift on a schedule, representing who is on-call between a start\nand end time. When present, `rotation_id` and `layer_id` tell you which\nrotation and which layer within that rotation the entry belongs to. A\nschedule may have multiple rotations (for example, a primary and a secondary\nrotation) and each rotation can be made up of several layers — entries are\nreturned for every rotation and layer on the schedule.\n\nEntries come from two places: they are either generated from a schedule's\nrotation configuration (the regular pattern of who is on-call) or created by\nan override (a one-off change that replaces the normal rotation for a period\nof time). When you call the List schedule entries endpoint we return both\nkinds separately, along with the merged `final` schedule that reflects what\nwill actually happen.\n\n`entry_id` is only populated for entries that correspond to a stored\nrecord. Scheduled entries are projections computed from the rotation rules\non the fly and don't have a persisted ID, so `entry_id` will be absent for\nthose. Use `fingerprint` if you need a stable identifier to deduplicate or\ndiff a shift across requests.", "properties": { "end_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "entry_id": { "description": "Unique identifier of the schedule entry", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "fingerprint": { "description": "A unique identifier for this entry, used to determine a unique shift", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "layer_id": { "description": "If present, the layer this entry applies to on the rotation", "example": "01G0J1EXE7AXZ2C93K61WBPYNH", "type": "string" }, "rotation_id": { "description": "If present, the rotation this entry applies to on the schedule", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "start_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "user": { "$ref": "#/components/schemas/UserV2" } }, "required": [ "start_at", "end_at" ], "type": "object" }, "ScheduleConfigV2": { "example": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "properties": { "rotations": { "description": "Rotas in this schedule", "example": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ], "items": { "$ref": "#/components/schemas/ScheduleRotationV2" }, "type": "array" } }, "required": [ "rotations" ], "type": "object" }, "ScheduleHolidaysPublicConfigV2": { "example": { "country_codes": [ "GB", "FR" ] }, "properties": { "country_codes": { "description": "ISO 3166-1 alpha-2 country codes for the countries that this schedule is configured to view holidays for", "example": [ "GB", "FR" ], "items": { "example": "abc123", "type": "string" }, "type": "array" } }, "required": [ "country_codes" ], "type": "object" }, "ScheduleConfigCreatePayloadV2": { "example": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "properties": { "rotations": { "example": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ], "items": { "$ref": "#/components/schemas/ScheduleRotationCreatePayloadV2" }, "type": "array" } }, "type": "object" }, "ScheduleHolidaysPublicConfigPayloadV2": { "example": { "country_codes": [ "abc123" ] }, "properties": { "country_codes": { "description": "ISO 3166-1 alpha-2 country codes for the countries that this schedule is configured to view holidays for", "example": [ "abc123" ], "items": { "example": "abc123", "type": "string" }, "type": "array" } }, "required": [ "country_codes" ], "type": "object" }, "ScheduleConfigUpdatePayloadV2": { "example": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "properties": { "rotations": { "example": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ], "items": { "$ref": "#/components/schemas/ScheduleRotationUpdatePayloadV2" }, "type": "array" } }, "type": "object" }, "ScheduleReplicaSourceV2": { "example": { "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH" }, "properties": { "layer_id": { "description": "The ID of the layer within the rotation to replicate. Rotations can have multiple layers that stack on top of each other, and you must specify which layer to replicate.", "example": "01G0J1EXE7AXZ2C93K61WBPYNH", "type": "string" }, "rotation_id": { "description": "The ID of the rotation within the schedule to replicate. Each schedule can have multiple rotations, and you can choose which ones to include in the replica.", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } }, "required": [ "rotation_id", "layer_id" ], "type": "object" }, "ScheduleReplicaUserStatusV2": { "example": { "external_user_id": "PJYTRGS", "user_id": "01G0J1EXE7AXZ2C93K61WBPYEH" }, "properties": { "external_user_id": { "description": "The corresponding user ID in the external provider (e.g. a PagerDuty user ID). If set, the user has been successfully mapped to an external user and will be included in the replica. If null, the user could not be resolved and syncing may produce errors.", "example": "PJYTRGS", "type": "string" }, "user_id": { "description": "The incident.io user ID for a user who appears in the schedule rotation.", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" } }, "required": [ "user_id" ], "type": "object" }, "StatusPageIncidentComponentImpactV2": { "example": { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "component_status": "degraded_performance", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "component_id": { "description": "The ID of the affected component. This may be found by calling the ShowStatusPageStructure endpoint.", "example": "01GW7P4ES31Q6V1ZQH321T0GJN", "type": "string" }, "component_status": { "description": "The status of the relevant component impact in a status page incident - this excludes the operational status.", "enum": [ "degraded_performance", "partial_outage", "full_outage" ], "example": "degraded_performance", "type": "string", "x-public-api-version": "v2" }, "end_at": { "description": "When the component left this status. If this is null, the impact is ongoing.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "start_at": { "description": "When the component entered this status", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "component_id", "component_status", "start_at" ], "type": "object" }, "StatusPageMaintenanceComponentMaintenancePeriodV2": { "example": { "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN", "end_at": "2021-08-17T13:28:57.801578Z", "start_at": "2021-08-17T13:28:57.801578Z" }, "properties": { "component_id": { "description": "The ID of the affected component. This may be found by calling the ShowStatusPageStructure endpoint.", "example": "01GW7P4ES31Q6V1ZQH321T0GJN", "type": "string" }, "end_at": { "description": "When the component stopped being under maintenance. If this is null, the impact is ongoing.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "start_at": { "description": "When the component started being under maintenance", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" } }, "required": [ "component_id", "start_at" ], "type": "object" }, "StatusPageStructureItemV2": { "example": { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" }, "sub_page": { "id": "01FCNDV6P870EA6S7TK1DSYDG1", "items": [ { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" } } ], "name": "United Kingdom" } }, "properties": { "component": { "$ref": "#/components/schemas/StatusPageStructureComponentV2" }, "group": { "$ref": "#/components/schemas/StatusPageStructureGroupV2" }, "sub_page": { "$ref": "#/components/schemas/StatusPageStructureSubPageV2" } }, "type": "object" }, "CatalogEntrySlimV3V3": { "example": { "external_id": "761722cd-d1d7-477b-ac7e-90f9e079dc33", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Primary On-call" }, "properties": { "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" }, "UserV3": { "example": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "slack_user_id": "U02AYNF2XJM" }, "properties": { "email": { "description": "Email address of the user.", "example": "lisa@incident.io", "type": "string" }, "id": { "description": "Unique identifier of the user", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Name of the user", "example": "Lisa Karlin Curtis", "type": "string" }, "slack_user_id": { "description": "Slack ID of the user", "example": "U02AYNF2XJM", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "RBACRoleV2": { "example": { "description": "Elevated permissions for the customer success team.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Customer Success", "slug": "customer-success" }, "properties": { "description": { "description": "Description of the purpose for the RBAC role", "example": "Elevated permissions for the customer success team.", "type": "string" }, "id": { "description": "Unique identifier of the RBAC role", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Name of the RBAC role", "example": "Customer Success", "type": "string" }, "slug": { "description": "Unique human-readable slug for the RBAC role", "example": "customer-success", "type": "string" } }, "required": [ "id", "name", "slug" ], "type": "object" }, "UserSeatsV2": { "example": { "on_call": "full_access", "response": "viewer_only" }, "properties": { "on_call": { "description": "On-call seat access level", "enum": [ "full_access", "viewer_only", "none" ], "example": "full_access", "type": "string" }, "response": { "description": "Response seat access level", "enum": [ "full_access", "viewer_only", "none" ], "example": "viewer_only", "type": "string" } }, "required": [ "on_call", "response" ], "type": "object" }, "OnCallNotificationMethodPhoneDetailsPublicV2": { "example": { "supports_sms": true, "supports_voice": true }, "properties": { "supports_sms": { "description": "Whether this phone number can receive SMS notifications.", "example": true, "type": "boolean" }, "supports_voice": { "description": "Whether this phone number can receive voice call notifications.", "example": true, "type": "boolean" } }, "required": [ "supports_sms", "supports_voice" ], "type": "object" }, "OnCallNotificationRuleAppDetailsPublicV2": { "example": { "push_notification_criticality": "critical" }, "properties": { "push_notification_criticality": { "description": "Controls the interruption level of push notifications. 'critical' bypasses Do Not Disturb, 'active' respects it.", "enum": [ "critical", "active" ], "example": "critical", "type": "string", "x-public-api-version": "v2" } }, "required": [ "push_notification_criticality" ], "type": "object" }, "OnCallNotificationRuleMethodTargetPublicV2": { "example": { "all": {}, "specific": { "id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "specific" }, "properties": { "all": { "$ref": "#/components/schemas/OnCallNotificationRuleMethodTargetAllPublicV2" }, "specific": { "$ref": "#/components/schemas/OnCallNotificationRuleMethodTargetSpecificPublicV2" }, "type": { "description": "Whether this targets a specific method or all methods of a given type.", "enum": [ "specific", "all" ], "example": "specific", "type": "string" } }, "required": [ "type" ], "type": "object" }, "OnCallNotificationRulePhoneDetailsPublicV2": { "example": { "channel": "voice" }, "properties": { "channel": { "description": "Which channel of a phone notification method this rule uses.", "enum": [ "sms", "voice" ], "example": "voice", "type": "string", "x-public-api-version": "v2" } }, "required": [ "channel" ], "type": "object" }, "IdentityTeamV1": { "example": { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Platform" }, "properties": { "id": { "description": "Unique identifier for the team", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "name": { "description": "Human readable name of the team", "example": "Platform", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "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" }, "EngineReferenceV2": { "example": { "array": false, "key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "label": "Incident -> Affected Team", "type": "IncidentSeverity" }, "properties": { "array": { "description": "If true, the reference can refer to 0 to many items", "example": false, "type": "boolean" }, "key": { "description": "Unique identifier of field will set", "example": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]", "type": "string" }, "label": { "description": "Human readable label for the field (with context)", "example": "Incident -> Affected Team", "type": "string" }, "type": { "description": "The type of this resource in the engine", "example": "IncidentSeverity", "type": "string" } }, "required": [ "key", "label", "type", "array" ], "type": "object" }, "StepConfigSlimV2": { "example": { "label": "PagerDuty Escalate", "name": "pagerduty.escalate" }, "properties": { "label": { "description": "Human readable identifier for this step", "example": "PagerDuty Escalate", "type": "string" }, "name": { "description": "Unique name of the step in the engine", "example": "pagerduty.escalate", "type": "string" } }, "required": [ "name", "label" ], "type": "object" }, "TriggerSlimV2": { "example": { "label": "Incident Updated", "name": "incident.updated" }, "properties": { "label": { "description": "Human readable identifier for this trigger", "example": "Incident Updated", "type": "string" }, "name": { "description": "Unique name of the trigger", "example": "incident.updated", "type": "string" } }, "required": [ "name", "label" ], "type": "object" }, "WorkflowFormFieldV2": { "example": { "array": true, "description": "The customer affected by this incident", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "key": "affected_customer", "required": true, "title": "Affected customer", "type": "User" }, "properties": { "array": { "description": "Whether this field holds a list of values rather than a single value", "example": true, "type": "boolean" }, "description": { "description": "Optional help text shown beneath the field", "example": "The customer affected by this incident", "type": "string" }, "id": { "description": "Stable identifier for this form field, preserved across versions", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "key": { "description": "The key used to reference this field in the workflow scope", "example": "affected_customer", "type": "string" }, "required": { "description": "Whether this field must be filled in when running the workflow", "example": true, "type": "boolean" }, "title": { "description": "Human readable title shown in the form", "example": "Affected customer", "type": "string" }, "type": { "description": "The engine resource type of this field", "example": "User", "type": "string" } }, "required": [ "id", "key", "title", "type", "array", "required" ], "type": "object" }, "StepConfigV2": { "example": { "for_each": "abc123", "id": "abc123", "label": "PagerDuty Escalate", "name": "pagerduty.escalate", "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ] }, "properties": { "for_each": { "description": "Reference to an expression that returns resources to run this step over", "example": "abc123", "type": "string" }, "id": { "description": "Unique ID of this step in a workflow", "example": "abc123", "type": "string" }, "label": { "description": "Human readable identifier for this step", "example": "PagerDuty Escalate", "type": "string" }, "name": { "description": "Unique name of the step in the engine", "example": "pagerduty.escalate", "type": "string" }, "param_bindings": { "description": "Bindings for the step parameters", "example": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "items": { "$ref": "#/components/schemas/EngineParamBindingV2" }, "type": "array" } }, "required": [ "id", "name", "label", "param_bindings" ], "type": "object" }, "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" }, "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" }, "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" }, "APIKeyActorV1": { "example": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "properties": { "id": { "description": "Unique identifier for this API key", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "The name of the API key, for the user's reference", "example": "My test API key", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "ExpressionBranchesOptsPayloadV3": { "example": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "properties": { "branches": { "description": "The branches to apply for this operation", "example": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/ExpressionBranchPayloadV3" }, "type": "array" }, "returns": { "$ref": "#/components/schemas/ReturnsMetaV3" } }, "required": [ "branches", "returns" ], "type": "object" }, "ExpressionCastOptsPayloadV3": { "example": { "returns": { "array": true, "type": "IncidentStatus" } }, "properties": { "returns": { "$ref": "#/components/schemas/ReturnsMetaV3" } }, "required": [ "returns" ], "type": "object" }, "ExpressionConcatenateOptsPayloadV3": { "example": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "properties": { "reference": { "description": "The reference that you want to concatenate with", "example": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]", "type": "string" } }, "required": [ "reference" ], "type": "object" }, "ExpressionFilterOptsPayloadV3": { "example": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ] }, "properties": { "condition_groups": { "description": "The condition groups to apply in this filter. Only one group needs to be satisfied for the filter to pass.", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV3" }, "type": "array" } }, "required": [ "condition_groups" ], "type": "object" }, "ExpressionNavigateOptsPayloadV3": { "example": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "properties": { "reference": { "description": "The reference that you want to navigate to", "example": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]", "type": "string" } }, "required": [ "reference" ], "type": "object" }, "ExpressionParseOptsPayloadV3": { "example": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "properties": { "returns": { "$ref": "#/components/schemas/ReturnsMetaV3" }, "source": { "description": "Source expression that is evaluated to a result", "example": "metadata.annotations[\"github.com/repo\"]", "type": "string" } }, "required": [ "source", "returns" ], "type": "object" }, "GroupingKeyV3": { "example": { "reference": "alert.title" }, "properties": { "reference": { "description": "A reference to a property of the alert to group on", "example": "alert.title", "type": "string" } }, "required": [ "reference" ], "type": "object" }, "EngineParamBindingValuePayloadV3": { "example": { "literal": "SEV123", "reference": "incident.severity" }, "properties": { "literal": { "description": "If set, this is the literal value of the step parameter", "example": "SEV123", "type": "string" }, "reference": { "description": "If set, this is the reference into the trigger scope that is the value of this parameter", "example": "incident.severity", "type": "string" } }, "type": "object" }, "AlertRouteCustomFieldBindingPayloadV3": { "example": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingPayloadV3" }, "custom_field_id": { "description": "ID of the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "merge_strategy": { "description": "The strategy to use when multiple alerts match this route", "enum": [ "first-wins", "last-wins", "append" ], "example": "first-wins", "type": "string" } }, "required": [ "custom_field_id", "binding", "merge_strategy" ], "type": "object" }, "AlertRouteTemplateBindingPayloadV3": { "example": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingPayloadV3" } }, "type": "object" }, "AlertRouteAutoGeneratedTemplateBindingPayloadV3": { "example": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "autogenerated": { "description": "Whether this attribute is autogenerated using AI or not", "example": false, "type": "boolean" }, "binding": { "$ref": "#/components/schemas/EngineParamBindingPayloadV3" } }, "type": "object" }, "AlertRouteSeverityBindingPayloadV3": { "example": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingPayloadV3" }, "merge_strategy": { "description": "Strategy for merging severity when multiple alerts create/update the same incident", "enum": [ "first-wins", "max" ], "example": "first-wins", "type": "string" } }, "required": [ "merge_strategy" ], "type": "object" }, "AlertRouteChannelTargetPayloadV3": { "example": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "public", "group_alerts_summary": false }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingPayloadV3" }, "channel_visibility": { "description": "The visibility of the channel", "enum": [ "public", "private", "dm", "group_chat", "assistant" ], "example": "public", "type": "string" }, "group_alerts_summary": { "description": "Whether grouped alerts should render as a single group-summary message per channel", "example": false, "type": "boolean" } }, "required": [ "binding", "channel_visibility" ], "type": "object" }, "ConditionV3": { "example": { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } }, "properties": { "operation": { "$ref": "#/components/schemas/ConditionOperationV3" }, "param_bindings": { "description": "Bindings for the operation parameters", "example": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "items": { "$ref": "#/components/schemas/EngineParamBindingV3" }, "type": "array" }, "subject": { "$ref": "#/components/schemas/ConditionSubjectV3" } }, "required": [ "subject", "operation", "param_bindings" ], "type": "object" }, "AlertRouteEscalationTargetV3": { "example": { "escalation_paths": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "users": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "escalation_paths": { "$ref": "#/components/schemas/EngineParamBindingV3" }, "users": { "$ref": "#/components/schemas/EngineParamBindingV3" } }, "type": "object" }, "AlertRouteWhenAlertJoinsGroupV3": { "example": { "grace_period_seconds": 60, "mode": "on_each_new_alert" }, "properties": { "grace_period_seconds": { "description": "How long to wait before escalating once an alert joins the group, in seconds. Only applies when mode is 'on_each_new_alert'.", "example": 60, "format": "int32", "type": "integer" }, "mode": { "description": "When a subsequent alert joins an existing group, when should we escalate again?", "enum": [ "on_priority_increase", "on_each_new_alert" ], "example": "on_each_new_alert", "type": "string" } }, "required": [ "mode" ], "type": "object" }, "ExpressionElseBranchV3": { "example": { "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "result": { "$ref": "#/components/schemas/EngineParamBindingV3" } }, "required": [ "result" ], "type": "object" }, "ExpressionOperationV3": { "example": { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } }, "properties": { "branches": { "$ref": "#/components/schemas/ExpressionBranchesOptsV3" }, "cast": { "$ref": "#/components/schemas/ExpressionCastOptsV3" }, "concatenate": { "$ref": "#/components/schemas/ExpressionConcatenateOptsV3" }, "filter": { "$ref": "#/components/schemas/ExpressionFilterOptsV3" }, "navigate": { "$ref": "#/components/schemas/ExpressionNavigateOptsV3" }, "operation_type": { "description": "The type of the operation", "enum": [ "navigate", "filter", "concatenate", "count", "min", "max", "sum", "random", "first", "parse", "branches", "cast" ], "example": "navigate", "type": "string" }, "parse": { "$ref": "#/components/schemas/ExpressionParseOptsV3" }, "returns": { "$ref": "#/components/schemas/ReturnsMetaV3" } }, "required": [ "operation_type", "returns" ], "type": "object" }, "ReturnsMetaV3": { "example": { "array": true, "type": "IncidentStatus" }, "properties": { "array": { "description": "Whether the return value should be single or multi-value", "example": true, "type": "boolean" }, "type": { "description": "Expected return type of this expression (what to try casting the result to)", "example": "IncidentStatus", "type": "string" } }, "required": [ "type", "array" ], "type": "object" }, "EngineParamBindingV3": { "example": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "properties": { "array_value": { "description": "If array_value is set, this helps render the values", "example": [ { "literal": "SEV123", "reference": "incident.severity" } ], "items": { "$ref": "#/components/schemas/EngineParamBindingValueV3" }, "type": "array" }, "value": { "$ref": "#/components/schemas/EngineParamBindingValueV3" } }, "type": "object" }, "AlertRouteIncidentTemplateV3": { "description": "The template an alert route applies to the incidents it creates. Disabling incident creation clears it.", "example": { "custom_fields": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "incident_mode": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "incident_type": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "membership_teams": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "name": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "severity": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "start_in_triage": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "summary": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } }, "properties": { "custom_fields": { "description": "Custom fields configuration", "example": [ { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" } ], "items": { "$ref": "#/components/schemas/AlertRouteCustomFieldBindingV3" }, "type": "array" }, "incident_mode": { "$ref": "#/components/schemas/AlertRouteTemplateBindingV3" }, "incident_type": { "$ref": "#/components/schemas/AlertRouteTemplateBindingV3" }, "membership_teams": { "$ref": "#/components/schemas/AlertRouteTemplateBindingV3" }, "name": { "$ref": "#/components/schemas/AlertRouteAutoGeneratedTemplateBindingV3" }, "severity": { "$ref": "#/components/schemas/AlertRouteSeverityBindingV3" }, "start_in_triage": { "$ref": "#/components/schemas/AlertRouteTemplateBindingV3" }, "summary": { "$ref": "#/components/schemas/AlertRouteAutoGeneratedTemplateBindingV3" } }, "required": [ "name" ], "type": "object" }, "AlertMessageDestinationV3": { "example": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "ms_teams_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123", "group_alerts_summary": false }, "slack_targets": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123", "group_alerts_summary": false } }, "properties": { "condition_groups": { "description": "The conditions that must be met for this channel config to be used", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV3" }, "type": "array" }, "ms_teams_targets": { "$ref": "#/components/schemas/AlertRouteChannelTargetV3" }, "slack_targets": { "$ref": "#/components/schemas/AlertRouteChannelTargetV3" } }, "required": [ "condition_groups" ], "type": "object" }, "ConditionV2": { "example": { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } }, "properties": { "operation": { "$ref": "#/components/schemas/ConditionOperationV2" }, "param_bindings": { "description": "Bindings for the operation parameters", "example": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "items": { "$ref": "#/components/schemas/EngineParamBindingV2" }, "type": "array" }, "subject": { "$ref": "#/components/schemas/ConditionSubjectV2" } }, "required": [ "subject", "operation", "param_bindings" ], "type": "object" }, "AlertTemplateAttributeV2": { "example": { "alert_attribute_id": "abc123", "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "alert_attribute_id": { "description": "ID of the alert attribute to set with this binding", "example": "abc123", "type": "string" }, "binding": { "$ref": "#/components/schemas/AlertTemplateAttributeBindingV2" } }, "required": [ "alert_attribute_id", "binding" ], "type": "object" }, "EngineParamBindingValueV2": { "example": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" }, "properties": { "label": { "description": "Human readable label to be displayed for user to select", "example": "Lawrence Jones", "type": "string" }, "literal": { "description": "If set, this is the literal value of the step parameter", "example": "SEV123", "type": "string" }, "reference": { "description": "If set, this is the reference into the trigger scope that is the value of this parameter", "example": "incident.severity", "type": "string" } }, "required": [ "label" ], "type": "object" }, "AlertTemplateAttributeBindingPayloadV2": { "example": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "literal": "SEV123", "reference": "incident.severity" } }, "properties": { "array_value": { "description": "If set, this is the array value of the step parameter", "example": [ { "literal": "SEV123", "reference": "incident.severity" } ], "items": { "$ref": "#/components/schemas/EngineParamBindingValuePayloadV2" }, "type": "array" }, "merge_strategy": { "description": "Merge strategy for this attribute when alert updates", "enum": [ "first_wins", "last_wins", "append", "max", "min" ], "example": "first_wins", "type": "string" }, "value": { "$ref": "#/components/schemas/EngineParamBindingValuePayloadV2" } }, "type": "object" }, "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" }, "CallRouteTargetV2": { "description": "Someone a call route pages when a call comes in.", "example": { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" }, "properties": { "id": { "description": "Uniquely identifies an entity of this type", "example": "lawrencejones", "type": "string" }, "schedule_mode": { "description": "Only set for schedule targets, this specifies which users to fetch from the schedule. Use currently_on_call to notify whoever is on call right now across the schedule, all_users to notify every user attached to the schedule, or all_users_for_rota / currently_on_call_for_rota / next_on_call_for_rota to scope to a specific rota (in which case selected_rota_id is required). next_on_call notifies whoever is next on call across the schedule.", "enum": [ "currently_on_call", "all_users_for_rota", "all_users", "currently_on_call_for_rota", "next_on_call_for_rota", "next_on_call", "" ], "example": "currently_on_call", "type": "string" }, "selected_rota_id": { "description": "For schedule targets, identifies which rota on the schedule the schedule_mode applies to. Required when schedule_mode is all_users_for_rota, currently_on_call_for_rota, or next_on_call_for_rota; must be omitted for other schedule_mode values.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "type": { "description": "Whether a call route target is a user or a schedule", "enum": [ "user", "schedule" ], "example": "schedule", "type": "string", "x-public-api-version": "v2" }, "urgency": { "description": "The urgency of this escalation path target", "enum": [ "high", "low" ], "example": "high", "type": "string" } }, "required": [ "type", "id", "urgency" ], "type": "object" }, "CatalogEntryEngineParamBindingValueV3": { "example": { "label": "Lawrence Jones", "literal": "SEV123" }, "properties": { "label": { "description": "A label for this attribute value. If the attribute refers to another Catalog entry, this will be the name of that entry.", "example": "Lawrence Jones", "type": "string" }, "literal": { "description": "The underlying value of the attribute, serialized as a string.\n\nFor String, Text, Number, and Bool typed attributes, this will be empty. For attributes that refer to another catalog entry, this can be the ID, external ID, or one of the aliases of that catalog entry.", "example": "SEV123", "type": "string" } }, "required": [ "label" ], "type": "object" }, "CatalogTypeAttributeV3": { "example": { "array": false, "backlink_attribute": "abc123", "id": "01GW2G3V0S59R238FAHPDS1R66", "mode": "", "name": "tier", "path": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "type": "Custom[\"Service\"]" }, "properties": { "array": { "description": "Whether this attribute is an array", "example": false, "type": "boolean" }, "backlink_attribute": { "description": "The attribute to use (if this is a backlink)", "example": "abc123", "type": "string" }, "id": { "description": "The ID of this attribute", "example": "01GW2G3V0S59R238FAHPDS1R66", "type": "string" }, "mode": { "description": "Controls how this attribute is modified", "enum": [ "", "api", "dashboard", "external", "internal", "dynamic", "backlink", "path" ], "example": "", "type": "string", "x-public-api-version": "v3" }, "name": { "description": "Unique name of this attribute", "example": "tier", "type": "string" }, "path": { "description": "The path to use (if this is a path attribute)", "example": [ { "attribute_id": "abc123", "attribute_name": "abc123" } ], "items": { "$ref": "#/components/schemas/CatalogTypeAttributePathItemV3" }, "type": "array" }, "type": { "description": "Catalog type name for this attribute", "example": "Custom[\"Service\"]", "type": "string" } }, "required": [ "id", "mode", "name", "type", "array" ], "type": "object" }, "ExpressionElseBranchV2": { "example": { "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "result": { "$ref": "#/components/schemas/EngineParamBindingV2" } }, "required": [ "result" ], "type": "object" }, "ExpressionOperationV2": { "example": { "branches": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "cast": { "returns": { "array": true, "type": "IncidentStatus" } }, "concatenate": { "reference": "1235", "reference_label": "Teams" }, "filter": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "navigate": { "reference": "1235", "reference_label": "Teams" }, "operation_type": "navigate", "parse": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "returns": { "array": true, "type": "IncidentStatus" } }, "properties": { "branches": { "$ref": "#/components/schemas/ExpressionBranchesOptsV2" }, "cast": { "$ref": "#/components/schemas/ExpressionCastOptsV2" }, "concatenate": { "$ref": "#/components/schemas/ExpressionConcatenateOptsV2" }, "filter": { "$ref": "#/components/schemas/ExpressionFilterOptsV2" }, "navigate": { "$ref": "#/components/schemas/ExpressionNavigateOptsV2" }, "operation_type": { "description": "The type of the operation", "enum": [ "navigate", "filter", "concatenate", "count", "min", "max", "sum", "random", "first", "parse", "branches", "cast" ], "example": "navigate", "type": "string" }, "parse": { "$ref": "#/components/schemas/ExpressionParseOptsV2" }, "returns": { "$ref": "#/components/schemas/ReturnsMetaV2" } }, "required": [ "operation_type", "returns" ], "type": "object" }, "ReturnsMetaV2": { "example": { "array": true, "type": "IncidentStatus" }, "properties": { "array": { "description": "Whether the return value should be single or multi-value", "example": true, "type": "boolean" }, "type": { "description": "Expected return type of this expression (what to try casting the result to)", "example": "IncidentStatus", "type": "string" } }, "required": [ "type", "array" ], "type": "object" }, "EscalationPathTemplateNodeIfElseV2": { "example": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "then_path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ] }, "properties": { "conditions": { "description": "The condition that defines which branch to take", "example": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "items": { "$ref": "#/components/schemas/ConditionV2" }, "type": "array" }, "else_path": { "description": "The nodes taken if the condition is not met", "example": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "items": { "$ref": "#/components/schemas/EscalationPathTemplateNodeV2" }, "type": "array" }, "then_path": { "description": "The nodes taken if the condition is met", "example": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "items": { "$ref": "#/components/schemas/EscalationPathTemplateNodeV2" }, "type": "array" } }, "required": [ "conditions", "then_path", "else_path" ], "type": "object" }, "EscalationPathNodeLevelWithBindingV2": { "example": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "ack_mode": { "description": "Controls the behaviour of acknowledgements for this level, with 'first' cancelling all other escalations on the same level when someone acks", "enum": [ "all", "first" ], "example": "all", "type": "string" }, "retry_config": { "$ref": "#/components/schemas/EscalationPathRetryConfigV2" }, "round_robin_config": { "$ref": "#/components/schemas/EscalationPathRoundRobinConfigV2" }, "targets": { "description": "The targets (users or schedules), each concrete or a parameter binding.", "example": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "items": { "$ref": "#/components/schemas/EscalationPathTargetWithBindingV2" }, "type": "array" }, "time_to_ack_interval_condition": { "description": "If the time to ack is relative to a time window, this defines whether we move when the window is active or inactive", "enum": [ "active", "inactive" ], "example": "active", "type": "string" }, "time_to_ack_seconds": { "description": "How long should we wait for this level to acknowledge before proceeding to the next node in the path?", "example": 1800, "format": "int64", "type": "integer" }, "time_to_ack_weekday_interval_config_id": { "description": "If the time to ack is relative to a time window, this identifies which window it is relative to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "targets" ], "type": "object" }, "EscalationPathNodeNotifyChannelWithBindingV2": { "example": { "targets": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "targets": { "description": "The channels to notify, each concrete or a parameter binding.", "example": [ { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "items": { "$ref": "#/components/schemas/EscalationPathTargetWithBindingV2" }, "type": "array" }, "time_to_ack_interval_condition": { "description": "If the time to ack is relative to a time window, this defines whether we move when the window is active or inactive", "enum": [ "active", "inactive" ], "example": "active", "type": "string" }, "time_to_ack_seconds": { "description": "How long should we wait for this level to acknowledge before moving on to the next node in the path?", "example": 1800, "format": "int64", "type": "integer" }, "time_to_ack_weekday_interval_config_id": { "description": "If the time to ack is relative to a time window, this identifies which window it is relative to", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "targets" ], "type": "object" }, "ExpressionBranchesOptsPayloadV2": { "example": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "properties": { "branches": { "description": "The branches to apply for this operation", "example": [ { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/ExpressionBranchPayloadV2" }, "type": "array" }, "returns": { "$ref": "#/components/schemas/ReturnsMetaV2" } }, "required": [ "branches", "returns" ], "type": "object" }, "ExpressionCastOptsPayloadV2": { "example": { "returns": { "array": true, "type": "IncidentStatus" } }, "properties": { "returns": { "$ref": "#/components/schemas/ReturnsMetaV2" } }, "required": [ "returns" ], "type": "object" }, "ExpressionConcatenateOptsPayloadV2": { "example": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "properties": { "reference": { "description": "The reference that you want to concatenate with", "example": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]", "type": "string" } }, "required": [ "reference" ], "type": "object" }, "ExpressionFilterOptsPayloadV2": { "example": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ] }, "properties": { "condition_groups": { "description": "The condition groups to apply in this filter. Only one group needs to be satisfied for the filter to pass.", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" } }, "required": [ "condition_groups" ], "type": "object" }, "ExpressionNavigateOptsPayloadV2": { "example": { "reference": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]" }, "properties": { "reference": { "description": "The reference that you want to navigate to", "example": "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]", "type": "string" } }, "required": [ "reference" ], "type": "object" }, "ExpressionParseOptsPayloadV2": { "example": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "properties": { "returns": { "$ref": "#/components/schemas/ReturnsMetaV2" }, "source": { "description": "Source expression that is evaluated to a result", "example": "metadata.annotations[\"github.com/repo\"]", "type": "string" } }, "required": [ "source", "returns" ], "type": "object" }, "EscalationPathRetryConfigV2": { "example": { "attempts": 3, "interval_seconds": 300 }, "properties": { "attempts": { "description": "The total number of times we page this level, counting the initial page. For example, 3 means three notifications in total. Must be between 2 and 10.", "example": 3, "format": "int64", "maximum": 10, "minimum": 2, "type": "integer" }, "interval_seconds": { "description": "How long we wait between attempts at this level, in seconds. Must be a whole number of minutes (divisible by 60).", "example": 300, "format": "int64", "type": "integer" } }, "required": [ "attempts", "interval_seconds" ], "type": "object" }, "EscalationPathRoundRobinConfigV2": { "example": { "enabled": false, "rotate_after_seconds": 120 }, "properties": { "enabled": { "description": "Whether round robin is enabled for this level", "example": false, "type": "boolean" }, "rotate_after_seconds": { "description": "How long should we wait before rotating to the next target in a round robin, if not set will stick with a single target per level.", "example": 120, "format": "int64", "type": "integer" } }, "required": [ "enabled" ], "type": "object" }, "EscalationPathTargetWithBindingPayloadV2": { "example": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" }, "id": { "description": "Uniquely identifies a concrete target. Omitted when binding is set.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "schedule_mode": { "description": "Only set for schedule targets, this specifies which users to fetch from the schedule.", "enum": [ "currently_on_call", "all_users_for_rota", "all_users", "currently_on_call_for_rota", "next_on_call_for_rota", "next_on_call", "" ], "example": "currently_on_call", "type": "string" }, "selected_rota_id": { "description": "For schedule targets, identifies which rota on the schedule the schedule_mode applies to.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "type": { "description": "Controls what type of entity this target identifies, such as EscalationPolicy or User", "enum": [ "schedule", "user", "slack_channel", "msteams_channel" ], "example": "schedule", "type": "string", "x-public-api-version": "v2" }, "urgency": { "description": "The urgency of this escalation path target", "enum": [ "high", "low" ], "example": "high", "type": "string" } }, "required": [ "type", "urgency" ], "type": "object" }, "EscalationPathNodeIfElseV2": { "example": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "then_path": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ] }, "properties": { "conditions": { "description": "The condition that defines which branch to take", "example": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "items": { "$ref": "#/components/schemas/ConditionV2" }, "type": "array" }, "else_path": { "description": "The nodes that form the levels if our condition is not met", "example": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "items": { "$ref": "#/components/schemas/EscalationPathNodeV2" }, "type": "array" }, "then_path": { "description": "The nodes that form the levels if our condition is met", "example": [ { "delay": { "delay_interval_condition": "active", "delay_seconds": 300, "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "escalation_path": { "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "if_else": { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ], "else_path": [ {} ], "then_path": [ {} ] }, "level": { "ack_mode": "all", "retry_config": { "attempts": 3, "interval_seconds": 300 }, "round_robin_config": { "enabled": false, "rotate_after_seconds": 120 }, "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "notify_channel": { "targets": [ { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" } ], "time_to_ack_interval_condition": "active", "time_to_ack_seconds": 1800, "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "repeat": { "repeat_times": 3, "to_node": "01FCNDV6P870EA6S7TK1DSYDG0" }, "type": "if_else" } ], "items": { "$ref": "#/components/schemas/EscalationPathNodeV2" }, "type": "array" } }, "required": [ "conditions", "then_path", "else_path" ], "type": "object" }, "EscalationPathTargetV2": { "example": { "id": "lawrencejones", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" }, "properties": { "id": { "description": "Uniquely identifies an entity of this type", "example": "lawrencejones", "type": "string" }, "schedule_mode": { "description": "Only set for schedule targets, this specifies which users to fetch from the schedule. Use currently_on_call to notify whoever is on call right now across the schedule, all_users to notify every user attached to the schedule, or all_users_for_rota / currently_on_call_for_rota / next_on_call_for_rota to scope to a specific rota (in which case selected_rota_id is required). next_on_call notifies whoever is next on call across the schedule.", "enum": [ "currently_on_call", "all_users_for_rota", "all_users", "currently_on_call_for_rota", "next_on_call_for_rota", "next_on_call", "" ], "example": "currently_on_call", "type": "string" }, "selected_rota_id": { "description": "For schedule targets, identifies which rota on the schedule the schedule_mode applies to. Required when schedule_mode is all_users_for_rota, currently_on_call_for_rota, or next_on_call_for_rota; must be omitted for other schedule_mode values.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "type": { "description": "Controls what type of entity this target identifies, such as EscalationPolicy or User", "enum": [ "schedule", "user", "slack_channel", "msteams_channel" ], "example": "schedule", "type": "string", "x-public-api-version": "v2" }, "urgency": { "description": "The urgency of this escalation path target", "enum": [ "high", "low" ], "example": "high", "type": "string" } }, "required": [ "type", "id", "urgency" ], "type": "object" }, "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" }, "ActivityActionRefV2": { "example": { "action_id": "01FCNDV6P870EA6S7TK1DSYDG0", "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" } } }, "properties": { "action_id": { "description": "The action. Fetch it from GET /v2/actions/{id}.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "actor": { "$ref": "#/components/schemas/ActorV2" } }, "required": [ "action_id" ], "type": "object" }, "ActivityActionUpdatedV2": { "example": { "action_id": "01FCNDV6P870EA6S7TK1DSYDG0", "new_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "new_status": "completed", "previous_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "previous_status": "outstanding", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "properties": { "action_id": { "description": "The action that changed. Fetch it from GET /v2/actions/{id}.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "new_assignee": { "$ref": "#/components/schemas/UserV2" }, "new_status": { "description": "Status after, when the status changed", "enum": [ "outstanding", "completed", "deleted", "not_doing" ], "example": "completed", "type": "string" }, "previous_assignee": { "$ref": "#/components/schemas/UserV2" }, "previous_status": { "description": "Status before, when the status changed", "enum": [ "outstanding", "completed", "deleted", "not_doing" ], "example": "outstanding", "type": "string" }, "updater": { "$ref": "#/components/schemas/ActorV2" } }, "required": [ "action_id" ], "type": "object" }, "ActivityAlertRefV2": { "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" } }, "alert_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "actor": { "$ref": "#/components/schemas/ActorV2" }, "alert_id": { "description": "The alert. Fetch it from GET /v2/alerts/{id}.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "alert_id" ], "type": "object" }, "ActivityCustomFieldValueUpdateV2": { "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" } ] }, "new_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" } ], "new_values_count": 4, "previous_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" } ], "previous_values_count": 3, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "properties": { "custom_field": { "$ref": "#/components/schemas/CustomFieldTypeInfoV2" }, "new_values": { "description": "Values after the change, up to 100 of them", "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" }, "new_values_count": { "description": "How many values there are now, which can exceed the array above", "example": 4, "format": "int64", "type": "integer" }, "previous_values": { "description": "Values before the change, up to 100 of them", "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" }, "previous_values_count": { "description": "How many values there were before, which can exceed the array above", "example": 3, "format": "int64", "type": "integer" }, "updater": { "$ref": "#/components/schemas/ActorV2" } }, "type": "object" }, "ActivityEscalationAcknowledgedV2": { "example": { "acknowledger": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "escalation_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "acknowledger": { "$ref": "#/components/schemas/UserV2" }, "escalation_id": { "description": "The escalation that was acknowledged", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "escalation_id" ], "type": "object" }, "ActivityEscalationCreatedV2": { "example": { "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" } }, "escalated_to_users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "escalation_id": "01FCNDV6P870EA6S7TK1DSYDG0", "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG1" }, "properties": { "creator": { "$ref": "#/components/schemas/ActorV2" }, "escalated_to_users": { "description": "Users this escalation paged", "example": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "items": { "$ref": "#/components/schemas/UserV2" }, "type": "array" }, "escalation_id": { "description": "The escalation. Fetch it from GET /v2/escalations/{id}.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "escalation_path_id": { "description": "The escalation path used, when one was", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" } }, "required": [ "escalation_id" ], "type": "object" }, "ActivityFollowUpRefV2": { "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" } }, "follow_up_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "actor": { "$ref": "#/components/schemas/ActorV2" }, "follow_up_id": { "description": "The follow-up. Fetch it from GET /v2/follow_ups/{id}.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "follow_up_id" ], "type": "object" }, "ActivityFollowUpUpdatedV2": { "example": { "follow_up_id": "01FCNDV6P870EA6S7TK1DSYDG0", "new_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "new_status": "completed", "new_title": "Add a payments-api rollback runbook", "previous_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "previous_status": "outstanding", "previous_title": "Add a runbook", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "properties": { "follow_up_id": { "description": "The follow-up that changed. Fetch it from GET /v2/follow_ups/{id}.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "new_assignee": { "$ref": "#/components/schemas/UserV2" }, "new_status": { "description": "Status after, when the status changed", "enum": [ "outstanding", "completed", "deleted", "not_doing" ], "example": "completed", "type": "string" }, "new_title": { "description": "Title after, when the title changed", "example": "Add a payments-api rollback runbook", "type": "string" }, "previous_assignee": { "$ref": "#/components/schemas/UserV2" }, "previous_status": { "description": "Status before, when the status changed", "enum": [ "outstanding", "completed", "deleted", "not_doing" ], "example": "outstanding", "type": "string" }, "previous_title": { "description": "Title before, when the title changed", "example": "Add a runbook", "type": "string" }, "updater": { "$ref": "#/components/schemas/ActorV2" } }, "required": [ "follow_up_id" ], "type": "object" }, "ActivityIncidentMergedV2": { "example": { "incident_update_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merger": { "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" } }, "source_incident": { "external_id": 123, "id": "01FDAG4SAP5TYPT98WGR2N7W91", "name": "Our database is sad", "reference": "INC-123", "status_category": "triage", "summary": "Our database is really really sad, and we don't know why yet.", "visibility": "public" } }, "properties": { "incident_update_id": { "description": "The incident update that carried the merge. Absent on merges recorded before December 2025.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "merger": { "$ref": "#/components/schemas/ActorV2" }, "source_incident": { "$ref": "#/components/schemas/IncidentSlimV2" } }, "type": "object" }, "ActivityIncidentRenameV2": { "example": { "new_name": "EU checkout failing after 14:02 deploy", "previous_name": "Checkout errors", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "properties": { "new_name": { "description": "The incident's name after the rename", "example": "EU checkout failing after 14:02 deploy", "type": "string" }, "previous_name": { "description": "The incident's name before the rename", "example": "Checkout errors", "type": "string" }, "updater": { "$ref": "#/components/schemas/ActorV2" } }, "required": [ "previous_name", "new_name" ], "type": "object" }, "ActivityIncidentTimestampSetV2": { "example": { "incident_timestamp": { "id": "01FCNDV6P870EA6S7TK1DSYD5H", "name": "Impact started", "rank": 1 }, "new_value": "2026-09-01T13:42:00Z", "previous_value": "2026-09-01T14:00:00Z", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "properties": { "incident_timestamp": { "$ref": "#/components/schemas/IncidentTimestampV2" }, "new_value": { "description": "What it was set to", "example": "2026-09-01T13:42:00Z", "format": "date-time", "type": "string" }, "previous_value": { "description": "What it was before. Absent when it was previously unset.", "example": "2026-09-01T14:00:00Z", "format": "date-time", "type": "string" }, "updater": { "$ref": "#/components/schemas/ActorV2" } }, "required": [ "incident_timestamp", "new_value" ], "type": "object" }, "ActivityIncidentTypeChangedV2": { "example": { "new_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" }, "previous_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" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "properties": { "new_incident_type": { "$ref": "#/components/schemas/IncidentTypeV2" }, "previous_incident_type": { "$ref": "#/components/schemas/IncidentTypeV2" }, "updater": { "$ref": "#/components/schemas/ActorV2" } }, "type": "object" }, "ActivityIncidentUpdateV2": { "example": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "message": "Rolled back **payments-api** to v411, error rate recovering.", "new_severity": { "created_at": "2021-08-17T13:28:57.801578Z", "description": "Issues with **low impact**.", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Minor", "rank": 1, "updated_at": "2021-08-17T13:28:57.801578Z" }, "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" }, "next_update_in_minutes": 30, "previous_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" }, "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" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "properties": { "id": { "description": "ID of the incident update", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "message": { "description": "The update the responder wrote, in markdown", "example": "Rolled back **payments-api** to v411, error rate recovering.", "type": "string" }, "new_severity": { "$ref": "#/components/schemas/SeverityV2" }, "new_status": { "$ref": "#/components/schemas/IncidentStatusV2" }, "next_update_in_minutes": { "description": "When the responder said the next update would come", "example": 30, "format": "int64", "type": "integer" }, "previous_severity": { "$ref": "#/components/schemas/SeverityV2" }, "previous_status": { "$ref": "#/components/schemas/IncidentStatusV2" }, "updater": { "$ref": "#/components/schemas/ActorV2" } }, "required": [ "id" ], "type": "object" }, "ActivityIncidentVisibilityChangedV2": { "example": { "new_visibility": "private", "previous_visibility": "public", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "properties": { "new_visibility": { "description": "Visibility after the change", "enum": [ "public", "private" ], "example": "private", "type": "string" }, "previous_visibility": { "description": "Visibility before the change", "enum": [ "public", "private" ], "example": "public", "type": "string" }, "updater": { "$ref": "#/components/schemas/ActorV2" } }, "required": [ "previous_visibility", "new_visibility" ], "type": "object" }, "ActivityRoleUpdateV2": { "example": { "new_assignee": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "previous_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", "role_type": "lead", "shortform": "lead", "updated_at": "2021-08-17T13:28:57.801578Z" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "properties": { "new_assignee": { "$ref": "#/components/schemas/UserV2" }, "previous_assignee": { "$ref": "#/components/schemas/UserV2" }, "role": { "$ref": "#/components/schemas/IncidentRoleV2" }, "updater": { "$ref": "#/components/schemas/ActorV2" } }, "type": "object" }, "ActivityStatusChangeV2": { "example": { "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" }, "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "properties": { "new_status": { "$ref": "#/components/schemas/IncidentStatusV2" }, "previous_status": { "$ref": "#/components/schemas/IncidentStatusV2" }, "updater": { "$ref": "#/components/schemas/ActorV2" } }, "type": "object" }, "ActivitySummaryUpdateV2": { "example": { "new_summary": "Checkout is failing for all EU customers since the 14:02 deploy.", "previous_summary": "Checkout is failing for some customers.", "updater": { "alert": { "id": "01GW2G3V0S59R238FAHPDS1R66", "title": "*errors.withMessage: PG::Error failed to connect" }, "api_key": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My test API key" }, "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "workflow": { "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "My little workflow" } } }, "properties": { "new_summary": { "description": "The summary after this change, in markdown", "example": "Checkout is failing for all EU customers since the 14:02 deploy.", "type": "string" }, "previous_summary": { "description": "The summary before this change, in markdown", "example": "Checkout is failing for some customers.", "type": "string" }, "updater": { "$ref": "#/components/schemas/ActorV2" } }, "type": "object" }, "ActivityWorkflowRanV2": { "example": { "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" } }, "event_description": "Stopped the synthetic load test in staging.", "event_title": "Load test halted" }, "properties": { "creator": { "$ref": "#/components/schemas/ActorV2" }, "event_description": { "description": "Description of the event the workflow added, in markdown", "example": "Stopped the synthetic load test in staging.", "type": "string" }, "event_title": { "description": "Title of the event the workflow added", "example": "Load test halted", "type": "string" } }, "required": [ "event_title" ], "type": "object" }, "IncidentTemplateCustomFieldBindingV1": { "example": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingV3" }, "custom_field_id": { "description": "ID of the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "merge_strategy": { "description": "The strategy to use when multiple alerts match this route", "enum": [ "first-wins", "last-wins", "append" ], "example": "first-wins", "type": "string" } }, "required": [ "custom_field_id", "binding", "merge_strategy" ], "type": "object" }, "IncidentTemplateBindingV1": { "example": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingV3" } }, "type": "object" }, "IncidentTemplateAutoGeneratedBindingV1": { "example": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "autogenerated": { "description": "Whether this attribute is autogenerated using AI or not", "example": false, "type": "boolean" }, "binding": { "$ref": "#/components/schemas/EngineParamBindingV3" } }, "required": [ "autogenerated" ], "type": "object" }, "IncidentTemplateSeverityBindingV1": { "example": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingV3" }, "merge_strategy": { "description": "Strategy for merging severity when multiple alerts create/update the same incident", "enum": [ "first-wins", "max" ], "example": "first-wins", "type": "string" } }, "required": [ "merge_strategy" ], "type": "object" }, "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" }, "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" }, "PolicyDueDateConfigV2": { "example": { "applies_from": "2021-08-17T13:28:57.801578Z", "calculation_timezone": "Europe/London", "calculation_type": "weekdays", "days": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "applies_from": { "description": "If set, the policy only applies to resources from this timestamp onwards", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "calculation_timezone": { "description": "Timezone the due date is calculated in. Only meaningful when calculation_type is weekdays.", "example": "Europe/London", "type": "string" }, "calculation_type": { "enum": [ "seven_days", "weekdays" ], "example": "weekdays", "type": "string" }, "days": { "$ref": "#/components/schemas/EngineParamBindingV2" }, "incident_timestamp_id": { "description": "Timestamp the due date counts from", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "incident_timestamp_id", "days", "calculation_type" ], "type": "object" }, "PolicyFindingReadinessRuleV2": { "example": { "max_delay_seconds": 300, "met": false, "method_types": [ "slack" ] }, "properties": { "max_delay_seconds": { "description": "How quickly the method must fire to count", "example": 300, "format": "int64", "type": "integer" }, "met": { "description": "Whether the user's notification rules satisfy this one", "example": false, "type": "boolean" }, "method_types": { "example": [ "slack" ], "items": { "enum": [ "slack", "email", "app", "sms", "phone", "live_call", "slack_channel", "microsoft_teams", "microsoft_teams_channel", "whatsapp_message" ], "example": "slack", "type": "string" }, "type": "array" } }, "required": [ "method_types", "met" ], "type": "object" }, "PolicyFindingScheduleImpactedUserV2": { "example": { "cause": "no_on_call_seat", "name": "Alice Green", "user_id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "cause": { "description": "Why this user's entries don't count as cover", "enum": [ "no_on_call_seat", "user_deactivated" ], "example": "no_on_call_seat", "type": "string" }, "name": { "example": "Alice Green", "type": "string" }, "user_id": { "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "user_id", "name", "cause" ], "type": "object" }, "ScheduleRotationV2": { "example": { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "Primary On-Call Schedule", "scheduling_mode": "fair", "users": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] }, "properties": { "effective_from": { "description": "When this version of the rotation takes effect. A rotation can appear multiple times in `rotations` with the same `id`, scheduling changes ahead of time: each version applies from its `effective_from` until the next version's. A rotation's first version has no `effective_from`.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "handover_start_at": { "description": "Determines when shifts change hands and who takes them: the first user in `users` comes on shift at this time, handing over to the next user after each `handovers` interval, cycling through the list — for example, weekly handovers from a Monday 09:00 give week-long shifts that change hands on Mondays at 09:00.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "handovers": { "description": "The cadence shifts hand over on. With more than one entry, the intervals apply in turn — for example, one day then three days produces alternating one-day and three-day shifts.", "example": [ { "interval": 1, "interval_type": "hourly" } ], "items": { "$ref": "#/components/schemas/ScheduleRotationHandoverV2" }, "type": "array" }, "id": { "description": "Unique internal ID of the rotation", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "layers": { "description": "Controls how many people are on-call concurrently", "example": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "items": { "$ref": "#/components/schemas/ScheduleLayerV2" }, "type": "array" }, "name": { "description": "Human readable name synced from external provider", "example": "Primary On-Call Schedule", "type": "string" }, "scheduling_mode": { "description": "Scheduling algorithm to use for this rotation. 'fair' balances workload by considering handover duration, while 'sequential' uses simple round-robin rotation through users. Only applies when you have asymmetric handovers (e.g., 2 days then 5 days).", "enum": [ "fair", "sequential" ], "example": "fair", "type": "string" }, "users": { "description": "The people in the rotation, in the order they take shifts.", "example": [ { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } ], "items": { "$ref": "#/components/schemas/UserV2" }, "type": "array" }, "working_interval": { "description": "DEPRECATED: Use working_intervals instead.", "example": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "items": { "$ref": "#/components/schemas/ScheduleRotationWorkingIntervalV2" }, "type": "array" }, "working_intervals": { "description": "Optional restrictions that define when to schedule people for this rota", "example": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "items": { "$ref": "#/components/schemas/ScheduleRotationWorkingIntervalV2" }, "type": "array" } }, "required": [ "id", "name", "layers", "users", "working_intervals", "handover_start_at", "handovers" ], "type": "object" }, "ScheduleRotationCreatePayloadV2": { "example": { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] }, "properties": { "effective_from": { "description": "When this version of the rotation takes effect. A rotation can appear multiple times in `rotations` with the same `id` to schedule changes ahead of time: each version applies from its `effective_from` until the next version's. Leave it unset on a rotation's first or only version.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "handover_start_at": { "description": "Determines when shifts change hands and who takes them: the first user in `users` comes on shift at this time, handing over to the next user after each `handovers` interval, cycling through the list — for example, weekly handovers from a Monday 09:00 give week-long shifts that change hands on Mondays at 09:00.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "handovers": { "description": "The cadence shifts hand over on. With more than one entry, the intervals apply in turn — for example, one day then three days produces alternating one-day and three-day shifts.", "example": [ { "interval": 1, "interval_type": "hourly" } ], "items": { "$ref": "#/components/schemas/ScheduleRotationHandoverV2" }, "type": "array" }, "id": { "description": "Unique identifier of the rotation", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "layers": { "example": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "items": { "$ref": "#/components/schemas/ScheduleLayerCreatePayloadV2" }, "type": "array" }, "name": { "description": "Name of the rotation", "example": "My Rotation", "type": "string" }, "scheduling_mode": { "description": "Scheduling algorithm to use for this rotation. 'fair' balances workload by considering handover duration, while 'sequential' uses simple round-robin rotation through users. Only applies when you have asymmetric handovers (e.g., 2 days then 5 days).", "enum": [ "fair", "sequential" ], "example": "fair", "type": "string" }, "users": { "description": "The people in the rotation, in the order they take shifts.", "example": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "items": { "$ref": "#/components/schemas/UserReferencePayloadV2" }, "type": "array" }, "working_interval": { "description": "DEPRECATED: Use working_intervals instead.", "example": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "items": { "$ref": "#/components/schemas/ScheduleRotationWorkingIntervalCreatePayloadV2" }, "type": "array" }, "working_intervals": { "example": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "items": { "$ref": "#/components/schemas/ScheduleRotationWorkingIntervalCreatePayloadV2" }, "type": "array" } }, "required": [ "name" ], "type": "object" }, "ScheduleRotationUpdatePayloadV2": { "example": { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] }, "properties": { "effective_from": { "description": "When this version of the rotation takes effect. A rotation can appear multiple times in `rotations` with the same `id` to schedule changes ahead of time: each version applies from its `effective_from` until the next version's. Leave it unset on a rotation's first or only version.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "handover_start_at": { "description": "Determines when shifts change hands and who takes them: the first user in `users` comes on shift at this time, handing over to the next user after each `handovers` interval, cycling through the list — for example, weekly handovers from a Monday 09:00 give week-long shifts that change hands on Mondays at 09:00.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "handovers": { "description": "The cadence shifts hand over on. With more than one entry, the intervals apply in turn — for example, one day then three days produces alternating one-day and three-day shifts.", "example": [ { "interval": 1, "interval_type": "hourly" } ], "items": { "$ref": "#/components/schemas/ScheduleRotationHandoverV2" }, "type": "array" }, "id": { "description": "Unique identifier of the rotation", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "layers": { "example": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "items": { "$ref": "#/components/schemas/ScheduleLayerUpdatePayloadV2" }, "type": "array" }, "name": { "description": "Name of the rotation", "example": "My Rotation", "type": "string" }, "scheduling_mode": { "description": "Scheduling algorithm to use for this rotation. 'fair' balances workload by considering handover duration, while 'sequential' uses simple round-robin rotation through users. Only applies when you have asymmetric handovers (e.g., 2 days then 5 days).", "enum": [ "fair", "sequential" ], "example": "fair", "type": "string" }, "users": { "description": "The people in the rotation, in the order they take shifts.", "example": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "items": { "$ref": "#/components/schemas/UserReferencePayloadV2" }, "type": "array" }, "working_interval": { "description": "DEPRECATED: Use working_intervals instead.", "example": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "items": { "$ref": "#/components/schemas/ScheduleRotationWorkingIntervalV2" }, "type": "array" }, "working_intervals": { "example": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "items": { "$ref": "#/components/schemas/ScheduleRotationWorkingIntervalV2" }, "type": "array" } }, "type": "object" }, "StatusPageStructureComponentV2": { "example": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "properties": { "component_id": { "description": "The ID of the affected component. This may be found by calling the ShowStatusPageStructure endpoint.", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" }, "name": { "description": "The name of this component", "example": "App", "type": "string" } }, "required": [ "component_id", "name" ], "type": "object" }, "StatusPageStructureGroupV2": { "example": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" }, "properties": { "components": { "description": "Array of components belonging to this group", "example": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "items": { "$ref": "#/components/schemas/StatusPageStructureComponentV2" }, "type": "array" }, "id": { "description": "Unique ID of this component group", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" }, "name": { "description": "The name of this component group", "example": "EU Data center", "type": "string" } }, "required": [ "id", "name", "components" ], "type": "object" }, "StatusPageStructureSubPageV2": { "example": { "id": "01FCNDV6P870EA6S7TK1DSYDG1", "items": [ { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" } } ], "name": "United Kingdom" }, "properties": { "id": { "description": "Unique ID of this subpage", "example": "01FCNDV6P870EA6S7TK1DSYDG1", "type": "string" }, "items": { "description": "Array of components and groups belonging to this subpage", "example": [ { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" } } ], "items": { "$ref": "#/components/schemas/StatusPageStructureSubPageItemV2" }, "type": "array" }, "name": { "description": "The name of this subpage", "example": "United Kingdom", "type": "string" } }, "required": [ "id", "name", "items" ], "type": "object" }, "OnCallNotificationRuleMethodTargetAllPublicV2": { "example": {}, "type": "object" }, "OnCallNotificationRuleMethodTargetSpecificPublicV2": { "example": { "id": "01FCNDV6P870EA6S7TK1DSYDG0" }, "properties": { "id": { "description": "The ID of the notification method. References a method from the notification methods list.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" } }, "required": [ "id" ], "type": "object" }, "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" }, "ExpressionBranchPayloadV3": { "example": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "condition_groups": { "description": "When one of these condition groups are satisfied, this branch will be evaluated", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "alert.priority" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV3" }, "type": "array" }, "result": { "$ref": "#/components/schemas/EngineParamBindingPayloadV3" } }, "required": [ "condition_groups", "result" ], "type": "object" }, "ConditionOperationV3": { "example": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "properties": { "label": { "description": "Human readable label to be displayed for user to select", "example": "Lawrence Jones", "type": "string" }, "value": { "description": "Unique identifier for this option", "example": "01FCQSP07Z74QMMYPDDGQB9FTG", "type": "string" } }, "required": [ "label", "value" ], "type": "object" }, "ConditionSubjectV3": { "example": { "label": "Priority", "reference": "alert.priority" }, "properties": { "label": { "description": "Human readable identifier for the subject", "example": "Priority", "type": "string" }, "reference": { "description": "Reference into the scope for the value of the subject", "example": "alert.priority", "type": "string" } }, "required": [ "label", "reference" ], "type": "object" }, "ExpressionBranchesOptsV3": { "example": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "properties": { "branches": { "description": "The branches to apply for this operation", "example": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/ExpressionBranchV3" }, "type": "array" }, "returns": { "$ref": "#/components/schemas/ReturnsMetaV3" } }, "required": [ "branches", "returns" ], "type": "object" }, "ExpressionCastOptsV3": { "example": { "returns": { "array": true, "type": "IncidentStatus" } }, "properties": { "returns": { "$ref": "#/components/schemas/ReturnsMetaV3" } }, "required": [ "returns" ], "type": "object" }, "ExpressionConcatenateOptsV3": { "example": { "reference": "1235", "reference_label": "Teams" }, "properties": { "reference": { "description": "The reference within the scope to concatenate with", "example": "1235", "type": "string" }, "reference_label": { "description": "The name of the reference to concatenate with", "example": "Teams", "type": "string" } }, "required": [ "reference", "reference_label" ], "type": "object" }, "ExpressionFilterOptsV3": { "example": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ] }, "properties": { "condition_groups": { "description": "The condition groups to apply in this filter. Only one group needs to be satisfied for the filter to pass.", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV3" }, "type": "array" } }, "required": [ "condition_groups" ], "type": "object" }, "ExpressionNavigateOptsV3": { "example": { "reference": "1235", "reference_label": "Teams" }, "properties": { "reference": { "description": "The reference within the scope to navigate to", "example": "1235", "type": "string" }, "reference_label": { "description": "The name of the reference to navigate to", "example": "Teams", "type": "string" } }, "required": [ "reference", "reference_label" ], "type": "object" }, "ExpressionParseOptsV3": { "example": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "properties": { "returns": { "$ref": "#/components/schemas/ReturnsMetaV3" }, "source": { "description": "Source expression that is evaluated to a result", "example": "metadata.annotations[\"github.com/repo\"]", "type": "string" } }, "required": [ "source", "returns" ], "type": "object" }, "EngineParamBindingValueV3": { "example": { "literal": "SEV123", "reference": "incident.severity" }, "properties": { "literal": { "description": "If set, this is the literal value of the step parameter", "example": "SEV123", "type": "string" }, "reference": { "description": "If set, this is the reference into the trigger scope that is the value of this parameter", "example": "incident.severity", "type": "string" } }, "type": "object" }, "AlertRouteCustomFieldBindingV3": { "example": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0", "merge_strategy": "first-wins" }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingV3" }, "custom_field_id": { "description": "ID of the custom field", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "merge_strategy": { "description": "The strategy to use when multiple alerts match this route", "enum": [ "first-wins", "last-wins", "append" ], "example": "first-wins", "type": "string" } }, "required": [ "custom_field_id", "binding", "merge_strategy" ], "type": "object" }, "AlertRouteTemplateBindingV3": { "example": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingV3" } }, "type": "object" }, "AlertRouteAutoGeneratedTemplateBindingV3": { "example": { "autogenerated": false, "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "autogenerated": { "description": "Whether this attribute is autogenerated using AI or not", "example": false, "type": "boolean" }, "binding": { "$ref": "#/components/schemas/EngineParamBindingV3" } }, "required": [ "autogenerated" ], "type": "object" }, "AlertRouteSeverityBindingV3": { "example": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "merge_strategy": "first-wins" }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingV3" }, "merge_strategy": { "description": "Strategy for merging severity when multiple alerts create/update the same incident", "enum": [ "first-wins", "max" ], "example": "first-wins", "type": "string" } }, "required": [ "merge_strategy" ], "type": "object" }, "AlertRouteChannelTargetV3": { "example": { "binding": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } }, "channel_visibility": "abc123", "group_alerts_summary": false }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingV3" }, "channel_visibility": { "description": "The visibility of the channel", "example": "abc123", "type": "string" }, "group_alerts_summary": { "description": "Whether grouped alerts should render as a single group-summary message per channel", "example": false, "type": "boolean" } }, "required": [ "binding", "channel_visibility" ], "type": "object" }, "ConditionOperationV2": { "example": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "properties": { "label": { "description": "Human readable label to be displayed for user to select", "example": "Lawrence Jones", "type": "string" }, "value": { "description": "Unique identifier for this option", "example": "01FCQSP07Z74QMMYPDDGQB9FTG", "type": "string" } }, "required": [ "label", "value" ], "type": "object" }, "ConditionSubjectV2": { "example": { "label": "Incident Severity", "reference": "incident.severity" }, "properties": { "label": { "description": "Human readable identifier for the subject", "example": "Incident Severity", "type": "string" }, "reference": { "description": "Reference into the scope for the value of the subject", "example": "incident.severity", "type": "string" } }, "required": [ "label", "reference" ], "type": "object" }, "AlertTemplateAttributeBindingV2": { "example": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "merge_strategy": "first_wins", "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "properties": { "array_value": { "description": "If array_value is set, this helps render the values", "example": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "items": { "$ref": "#/components/schemas/EngineParamBindingValueV2" }, "type": "array" }, "merge_strategy": { "description": "Merge strategy for this attribute when alert updates", "enum": [ "first_wins", "last_wins", "append", "max", "min" ], "example": "first_wins", "type": "string" }, "value": { "$ref": "#/components/schemas/EngineParamBindingValueV2" } }, "type": "object" }, "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" }, "CatalogTypeAttributePathItemV3": { "example": { "attribute_id": "abc123", "attribute_name": "abc123" }, "properties": { "attribute_id": { "description": "the ID of the attribute to use", "example": "abc123", "type": "string" }, "attribute_name": { "description": "the name of the attribute to use", "example": "abc123", "type": "string" } }, "required": [ "attribute_id", "attribute_name" ], "type": "object" }, "ExpressionBranchesOptsV2": { "example": { "branches": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "returns": { "array": true, "type": "IncidentStatus" } }, "properties": { "branches": { "description": "The branches to apply for this operation", "example": [ { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } } ], "items": { "$ref": "#/components/schemas/ExpressionBranchV2" }, "type": "array" }, "returns": { "$ref": "#/components/schemas/ReturnsMetaV2" } }, "required": [ "branches", "returns" ], "type": "object" }, "ExpressionCastOptsV2": { "example": { "returns": { "array": true, "type": "IncidentStatus" } }, "properties": { "returns": { "$ref": "#/components/schemas/ReturnsMetaV2" } }, "required": [ "returns" ], "type": "object" }, "ExpressionConcatenateOptsV2": { "example": { "reference": "1235", "reference_label": "Teams" }, "properties": { "reference": { "description": "The reference within the scope to concatenate with", "example": "1235", "type": "string" }, "reference_label": { "description": "The name of the reference to concatenate with", "example": "Teams", "type": "string" } }, "required": [ "reference", "reference_label" ], "type": "object" }, "ExpressionFilterOptsV2": { "example": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ] }, "properties": { "condition_groups": { "description": "The condition groups to apply in this filter. Only one group needs to be satisfied for the filter to pass.", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV2" }, "type": "array" } }, "required": [ "condition_groups" ], "type": "object" }, "ExpressionNavigateOptsV2": { "example": { "reference": "1235", "reference_label": "Teams" }, "properties": { "reference": { "description": "The reference within the scope to navigate to", "example": "1235", "type": "string" }, "reference_label": { "description": "The name of the reference to navigate to", "example": "Teams", "type": "string" } }, "required": [ "reference", "reference_label" ], "type": "object" }, "ExpressionParseOptsV2": { "example": { "returns": { "array": true, "type": "IncidentStatus" }, "source": "metadata.annotations[\"github.com/repo\"]" }, "properties": { "returns": { "$ref": "#/components/schemas/ReturnsMetaV2" }, "source": { "description": "Source expression that is evaluated to a result", "example": "metadata.annotations[\"github.com/repo\"]", "type": "string" } }, "required": [ "source", "returns" ], "type": "object" }, "EscalationPathTargetWithBindingV2": { "example": { "binding": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } }, "id": "01FCNDV6P870EA6S7TK1DSYDG0", "schedule_mode": "currently_on_call", "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "schedule", "urgency": "high" }, "properties": { "binding": { "$ref": "#/components/schemas/EngineParamBindingV2" }, "id": { "description": "Uniquely identifies a concrete target. Omitted when binding is set.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "schedule_mode": { "description": "Only set for schedule targets, this specifies which users to fetch from the schedule.", "enum": [ "currently_on_call", "all_users_for_rota", "all_users", "currently_on_call_for_rota", "next_on_call_for_rota", "next_on_call", "" ], "example": "currently_on_call", "type": "string" }, "selected_rota_id": { "description": "For schedule targets, identifies which rota on the schedule the schedule_mode applies to.", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "type": { "description": "Controls what type of entity this target identifies, such as EscalationPolicy or User", "enum": [ "schedule", "user", "slack_channel", "msteams_channel" ], "example": "schedule", "type": "string", "x-public-api-version": "v2" }, "urgency": { "description": "The urgency of this escalation path target", "enum": [ "high", "low" ], "example": "high", "type": "string" } }, "required": [ "type", "urgency" ], "type": "object" }, "ExpressionBranchPayloadV2": { "example": { "condition_groups": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "condition_groups": { "description": "When one of these condition groups are satisfied, this branch will be evaluated", "example": [ { "conditions": [ { "operation": "one_of", "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": "incident.severity" } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupPayloadV2" }, "type": "array" }, "result": { "$ref": "#/components/schemas/EngineParamBindingPayloadV2" } }, "required": [ "condition_groups", "result" ], "type": "object" }, "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" }, "ScheduleRotationHandoverV2": { "example": { "interval": 1, "interval_type": "hourly" }, "properties": { "interval": { "example": 1, "format": "int64", "type": "integer" }, "interval_type": { "description": "How often a handover occurs", "enum": [ "hourly", "daily", "weekly" ], "example": "hourly", "type": "string", "x-public-api-version": "v2" } }, "required": [ "interval_type", "interval" ], "type": "object" }, "ScheduleLayerV2": { "example": { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" }, "properties": { "id": { "description": "Unique identifier of the layer", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "name": { "description": "Name of the layer", "example": "Layer 1", "type": "string" } }, "type": "object" }, "ScheduleRotationWorkingIntervalV2": { "example": { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" }, "properties": { "end_time": { "description": "End time of the interval, in 24hr format", "example": "17:00", "type": "string" }, "start_time": { "description": "Start time of the interval, in 24hr format", "example": "09:00", "type": "string" }, "weekday": { "description": "Weekdays for use with a schedule", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "example": "monday", "type": "string", "x-public-api-version": "v2" } }, "required": [ "weekday", "start_time", "end_time" ], "type": "object" }, "ScheduleLayerCreatePayloadV2": { "example": { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" }, "properties": { "id": { "description": "Unique identifier of the layer", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "name": { "description": "Name of the layer", "example": "Layer 1", "type": "string" } }, "required": [ "name" ], "type": "object" }, "ScheduleRotationWorkingIntervalCreatePayloadV2": { "example": { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" }, "properties": { "end_time": { "description": "End time of the interval, in 24hr format", "example": "17:00", "type": "string" }, "start_time": { "description": "Start time of the interval, in 24hr format", "example": "09:00", "type": "string" }, "weekday": { "description": "Weekdays for use with a schedule", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "example": "monday", "type": "string", "x-public-api-version": "v2" } }, "required": [ "weekday", "start_time", "end_time" ], "type": "object" }, "ScheduleLayerUpdatePayloadV2": { "example": { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" }, "properties": { "id": { "description": "Unique identifier of the layer", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "name": { "description": "Name of the layer", "example": "Layer 1", "type": "string" } }, "type": "object" }, "StatusPageStructureSubPageItemV2": { "example": { "component": { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" }, "group": { "components": [ { "component_id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "App" } ], "id": "01FCNDV6P870EA6S7TK1DSYDG1", "name": "EU Data center" } }, "properties": { "component": { "$ref": "#/components/schemas/StatusPageStructureComponentV2" }, "group": { "$ref": "#/components/schemas/StatusPageStructureGroupV2" } }, "type": "object" }, "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" }, "ExpressionBranchV3": { "example": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "result": { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "condition_groups": { "description": "When one of these condition groups are satisfied, this branch will be evaluated", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "literal": "SEV123", "reference": "incident.severity" } ], "value": { "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Priority", "reference": "alert.priority" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV3" }, "type": "array" }, "result": { "$ref": "#/components/schemas/EngineParamBindingV3" } }, "required": [ "condition_groups", "result" ], "type": "object" }, "ExpressionBranchV2": { "example": { "condition_groups": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "result": { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } }, "properties": { "condition_groups": { "description": "When one of these condition groups are satisfied, this branch will be evaluated", "example": [ { "conditions": [ { "operation": { "label": "Lawrence Jones", "value": "01FCQSP07Z74QMMYPDDGQB9FTG" }, "param_bindings": [ { "array_value": [ { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } ], "value": { "label": "Lawrence Jones", "literal": "SEV123", "reference": "incident.severity" } } ], "subject": { "label": "Incident Severity", "reference": "incident.severity" } } ] } ], "items": { "$ref": "#/components/schemas/ConditionGroupV2" }, "type": "array" }, "result": { "$ref": "#/components/schemas/EngineParamBindingV2" } }, "required": [ "condition_groups", "result" ], "type": "object" } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "description": "API key from your incident.io dashboard (Settings → API keys)" } } } }