integrations

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

Overview

Name	integrations
Type	Resource
Id	pagerduty.workflow_integrations.integrations

Fields

The following fields are returned by SELECT queries:

get

The Workflow Integration requested.

Name	Datatype	Description
id	string
name	string	The name of the integration
domain_name	string	Will be pagerduty.com
package_name	string	The package that the integration is part of
application	string	The application that this integration is associated with
configuration_schema	string	The JSON schema for the configuration of the integration. This is a dynamic field and is different for every integration (opaque JSON object)
created_at	string (date-time)
created_by	object	Reference to the user who created this connection
description	string	The description of the integration
entitled	boolean	Whether or not the integration is entitled
html_url	string (url)	a URL at which the entity is uniquely displayed in the Web app
icon_svg	string	The svg string of the icon for the integration
is_deprecated	boolean	Whether or not the integration is deprecated
search_keywords	array	A list of keywords that match this integration
secrets_schema	string	The JSON schema for the secrets of the integration. This is a dynamic field and is different for every integration (opaque JSON object)
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 list of tags applied to the integration
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.

list

A paginated list of Workflow Integrations.

Name	Datatype	Description
id	string
name	string	The name of the integration
domain_name	string	Will be pagerduty.com
package_name	string	The package that the integration is part of
application	string	The application that this integration is associated with
configuration_schema	string	The JSON schema for the configuration of the integration. This is a dynamic field and is different for every integration (opaque JSON object)
created_at	string (date-time)
created_by	object	Reference to the user who created this connection
description	string	The description of the integration
entitled	boolean	Whether or not the integration is entitled
html_url	string (url)	a URL at which the entity is uniquely displayed in the Web app
icon_svg	string	The svg string of the icon for the integration
is_deprecated	boolean	Whether or not the integration is deprecated
search_keywords	array	A list of keywords that match this integration
secrets_schema	string	The JSON schema for the secrets of the integration. This is a dynamic field and is different for every integration (opaque JSON object)
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 list of tags applied to the integration
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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id		Get details about a Workflow Integration.<br /><br />Scoped OAuth requires: workflow_integrations.read<br />
list	select		limit, cursor, include_deprecated	List available Workflow Integrations.<br /><br />Scoped OAuth requires: workflow_integrations.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.
include_deprecated	boolean	Whether to include deprecated Integrations in the response.
limit	integer	The minimum of the limit parameter used in the request or the maximum request size of the API.

SELECT examples

get

Get details about a Workflow Integration.<br /><br />Scoped OAuth requires: workflow_integrations.read<br />

SELECT
id,
name,
domain_name,
package_name,
application,
configuration_schema,
created_at,
created_by,
description,
entitled,
html_url,
icon_svg,
is_deprecated,
search_keywords,
secrets_schema,
self,
summary,
tags,
type
FROM pagerduty.workflow_integrations.integrations
WHERE id = '{{ id }}' -- required
;

list

List available Workflow Integrations.<br /><br />Scoped OAuth requires: workflow_integrations.read<br />

SELECT
id,
name,
domain_name,
package_name,
application,
configuration_schema,
created_at,
created_by,
description,
entitled,
html_url,
icon_svg,
is_deprecated,
search_keywords,
secrets_schema,
self,
summary,
tags,
type
FROM pagerduty.workflow_integrations.integrations
WHERE limit = '{{ limit }}'
AND cursor = '{{ cursor }}'
AND include_deprecated = '{{ include_deprecated }}'
;