Skip to main content
PUT
Update

Authorizations

Authorization
string
header
required

API key from your incident.io dashboard (Settings → API keys)

Path Parameters

id
string
required

ID of the workflow to update

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

Body

application/json
condition_groups
object[]
required

Conditions that apply to the workflow trigger

Example:
continue_on_step_error
boolean
required

Whether to continue executing the workflow if a step fails

Example:

true

expressions
object[]
required

The expressions to use in the workflow

Example:
name
string
required

Name provided by the user when creating the workflow

Example:

"My little workflow"

once_for
string[]
required

This workflow will run 'once for' a list of references

Example:
runs_on_incident_modes
enum<string>[]
required

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.

Available options:
standard,
test,
retrospective
Example:
runs_on_incidents
enum<string>
required

Which incidents should the workflow be applied to?

Available options:
newly_created,
newly_created_and_active
Example:

"newly_created"

steps
object[]
required

Steps that are executed as part of the workflow

Example:
annotations
object

Annotations that track metadata about this resource

Example:
delay
object
Example:
folder
string

Folder to display the workflow in

Example:

"My folder 01"

form_fields
object[]

User-configured form fields available in the workflow scope (manual triggers only)

Example:
include_private_escalations
boolean

Whether to include private escalations

Example:

true

include_private_incidents
boolean

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

owning_team_ids
string[]

IDs of the teams that own this workflow

Example:
private_incident_scope
enum<string>

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"

shortform
string

The shortform used to trigger this workflow (only applicable for manual triggers)

Example:

"page-the-ceo"

skip_step_upgrades
boolean

Skips workflow step upgrades, when the parameters for an existing workflow step change

Example:

false

state
enum<string>

What state this workflow is in

Available options:
active,
disabled,
draft,
error
Example:

"active"

Response

200 - application/json

OK response.

management_meta
object
required
Example:
workflow
object
required