incident_workflows

Overview

Name	incident_workflows
Type	Resource
Id	pagerduty.incident_workflows.incident_workflows

Fields

Name	Datatype	Description
id	string
name	string	A descriptive name for the Incident Workflow
description	string	A description of what the Incident Workflow does
_type	string
created_at	string	The timestamp this Incident Workflow was created
html_url	string	a URL at which the entity is uniquely displayed in the Web app
self	string	the API show URL at which the object is accessible
steps	array	The ordered list of steps that execute sequentially as part of the workflow
summary	string	A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to name, though it is not intended to be an identifier.
team	object	If specified then workflow edit permissions will be scoped to members of this team
type	string	A string that determines the schema of the object. This must be the standard name for the entity, suffixed by _reference if the object is a reference.

Methods

Name	Accessible by	Required Params	Description
get_incident_workflow	SELECT	id	Get an existing 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.read
list_incident_workflows	SELECT		List existing Incident Workflows. This is the best method to use to list all Incident Workflows in your account. If your use case requires listing Incident Workflows associated with a particular Service, you can use the "listIncidentWorkflowsByService" endpoint. 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.read
create_incident_workflow_instance	INSERT	id, data__incident_workflow_instance	Start an Instance of an 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:instances.write
delete_incident_workflow	DELETE	id	Delete an existing 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
_get_incident_workflow	EXEC	id	Get an existing 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.read
_list_incident_workflows	EXEC		List existing Incident Workflows. This is the best method to use to list all Incident Workflows in your account. If your use case requires listing Incident Workflows associated with a particular Service, you can use the "listIncidentWorkflowsByService" endpoint. 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.read
post_incident_workflow	EXEC	data__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
put_incident_workflow	EXEC	id, data__incident_workflow	Update an 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