Create an Incident Workflow

Create a new Incident Workflow

An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.

Scoped OAuth requires: incident_workflows.write

Authorization

api_key

Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Header Parameters

Accept*string

The Accept header is used as a versioning header.

Default"application/vnd.pagerduty+json;version=2"

Content-Type*"application/json"

Default"application/json"

Value in

"application/json"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

incident_workflow*

Response Body

`application/json`

curl -X POST "https://example.com/incident_workflows" \  -H "Accept: application/vnd.pagerduty+json;version=2" \  -H "Content-Type: application/json" \  -H "Content-Type: application/json" \  -d '{    "incident_workflow": {      "name": "Example Incident Workflow",      "description": "This Incident Workflow is an example",      "steps": [        {          "name": "Send Status Update",          "action_configuration": {            "action_id": "pagerduty.com:incident-workflows:send-status-update:1",            "inputs": [              {                "name": "Message",                "value": "Example status message sent on {{current_date}}"              }            ]          }        }      ]    }  }'

{  "incident_workflow": {    "id": "PSFEVL7",    "name": "Example Incident Workflow",    "description": "This Incident Workflow is an example",    "type": "incident_workflow",    "created_at": "2022-12-13T19:55:01.171Z",    "self": "https://api.pagerduty.com/incident_workflows/PSFEVL7",    "html_url": "https://pdt-flex-actions.pagerduty.com/flex-workflows/workflows/PSFEVL7",    "steps": [      {        "id": "P4RG7YW",        "type": "step",        "name": "Send Status Update",        "description": "Posts a status update to a given incident",        "action_configuration": {          "action_id": "pagerduty.com:incident-workflows:send-status-update:1",          "description": "Posts a status update to a given incident",          "inputs": [            {              "name": "Message",              "parameter_type": "text",              "value": "Example status message sent on {{current_date}}"            }          ],          "outputs": [            {              "name": "Result",              "reference_name": "result",              "parameter_type": "text"            },            {              "name": "Result Summary",              "reference_name": "result-summary",              "parameter_type": "text"            },            {              "name": "Error",              "reference_name": "error",              "parameter_type": "text"            }          ]        }      }    ]  }}

Create an Incident Workflow

Authorization

Header Parameters

Request Body

Response Body

201application/json

400application/json

401application/json

402application/json

403application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`