connections

Creates, updates, deletes, gets or lists a connections resource.

Overview

Name	connections
Type	Resource
Id	pagerduty.workflow_integrations.connections

Fields

The following fields are returned by SELECT queries:

get

The Workflow Integration Connection requested.

Name	Datatype	Description
id	string
name	string	The name given to the connection
external_id	string	The ID of the external system that this connection is used to connect to
integration_id	string	The integration ID that this connection is associated with
apps	array	The app IDs for this connection
configuration	string	The configuration for this connection (opaque JSON object)
created_at	string (date-time)	The timestamp of when the connection was created
created_by	object	Reference to the user who created this connection
external_id_label	string	The label of the external system that this connection is used to connect to
health	object
html_url	string (url)	a URL at which the entity is uniquely displayed in the Web app
is_default	boolean	Whether or not this connection is the default connection for this integration
scopes	array
secrets	string	The secrets for this connection. This will always be null on a response so that secrets are not leaked. (opaque JSON object)
self	string (url)	the API show URL at which the object is accessible
service_url	string	The URL of the service that this connection is associated with
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.
teams	array	The teams whose managers are allowed to use or edit this connection
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_by_integration

A paginated list of Workflow Integration Connections.

Name	Datatype	Description
id	string
name	string	The name given to the connection
external_id	string	The ID of the external system that this connection is used to connect to
integration_id	string	The integration ID that this connection is associated with
apps	array	The app IDs for this connection
configuration	string	The configuration for this connection (opaque JSON object)
created_at	string (date-time)	The timestamp of when the connection was created
created_by	object	Reference to the user who created this connection
external_id_label	string	The label of the external system that this connection is used to connect to
health	object
html_url	string (url)	a URL at which the entity is uniquely displayed in the Web app
is_default	boolean	Whether or not this connection is the default connection for this integration
scopes	array
secrets	string	The secrets for this connection. This will always be null on a response so that secrets are not leaked. (opaque JSON object)
self	string (url)	the API show URL at which the object is accessible
service_url	string	The URL of the service that this connection is associated with
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.
teams	array	The teams whose managers are allowed to use or edit this connection
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 Integration Connections.

Name	Datatype	Description
id	string
name	string	The name given to the connection
external_id	string	The ID of the external system that this connection is used to connect to
integration_id	string	The integration ID that this connection is associated with
apps	array	The app IDs for this connection
configuration	string	The configuration for this connection (opaque JSON object)
created_at	string (date-time)	The timestamp of when the connection was created
created_by	object	Reference to the user who created this connection
external_id_label	string	The label of the external system that this connection is used to connect to
health	object
html_url	string (url)	a URL at which the entity is uniquely displayed in the Web app
is_default	boolean	Whether or not this connection is the default connection for this integration
scopes	array
secrets	string	The secrets for this connection. This will always be null on a response so that secrets are not leaked. (opaque JSON object)
self	string (url)	the API show URL at which the object is accessible
service_url	string	The URL of the service that this connection is associated with
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.
teams	array	The teams whose managers are allowed to use or edit this connection
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	integration_id, id		Get details about a Workflow Integration Connection.<br /><br />Scoped OAuth requires: workflow_integrations:connections.read<br />
list_by_integration	select	integration_id	limit, cursor, name	List all Workflow Integration Connections for a specific Workflow Integration.<br /><br />Scoped OAuth requires: workflow_integrations:connections.read<br />
list	select		limit, cursor, name	List all Workflow Integration Connections.<br /><br />Scoped OAuth requires: workflow_integrations:connections.read<br />
create	insert	integration_id, name, secrets		Create a new Workflow Integration Connection.<br /><br />Scoped OAuth requires: workflow_integrations:connections.write<br />
update	update	integration_id, id, name, secrets		Update an existing Workflow Integration Connection.<br /><br />Scoped OAuth requires: workflow_integrations:connections.write<br />
delete	delete	integration_id, id		Delete a Workflow Integration Connection.<br /><br />Scoped OAuth requires: workflow_integrations:connections.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.
integration_id	string	The ID of the Workflow Integration
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.
limit	integer	The minimum of the limit parameter used in the request or the maximum request size of the API.
name	string	Filter Integrations by partial name.

SELECT examples

get

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

SELECT
id,
name,
external_id,
integration_id,
apps,
configuration,
created_at,
created_by,
external_id_label,
health,
html_url,
is_default,
scopes,
secrets,
self,
service_url,
summary,
teams,
type
FROM pagerduty.workflow_integrations.connections
WHERE integration_id = '{{ integration_id }}' -- required
AND id = '{{ id }}' -- required
;

list_by_integration

List all Workflow Integration Connections for a specific Workflow Integration.<br /><br />Scoped OAuth requires: workflow_integrations:connections.read<br />

