POST /incident_workflows/{id}/instances
Start an Instance of an Incident Workflow. Sometimes referred to as "triggering a workflow on an incident."
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:instances.write
Servers
- https://api.pagerduty.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
The ID of the resource. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Accept |
String | Yes |
The Default value: "application/vnd.pagerduty+json;version=2" |
Content-Type |
String | Yes |
Possible values:
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
incident_workflow_instance |
Object | Yes | |
incident_workflow_instance.incident |
Object | No | |
incident_workflow_instance.incident.type |
String | No |
Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.