# Workflows (*workflows*) ## Overview ### Available Operations * [list](#list) - ListWorkflows Workflows V2 * [create](#create) - CreateWorkflow Workflows V2 * [delete](#delete) - DestroyWorkflow Workflows V2 * [get](#get) - ShowWorkflow Workflows V2 * [update](#update) - UpdateWorkflow Workflows V2 ## list List all workflows ### Example Usage ```typescript import { Incidentio } from "incidentio"; const incidentio = new Incidentio(); async function run() { const result = await incidentio.workflows.list(); // Handle the result console.log(result) } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { IncidentioCore } from "incidentio/core.js"; import { workflowsList } from "incidentio/funcs/workflowsList.js"; // Use `IncidentioCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const incidentio = new IncidentioCore(); async function run() { const res = await workflowsList(incidentio); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result) } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[components.ListWorkflowsResponseBody](../../models/components/listworkflowsresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## create Create a new workflow ### Example Usage ```typescript import { Incidentio } from "incidentio"; const incidentio = new Incidentio(); async function run() { const result = await incidentio.workflows.create({ annotations: { "incident.io/terraform/version": "3.0.0", }, conditionGroups: [ { conditions: [ { operation: "one_of", paramBindings: [ { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, ], subject: "incident.severity", }, ], }, ], continueOnStepError: true, delay: { conditionsApplyOverDelay: false, forSeconds: 60, }, expressions: [ { elseBranch: { result: { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, }, label: "Team Slack channel", operations: [ { branches: { branches: [ { conditionGroups: [ { conditions: [ { operation: "one_of", paramBindings: [ { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, ], subject: "incident.severity", }, ], }, ], result: { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, }, ], returns: { array: true, type: "IncidentStatus", }, }, filter: { conditionGroups: [ { conditions: [ { operation: "one_of", paramBindings: [ { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, ], subject: "incident.severity", }, ], }, ], }, navigate: { reference: "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]", }, operationType: "navigate", parse: { returns: { array: true, type: "IncidentStatus", }, source: "metadata.annotations[\"github.com/repo\"]", }, }, ], reference: "abc123", rootReference: "incident.status", }, ], folder: "My folder 01", includePrivateIncidents: true, name: "My workflow", onceFor: [ "incident.url", ], runsOnIncidentModes: [ "standard", "retrospective", ], runsOnIncidents: "newly_created", state: "active", steps: [ { forEach: "abc123", id: "abc123", name: "pagerduty.escalate", paramBindings: [ { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, ], }, ], trigger: "incident.updated", }); // Handle the result console.log(result) } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { IncidentioCore } from "incidentio/core.js"; import { workflowsCreate } from "incidentio/funcs/workflowsCreate.js"; // Use `IncidentioCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const incidentio = new IncidentioCore(); async function run() { const res = await workflowsCreate(incidentio, { annotations: { "incident.io/terraform/version": "3.0.0", }, conditionGroups: [ { conditions: [ { operation: "one_of", paramBindings: [ { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, ], subject: "incident.severity", }, ], }, ], continueOnStepError: true, delay: { conditionsApplyOverDelay: false, forSeconds: 60, }, expressions: [ { elseBranch: { result: { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, }, label: "Team Slack channel", operations: [ { branches: { branches: [ { conditionGroups: [ { conditions: [ { operation: "one_of", paramBindings: [ { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, ], subject: "incident.severity", }, ], }, ], result: { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, }, ], returns: { array: true, type: "IncidentStatus", }, }, filter: { conditionGroups: [ { conditions: [ { operation: "one_of", paramBindings: [ { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, ], subject: "incident.severity", }, ], }, ], }, navigate: { reference: "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]", }, operationType: "navigate", parse: { returns: { array: true, type: "IncidentStatus", }, source: "metadata.annotations[\"github.com/repo\"]", }, }, ], reference: "abc123", rootReference: "incident.status", }, ], folder: "My folder 01", includePrivateIncidents: true, name: "My workflow", onceFor: [ "incident.url", ], runsOnIncidentModes: [ "standard", "retrospective", ], runsOnIncidents: "newly_created", state: "active", steps: [ { forEach: "abc123", id: "abc123", name: "pagerduty.escalate", paramBindings: [ { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, ], }, ], trigger: "incident.updated", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result) } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [components.CreateWorkflowRequestBody](../../models/components/createworkflowrequestbody.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[components.ShowWorkflowResponseBody](../../models/components/showworkflowresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## delete Archives a workflow ### Example Usage ```typescript import { Incidentio } from "incidentio"; const incidentio = new Incidentio(); async function run() { await incidentio.workflows.delete({ id: "01FCNDV6P870EA6S7TK1DSYDG0", }); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { IncidentioCore } from "incidentio/core.js"; import { workflowsDelete } from "incidentio/funcs/workflowsDelete.js"; // Use `IncidentioCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const incidentio = new IncidentioCore(); async function run() { const res = await workflowsDelete(incidentio, { id: "01FCNDV6P870EA6S7TK1DSYDG0", }); if (!res.ok) { throw res.error; } const { value: result } = res; } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.WorkflowsV2NumberDestroyWorkflowRequest](../../models/operations/workflowsv2numberdestroyworkflowrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## get Show a workflow by ID ### Example Usage ```typescript import { Incidentio } from "incidentio"; const incidentio = new Incidentio(); async function run() { const result = await incidentio.workflows.get({ id: "01FCNDV6P870EA6S7TK1DSYDG0", }); // Handle the result console.log(result) } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { IncidentioCore } from "incidentio/core.js"; import { workflowsGet } from "incidentio/funcs/workflowsGet.js"; // Use `IncidentioCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const incidentio = new IncidentioCore(); async function run() { const res = await workflowsGet(incidentio, { id: "01FCNDV6P870EA6S7TK1DSYDG0", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result) } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.WorkflowsV2NumberShowWorkflowRequest](../../models/operations/workflowsv2numbershowworkflowrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[components.ShowWorkflowResponseBody](../../models/components/showworkflowresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## update Updates a workflow ### Example Usage ```typescript import { Incidentio } from "incidentio"; const incidentio = new Incidentio(); async function run() { const result = await incidentio.workflows.update({ id: "01FCNDV6P870EA6S7TK1DSYDG0", updateWorkflowRequestBody: { annotations: { "incident.io/terraform/version": "3.0.0", }, conditionGroups: [ { conditions: [ { operation: "one_of", paramBindings: [ { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, ], subject: "incident.severity", }, ], }, ], continueOnStepError: true, delay: { conditionsApplyOverDelay: false, forSeconds: 60, }, expressions: [ { elseBranch: { result: { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, }, label: "Team Slack channel", operations: [ { branches: { branches: [ { conditionGroups: [ { conditions: [ { operation: "one_of", paramBindings: [ { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, ], subject: "incident.severity", }, ], }, ], result: { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, }, ], returns: { array: true, type: "IncidentStatus", }, }, filter: { conditionGroups: [ { conditions: [ { operation: "one_of", paramBindings: [ { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, ], subject: "incident.severity", }, ], }, ], }, navigate: { reference: "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]", }, operationType: "navigate", parse: { returns: { array: true, type: "IncidentStatus", }, source: "metadata.annotations[\"github.com/repo\"]", }, }, ], reference: "abc123", rootReference: "incident.status", }, ], folder: "My folder 01", includePrivateIncidents: true, name: "My workflow", onceFor: [ "incident.url", ], runsOnIncidentModes: [ "standard", "retrospective", ], runsOnIncidents: "newly_created", state: "active", steps: [ { forEach: "abc123", id: "abc123", name: "pagerduty.escalate", paramBindings: [ { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, ], }, ], }, }); // Handle the result console.log(result) } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { IncidentioCore } from "incidentio/core.js"; import { workflowsUpdate } from "incidentio/funcs/workflowsUpdate.js"; // Use `IncidentioCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const incidentio = new IncidentioCore(); async function run() { const res = await workflowsUpdate(incidentio, { id: "01FCNDV6P870EA6S7TK1DSYDG0", updateWorkflowRequestBody: { annotations: { "incident.io/terraform/version": "3.0.0", }, conditionGroups: [ { conditions: [ { operation: "one_of", paramBindings: [ { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, ], subject: "incident.severity", }, ], }, ], continueOnStepError: true, delay: { conditionsApplyOverDelay: false, forSeconds: 60, }, expressions: [ { elseBranch: { result: { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, }, label: "Team Slack channel", operations: [ { branches: { branches: [ { conditionGroups: [ { conditions: [ { operation: "one_of", paramBindings: [ { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, ], subject: "incident.severity", }, ], }, ], result: { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, }, ], returns: { array: true, type: "IncidentStatus", }, }, filter: { conditionGroups: [ { conditions: [ { operation: "one_of", paramBindings: [ { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, ], subject: "incident.severity", }, ], }, ], }, navigate: { reference: "catalog_attribute[\"01FCNDV6P870EA6S7TK1DSYD5H\"]", }, operationType: "navigate", parse: { returns: { array: true, type: "IncidentStatus", }, source: "metadata.annotations[\"github.com/repo\"]", }, }, ], reference: "abc123", rootReference: "incident.status", }, ], folder: "My folder 01", includePrivateIncidents: true, name: "My workflow", onceFor: [ "incident.url", ], runsOnIncidentModes: [ "standard", "retrospective", ], runsOnIncidents: "newly_created", state: "active", steps: [ { forEach: "abc123", id: "abc123", name: "pagerduty.escalate", paramBindings: [ { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, ], }, ], }, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result) } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.WorkflowsV2NumberUpdateWorkflowRequest](../../models/operations/workflowsv2numberupdateworkflowrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[components.ShowWorkflowResponseBody](../../models/components/showworkflowresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* |