SELECT
id,
name,
external_id,
integration_id,
apps,
configuration,
created_at,
created_by,
external_id_label,
health,
html_url,
is_default,
scopes,
secrets,
self,
service_url,
summary,
teams,
type
FROM pagerduty.workflow_integrations.connections
WHERE integration_id = '{{ integration_id }}' -- required
AND limit = '{{ limit }}'
AND cursor = '{{ cursor }}'
AND name = '{{ name }}'
;

list

List all Workflow Integration Connections.<br /><br />Scoped OAuth requires: workflow_integrations:connections.read<br />

SELECT
id,
name,
external_id,
integration_id,
apps,
configuration,
created_at,
created_by,
external_id_label,
health,
html_url,
is_default,
scopes,
secrets,
self,
service_url,
summary,
teams,
type
FROM pagerduty.workflow_integrations.connections
WHERE limit = '{{ limit }}'
AND cursor = '{{ cursor }}'
AND name = '{{ name }}'
;

INSERT examples

create

Create a new Workflow Integration Connection.<br /><br />Scoped OAuth requires: workflow_integrations:connections.write<br />

INSERT INTO pagerduty.workflow_integrations.connections (
name,
service_url,
external_id,
external_id_label,
scopes,
is_default,
configuration,
secrets,
teams,
apps,
integration_id
)
SELECT 
'{{ name }}' /* required */,
'{{ service_url }}',
'{{ external_id }}',
'{{ external_id_label }}',
'{{ scopes }}',
{{ is_default }},
'{{ configuration }}',
'{{ secrets }}' /* required */,
'{{ teams }}',
'{{ apps }}',
'{{ integration_id }}'
RETURNING
id,
name,
external_id,
integration_id,
apps,
configuration,
created_at,
created_by,
external_id_label,
health,
html_url,
is_default,
scopes,
secrets,
self,
service_url,
summary,
teams,
type
;

Manifest

# Description fields are for documentation purposes
- name: connections
props:
  - name: integration_id
    value: "{{ integration_id }}"
    description: Required parameter for the connections resource.
  - name: name
    value: "{{ name }}"
    description: |
      The name given to the connection
  - name: service_url
    value: "{{ service_url }}"
    description: |
      The URL of the service that this connection is associated with
  - name: external_id
    value: "{{ external_id }}"
    description: |
      The ID of the external system that this connection is used to connect to
  - name: external_id_label
    value: "{{ external_id_label }}"
    description: |
      The label of the external system that this connection is used to connect to
  - name: scopes
    value:
      - "{{ scopes }}"
  - name: is_default
    value: {{ is_default }}
    description: |
      Whether or not this connection is the default connection for this integration
  - name: configuration
    value: "{{ configuration }}"
    description: |
      The configuration for this connection.
      The configuration schema is defined in the Workflow Integration's `configuration_schema` property.
      It is dynamic based on the specific Workflow Integration.
      (opaque JSON object)
  - name: secrets
    value: "{{ secrets }}"
    description: |
      The secrets for this connection.
      The secrets schema is defined in the Workflow Integration's `secrets_schema` property.
      It is dynamic based on the specific Workflow Integration.
      This field is write-only and will always be `null` on a response so that secrets are not leaked.
      (opaque JSON object)
  - name: teams
    description: |
      The teams whose managers are allowed to use or edit this connection
    value:
      - team_id: "{{ team_id }}"
        type: "{{ type }}"
  - name: apps
    description: |
      The app IDs for this connection
    value:
      - app_id: "{{ app_id }}"
        type: "{{ type }}"

UPDATE examples

update

Update an existing Workflow Integration Connection.<br /><br />Scoped OAuth requires: workflow_integrations:connections.write<br />

UPDATE pagerduty.workflow_integrations.connections
SET 
name = '{{ name }}',
service_url = '{{ service_url }}',
external_id = '{{ external_id }}',
external_id_label = '{{ external_id_label }}',
scopes = '{{ scopes }}',
is_default = {{ is_default }},
configuration = '{{ configuration }}',
secrets = '{{ secrets }}',
teams = '{{ teams }}',
apps = '{{ apps }}'
WHERE 
integration_id = '{{ integration_id }}' --required
AND id = '{{ id }}' --required
AND name = '{{ name }}' --required
AND secrets = '{{ secrets }}' --required
RETURNING
id,
name,
external_id,
integration_id,
apps,
configuration,
created_at,
created_by,
external_id_label,
health,
html_url,
is_default,
scopes,
secrets,
self,
service_url,
summary,
teams,
type;

DELETE examples

delete

Delete a Workflow Integration Connection.<br /><br />Scoped OAuth requires: workflow_integrations:connections.write<br />

DELETE FROM pagerduty.workflow_integrations.connections
WHERE integration_id = '{{ integration_id }}' --required
AND id = '{{ id }}' --required
;