integrations

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

Overview

Name	integrations
Type	Resource
Id	pagerduty.event_orchestrations.integrations

Fields

The following fields are returned by SELECT queries:

get_orchestration_integration

An Integration for this Event Orchestration.

Name	Datatype	Description
id	string	ID of the Integration.
label	string	Name of the Integration.
parameters	object

list_orchestration_integrations

The Integrations for this Event Orchestration.

Name	Datatype	Description
id	string	ID of the Integration.
label	string	Name of the Integration.
parameters	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_orchestration_integration	select	id, integration_id	Accept, Content-Type	Get an Integration associated with this Event Orchestrations. You can use the Routing Key from this Integration to send events to PagerDuty! For more information see the API Concepts Document Scoped OAuth requires: event_orchestrations.read
list_orchestration_integrations	select	id	Accept, Content-Type	List the Integrations associated with this Event Orchestrations. You can use a Routing Key from these Integrations to send events to PagerDuty! For more information see the API Concepts Document Scoped OAuth requires: event_orchestrations.read
delete_orchestration_integration	delete	id, integration_id	Accept, Content-Type	Delete an Integration and its associated Routing Key. Once deleted, PagerDuty will drop all future events sent to PagerDuty using the Routing Key. For more information see the API Concepts Document Scoped OAuth requires: event_orchestrations.write
_list_orchestration_integrations	exec	id	Accept, Content-Type	List the Integrations associated with this Event Orchestrations. You can use a Routing Key from these Integrations to send events to PagerDuty! For more information see the API Concepts Document Scoped OAuth requires: event_orchestrations.read
post_orchestration_integration	exec	id, integration	Accept, Content-Type	Create an Integration associated with this Event Orchestration. You can then use the Routing Key from this new Integration to send events to PagerDuty! For more information see the API Concepts Document Scoped OAuth requires: event_orchestrations.write
_get_orchestration_integration	exec	id, integration_id	Accept, Content-Type	Get an Integration associated with this Event Orchestrations. You can use the Routing Key from this Integration to send events to PagerDuty! For more information see the API Concepts Document Scoped OAuth requires: event_orchestrations.read
update_orchestration_integration	exec	id, integration_id, integration	Accept, Content-Type	Update an Integration associated with this Event Orchestrations. You can use the Routing Key from this Integration to send events to PagerDuty! For more information see the API Concepts Document Scoped OAuth requires: event_orchestrations.write
migrate_orchestration_integration	exec	id, source_id, source_type, integration_id	Accept, Content-Type	Move an Integration and its Routing Key from the Event Orchestration specified in the request payload, to the Event Orchestration specified in the request URL. Any future events sent to this Integration's Routing Key will be processed by this Event Orchestration's Rules. For more information see the API Concepts Document Scoped OAuth requires: event_orchestrations.write

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 an Event Orchestration.
integration_id	string	The ID of an Integration.
Accept	string	The Accept header is used as a versioning header.
Content-Type	string

SELECT examples

get_orchestration_integration

Get an Integration associated with this Event Orchestrations.

You can use the Routing Key from this Integration to send events to PagerDuty!

For more information see the API Concepts Document

Scoped OAuth requires: event_orchestrations.read

SELECT
id,
label,
parameters
FROM pagerduty.event_orchestrations.integrations
WHERE id = '{{ id }}' -- required
AND integration_id = '{{ integration_id }}' -- required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
;

list_orchestration_integrations

List the Integrations associated with this Event Orchestrations.

You can use a Routing Key from these Integrations to send events to PagerDuty!

For more information see the API Concepts Document

Scoped OAuth requires: event_orchestrations.read

SELECT
id,
label,
parameters
FROM pagerduty.event_orchestrations.integrations
WHERE id = '{{ id }}' -- required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
;

DELETE examples

delete_orchestration_integration

Delete an Integration and its associated Routing Key.

Once deleted, PagerDuty will drop all future events sent to PagerDuty using the Routing Key.

For more information see the API Concepts Document

Scoped OAuth requires: event_orchestrations.write

DELETE FROM pagerduty.event_orchestrations.integrations
WHERE id = '{{ id }}' --required
AND integration_id = '{{ integration_id }}' --required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
;

Lifecycle Methods

_list_orchestration_integrations

List the Integrations associated with this Event Orchestrations.

You can use a Routing Key from these Integrations to send events to PagerDuty!

For more information see the API Concepts Document

Scoped OAuth requires: event_orchestrations.read

EXEC pagerduty.event_orchestrations.integrations._list_orchestration_integrations 
@id='{{ id }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}'
;

post_orchestration_integration

Create an Integration associated with this Event Orchestration.

You can then use the Routing Key from this new Integration to send events to PagerDuty!

For more information see the API Concepts Document

Scoped OAuth requires: event_orchestrations.write

EXEC pagerduty.event_orchestrations.integrations.post_orchestration_integration 
@id='{{ id }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}' 
@@json=
'{
"integration": "{{ integration }}"
}'
;

_get_orchestration_integration

Get an Integration associated with this Event Orchestrations.

You can use the Routing Key from this Integration to send events to PagerDuty!

For more information see the API Concepts Document

Scoped OAuth requires: event_orchestrations.read

EXEC pagerduty.event_orchestrations.integrations._get_orchestration_integration 
@id='{{ id }}' --required, 
@integration_id='{{ integration_id }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}'
;

update_orchestration_integration

Update an Integration associated with this Event Orchestrations.

You can use the Routing Key from this Integration to send events to PagerDuty!

For more information see the API Concepts Document

Scoped OAuth requires: event_orchestrations.write

EXEC pagerduty.event_orchestrations.integrations.update_orchestration_integration 
@id='{{ id }}' --required, 
@integration_id='{{ integration_id }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}' 
@@json=
'{
"integration": "{{ integration }}"
}'
;

migrate_orchestration_integration

Move an Integration and its Routing Key from the Event Orchestration specified in the request payload, to the Event Orchestration specified in the request URL.

Any future events sent to this Integration's Routing Key will be processed by this Event Orchestration's Rules.

For more information see the API Concepts Document

Scoped OAuth requires: event_orchestrations.write

EXEC pagerduty.event_orchestrations.integrations.migrate_orchestration_integration 
@id='{{ id }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}' 
@@json=
'{
"source_id": "{{ source_id }}", 
"source_type": "{{ source_type }}", 
"integration_id": "{{ integration_id }}"
}'
;