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

An Integration for this Event Orchestration.

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

list

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	select	id, integration_id		Get an Integration associated with this Event Orchestrations.<br /><br />You can use the Routing Key from this Integration to send events to PagerDuty!<br /><br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)<br /><br />Scoped OAuth requires: event_orchestrations.read<br />
list	select	id		List the Integrations associated with this Event Orchestrations.<br /><br />You can use a Routing Key from these Integrations to send events to PagerDuty!<br /><br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)<br /><br />Scoped OAuth requires: event_orchestrations.read<br />
create	insert	id, integration		Create an Integration associated with this Event Orchestration.<br /><br />You can then use the Routing Key from this new Integration to send events to PagerDuty!<br /><br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)<br /><br />Scoped OAuth requires: event_orchestrations.write<br />
update	update	id, integration_id, integration		Update an Integration associated with this Event Orchestrations.<br /><br />You can use the Routing Key from this Integration to send events to PagerDuty!<br /><br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)<br /><br />Scoped OAuth requires: event_orchestrations.write<br />
delete	delete	id, integration_id		Delete an Integration and its associated Routing Key.<br /><br />Once deleted, PagerDuty will drop all future events sent to PagerDuty using the Routing Key.<br /><br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)<br /><br />Scoped OAuth requires: event_orchestrations.write<br />
migrate	exec	id, source_id, source_type, integration_id		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.<br /><br />Any future events sent to this Integration's Routing Key will be processed by this Event Orchestration's Rules.<br /><br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)<br /><br />Scoped OAuth requires: event_orchestrations.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 an Event Orchestration.
integration_id	string	The ID of an Integration.

SELECT examples

get

Get an Integration associated with this Event Orchestrations.<br /><br />You can use the Routing Key from this Integration to send events to PagerDuty!<br /><br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)<br /><br />Scoped OAuth requires: event_orchestrations.read<br />

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

list

List the Integrations associated with this Event Orchestrations.<br /><br />You can use a Routing Key from these Integrations to send events to PagerDuty!<br /><br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)<br /><br />Scoped OAuth requires: event_orchestrations.read<br />

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

INSERT examples

create

Create an Integration associated with this Event Orchestration.<br /><br />You can then use the Routing Key from this new Integration to send events to PagerDuty!<br /><br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)<br /><br />Scoped OAuth requires: event_orchestrations.write<br />

INSERT INTO pagerduty.event_orchestrations.integrations (
integration,
id
)
SELECT 
'{{ integration }}' /* required */,
'{{ id }}'
RETURNING
integration
;

Manifest

# Description fields are for documentation purposes
- name: integrations
props:
  - name: id
    value: "{{ id }}"
    description: Required parameter for the integrations resource.
  - name: integration
    value:
      label: "{{ label }}"

UPDATE examples

update

Update an Integration associated with this Event Orchestrations.<br /><br />You can use the Routing Key from this Integration to send events to PagerDuty!<br /><br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)<br /><br />Scoped OAuth requires: event_orchestrations.write<br />

UPDATE pagerduty.event_orchestrations.integrations
SET 
integration = '{{ integration }}'
WHERE 
id = '{{ id }}' --required
AND integration_id = '{{ integration_id }}' --required
AND integration = '{{ integration }}' --required
RETURNING
integration;

DELETE examples

delete

Delete an Integration and its associated Routing Key.<br /><br />Once deleted, PagerDuty will drop all future events sent to PagerDuty using the Routing Key.<br /><br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)<br /><br />Scoped OAuth requires: event_orchestrations.write<br />

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

Lifecycle Methods

migrate

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.<br /><br />Any future events sent to this Integration's Routing Key will be processed by this Event Orchestration's Rules.<br /><br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)<br /><br />Scoped OAuth requires: event_orchestrations.write<br />

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