instances

Creates, updates, deletes, gets or lists an instances resource.

Overview

Name	instances
Type	Resource
Id	pagerduty.incident_workflows.instances

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create	insert	id, incident_workflow_instance		Start an Instance of an Incident Workflow. Sometimes referred to as "triggering a workflow on an incident."<br /><br />An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.<br /><br />Scoped OAuth requires: incident_workflows:instances.write<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The ID of the resource.

INSERT examples

create

Start an Instance of an Incident Workflow. Sometimes referred to as "triggering a workflow on an incident."<br /><br />An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.<br /><br />Scoped OAuth requires: incident_workflows:instances.write<br />

INSERT INTO pagerduty.incident_workflows.instances (
incident_workflow_instance,
id
)
SELECT 
'{{ incident_workflow_instance }}' /* required */,
'{{ id }}'
RETURNING
incident_workflow_instance
;

Manifest

# Description fields are for documentation purposes
- name: instances
props:
  - name: id
    value: "{{ id }}"
    description: Required parameter for the instances resource.
  - name: incident_workflow_instance
    value:
      id: "{{ id }}"
      incident:
        id: "{{ id }}"
        type: "{{ type }}"