Workflows
API endpoints for workflows
Manage workflows.
Workflows allow you to automate certain actions and behaviors based on specific triggers.
The workflow object
Whether the workflow is configured to run immediately or ask for confirmation in the incident channel
Available options:
run_automatically, confirm_before_running Example:
"confirm_before_running"
Conditions that apply to the workflow trigger
Show child attributes
Show child attributes
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"
}
}
]
}
]
Whether to continue executing the workflow if a step fails
Example:
true
Expressions that make variables available in the scope
Show child attributes
Show child attributes
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"
}
]
Unique identifier for the workflow
Example:
"01FCNDV6P870EA6S7TK1DSYDG0"
Whether to include private escalations
Example:
true
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
Name provided by the user when creating the workflow
Example:
"My little workflow"
This workflow will run 'once for' a list of references
Show child attributes
Show child attributes
Example:
[
{
"array": false,
"key": "incident.custom_field[\"01FCNDV6P870EA6S7TK1DSYDG0\"]",
"label": "Incident -> Affected Team",
"type": "IncidentSeverity"
}
]
Which private incidents this workflow acts on: every private incident (all), those an owning team can see (owning_teams), or none
Available options:
all, owning_teams, none Example:
"owning_teams"
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.
Incident mode that workflows can run on
Available options:
standard, test, retrospective Example:
["standard", "test", "retrospective"]
Which incidents should the workflow be applied to?
Available options:
newly_created, newly_created_and_active Example:
"newly_created"
What state this workflow is in
Available options:
active, disabled, draft, error Example:
"active"
Steps that are executed as part of the workflow
Show child attributes
Show child attributes
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"
}
}
]
}
]
Show child attributes
Show child attributes
Example:
{
"label": "Incident Updated",
"name": "incident.updated"
}
Revision of the workflow, uniquely identifying it's version
Example:
3
Show child attributes
Show child attributes
Example:
{
"conditions_apply_over_delay": false,
"for_seconds": 60
}
Folder to display the workflow in
Example:
"My folder 01"
User-configured form fields available in the workflow scope. Allowed on manually-triggered workflows, and on workflows with an auto_run_mode of confirm_before_running.
Show child attributes
Show child attributes
Example:
[
{
"array": true,
"description": "The customer affected by this incident",
"id": "01FCNDV6P870EA6S7TK1DSYDG0",
"key": "affected_customer",
"required": true,
"title": "Affected customer",
"type": "User"
}
]
IDs of the teams that own this workflow
Example:
["01G0J1EXE7AXZ2C93K61WBPYEH"]
The time from which this workflow will run on incidents
Example:
"2021-08-17T13:28:57.801578Z"
The shortform used to trigger this workflow (only applicable for manual triggers)
Example:
"page-the-ceo"
Was this page helpful?
{
"auto_run_mode": "confirm_before_running",
"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,
"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"
}
],
"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"
}
],
"private_incident_scope": "owning_teams",
"runs_on_incident_modes": [
"standard",
"test",
"retrospective"
],
"runs_on_incidents": "newly_created",
"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,
"delay": {
"conditions_apply_over_delay": false,
"for_seconds": 60
},
"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"
}
],
"owning_team_ids": [
"01G0J1EXE7AXZ2C93K61WBPYEH"
],
"runs_from": "2021-08-17T13:28:57.801578Z",
"shortform": "page-the-ceo"
}