Skip to main content

event_orchestrations

Overview

Nameevent_orchestrations
TypeResource
Idpagerduty.event_orchestrations.event_orchestrations

Fields

NameDatatypeDescription
idstringID of the Orchestration.
namestringName of the Orchestration.
descriptionstringA description of this Orchestration's purpose.
created_atstringThe date the Orchestration was created at.
created_byobjectReference to the user that has created the Orchestration.
integrationsarray
routesintegerNumber of different Service Orchestration being routed to
selfstringThe API show URL at which the object is accessible
teamobjectReference to the team that owns the Orchestration. If none is specified, only admins have access.
updated_atstringThe date the Orchestration was last updated.
updated_byobjectReference to the user that has updated the Orchestration last.
versionstringVersion of the Orchestration.

Methods

NameAccessible byRequired ParamsDescription
get_orchestrationSELECTidGet a Global Event Orchestration.

Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content.

For more information see the API Concepts Document

Scoped OAuth requires: event_orchestrations.read
list_event_orchestrationsSELECTList all Global Event Orchestrations on an Account.

Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content.

For more information see the API Concepts Document

Scoped OAuth requires: event_orchestrations.read
delete_orchestrationDELETEidDelete a Global Event Orchestration.

Once deleted, you will no longer be able to ingest events into PagerDuty using this Orchestration's Routing Key.

For more information see the API Concepts Document

Scoped OAuth requires: event_orchestrations.write
_get_orchestrationEXECidGet a Global Event Orchestration.

Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content.

For more information see the API Concepts Document

Scoped OAuth requires: event_orchestrations.read
_list_event_orchestrationsEXECList all Global Event Orchestrations on an Account.

Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content.

For more information see the API Concepts Document

Scoped OAuth requires: event_orchestrations.read
post_orchestrationEXECdata__orchestrationCreate a Global Event Orchestration.

Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content.

For more information see the API Concepts Document

Scoped OAuth requires: event_orchestrations.write
update_orchestrationEXECid, data__orchestrationUpdate a Global Event Orchestration.

Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content.

For more information see the API Concepts Document

Scoped OAuth requires: event_orchestrations.write