actions

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

Overview

Name	actions
Type	Resource
Id	pagerduty.incident_workflows.actions

Fields

The following fields are returned by SELECT queries:

get

An Incident Workflow Action

Name	Datatype	Description
id	string
name	string	The descriptive name of the Action
created_by_user_id	string	The obfuscated Id of the User who created this Action
domain_name	string	The Verified Domain of the account that created the action
function_name	string	The Function Name describing the specific functionality of the Action
package_name	string	The Package Name corresponding to the broad category of the Action
action_tier	string	The tier of the Action (basic-action, standard-action, premium-action)
action_type	string	The type of Action (action, trigger)
created_at	string (date-time)	The date-time at which this Action was created
description	string	A description of the Action
html_url	string (url)	a URL at which the entity is uniquely displayed in the Web app
inputs	array	Inputs whose values used during Action execution
metadata	string	JSON-formatted string of metadata pertaining to the Action
outputs	array	Outputs whose values set during Action execution
search_keywords	array	A set of search keywords to apply to this action.
self	string (url)	the API show URL at which the object is accessible
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.
tags	array	A set of tags to apply to this action.
trigger_type	string	The type of Trigger this Action is, if action_type is trigger (polling, subscription, web)
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.
version	number	The version of the Action

list

A paginated array of Incident Workflow Actions

Name	Datatype	Description
id	string
name	string	The descriptive name of the Action
created_by_user_id	string	The obfuscated Id of the User who created this Action
domain_name	string	The Verified Domain of the account that created the action
function_name	string	The Function Name describing the specific functionality of the Action
package_name	string	The Package Name corresponding to the broad category of the Action
action_tier	string	The tier of the Action (basic-action, standard-action, premium-action)
action_type	string	The type of Action (action, trigger)
created_at	string (date-time)	The date-time at which this Action was created
description	string	A description of the Action
html_url	string (url)	a URL at which the entity is uniquely displayed in the Web app
inputs	array	Inputs whose values used during Action execution
metadata	string	JSON-formatted string of metadata pertaining to the Action
outputs	array	Outputs whose values set during Action execution
search_keywords	array	A set of search keywords to apply to this action.
self	string (url)	the API show URL at which the object is accessible
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.
tags	array	A set of tags to apply to this action.
trigger_type	string	The type of Trigger this Action is, if action_type is trigger (polling, subscription, web)
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.
version	number	The version of the Action

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id		Get an Incident Workflow Action<br /><br />Scoped OAuth requires: incident_workflows.read<br />
list	select		limit, cursor, keyword	List Incident Workflow Actions<br /><br />Scoped OAuth requires: incident_workflows.read<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.
cursor	string	Optional parameter used to request the "next" set of results from an API. The value provided here is most commonly obtained from the next_cursor field of the previous request. When no value is provided, the request starts at the beginning of the result set.
keyword	string	If provided, only show actions tagged with the specified keyword
limit	integer	The minimum of the limit parameter used in the request or the maximum request size of the API.

SELECT examples

get

Get an Incident Workflow Action<br /><br />Scoped OAuth requires: incident_workflows.read<br />

SELECT
id,
name,
created_by_user_id,
domain_name,
function_name,
package_name,
action_tier,
action_type,
created_at,
description,
html_url,
inputs,
metadata,
outputs,
search_keywords,
self,
summary,
tags,
trigger_type,
type,
version
FROM pagerduty.incident_workflows.actions
WHERE id = '{{ id }}' -- required
;

list

List Incident Workflow Actions<br /><br />Scoped OAuth requires: incident_workflows.read<br />

SELECT
id,
name,
created_by_user_id,
domain_name,
function_name,
package_name,
action_tier,
action_type,
created_at,
description,
html_url,
inputs,
metadata,
outputs,
search_keywords,
self,
summary,
tags,
trigger_type,
type,
version
FROM pagerduty.incident_workflows.actions
WHERE limit = '{{ limit }}'
AND cursor = '{{ cursor }}'
AND keyword = '{{ keyword }}'
;