PagerDuty connection¶
Introduction¶
A PagerDuty connection, created using the PagerDuty connector, establishes access to PagerDuty. Once a connection is configured, you can create instances of PagerDuty activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).
Create or edit a PagerDuty connection¶
A new PagerDuty connection is created using the PagerDuty connector from one of these locations:
- The design component palette's Project endpoints and connectors tab (see Design component palette).
- The Global Connections page (see Create a global endpoint in Global Connections).
An existing PagerDuty connection can be edited from these locations:
- The design component palette's Project endpoints and connectors tab (see Design component palette).
- The project pane's Components tab (see Component actions menu in Project pane Components tab).
- The Global Connections page (see Edit a global endpoint in Global Connections).
Configure a PagerDuty connection¶
Each user interface element of the PagerDuty connection configuration screen is described below.
Tip
Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [
into the field or by clicking the variable icon to display a list of the existing variables to choose from.
-
Connection Name: Enter a name to use to identify the connection. The name must be unique for each PagerDuty connection and must not contain forward slashes
/
or colons:
. This name is also used to identify the PagerDuty endpoint, which refers to both a specific connection and its activities. -
API Token: Enter the PagerDuty REST API key. For information on REST API keys, see API Access Keys in the PagerDuty documentation.
-
Email: Enter the email address associated with the REST API key.
-
Use Proxy per Endpoint: When using a private agent, this setting can be selected to use private agent proxy settings.
-
Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.
-
Save Changes: Click to save and close the connection configuration.
-
Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.
-
Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.
Next steps¶
After a PagerDuty connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).
Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.
These activity types are available:
-
Get Incident: Retrieves an incident from PagerDuty and is intended to be used as a source in an operation.
-
Create Incident: Creates an incident in PagerDuty and is intended to be used as a target in an operation.
-
Update Incident: Updates an incident in PagerDuty and is intended to be used as a target in an operation.
-
Create Note: Creates a note associated with an incident in PagerDuty and is intended to be used as a target in an operation.
-
Manage Incidents: Updates multiple incidents in PagerDuty and is intended to be used as a target in an operation.
-
List Incident: Retrieves multiple incidents from PagerDuty and is intended to be used as a source in an operation.
-
Create Status Update: Creates a status update associated with an incident in PagerDuty and is intended to be used as a target in an operation.
-
Snooze Incident: Snoozes an incident in PagerDuty and is intended to be used as a target in an operation.