Skip to main content

PagerDuty

PagerDuty is an incident response and on-call management platform for alerting, escalation, and reliability. Its REST API exposes account resources such as incidents, escalation policies, add-ons, alert grouping settings, automation actions, and analytics. Nexla connects to the PagerDuty REST API to ingest these resources into Nexsets and to push changes back to your PagerDuty account.

PagerDuty icon

Power end-to-end data operations for your PagerDuty API with Nexla. Our bi-directional PagerDuty connector is purpose-built for PagerDuty, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to PagerDuty or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your PagerDuty workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a PagerDuty credential, you need a PagerDuty REST API key. PagerDuty authenticates REST API requests with an API token that is sent in the Authorization header using the format Token token=<your_api_key>. PagerDuty supports two kinds of REST API keys:

  • General access REST API keys are account-wide and can perform full CRUD operations, or be scoped to read-only access. Only an Account Owner or Admin can create them.
  • User token REST API keys are tied to an individual user account and are limited by that user's role and permissions. Any user can create one.

To create a general access REST API key:

  1. Sign in to your PagerDuty account with an Account Owner or Admin role.

  2. Navigate to Integrations > Developer Tools > API Access Keys.

  3. Click Create New API Key.

  4. Enter a description for the key. Optionally, select Read-only API Key to restrict the key to GET requests.

  5. Click Create Key.

  6. Copy the generated key immediately and store it in a secure location. PagerDuty displays the key in full only once at creation time.

To create a user token REST API key instead, go to your User Icon > My Profile > User Settings, and under API Access click Create API User Token.

For more details, see the PagerDuty API Access Keys documentation and the PagerDuty REST API reference.

Authenticate

Credentials required

FieldRequiredSecretDescription
API Key ValueYesYesAn encoded string value used as a secret token to authenticate API requests

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your PagerDuty REST API key in the API Key Value field. This is the key you generated in Prerequisites. Nexla sends this token in the Authorization header for all API requests to PagerDuty and keeps it confidential.

    If your API key is compromised, disable or delete it in PagerDuty under Integrations > Developer Tools > API Access Keys (or in your user settings for a user token) and generate a new one.

    For detailed information about authentication and available endpoints, see the PagerDuty REST API reference.

  4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the PagerDuty connector tile, then select the credential that will be used to connect to PagerDuty, and click Next; or, create a new PagerDuty credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common PagerDuty endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] Get tags for entities

This endpoint template retrieves the tags associated with a given entity (such as a user, team, or escalation policy) in your PagerDuty account.

For detailed information about this endpoint, request parameters, and response structure, see the PagerDuty REST API reference.

[Rest API] List abilities

This endpoint template retrieves the set of abilities that your PagerDuty account is entitled to use, based on your plan and features.

For detailed information about this endpoint, request parameters, and response structure, see the PagerDuty REST API reference.

[Rest API] Test an ability

This endpoint template checks whether your PagerDuty account has a specific named ability, returning whether that ability is available.

For detailed information about this endpoint, request parameters, and response structure, see the PagerDuty REST API reference.

[Rest API] List installed Add-ons

This endpoint template retrieves the list of Add-ons installed in your PagerDuty account.

For detailed information about this endpoint, request parameters, and response structure, see the PagerDuty REST API reference.

[Rest API] Get an Add-on

This endpoint template retrieves the details of a single installed Add-on by its ID.

For detailed information about this endpoint, request parameters, and response structure, see the PagerDuty REST API reference.

[Rest API] List alert grouping settings

This endpoint template retrieves the list of alert grouping settings configured in your PagerDuty account.

For detailed information about this endpoint, request parameters, and response structure, see the PagerDuty REST API reference.

[Rest API] Get an Alert Grouping Setting

This endpoint template retrieves the details of a single alert grouping setting by its ID.

For detailed information about this endpoint, request parameters, and response structure, see the PagerDuty REST API reference.

[Rest API] Get aggregated incident data

This endpoint template retrieves aggregated analytics metrics for incidents across your PagerDuty account, such as counts and response-time statistics.

For detailed information about this endpoint, request parameters, and response structure, see the PagerDuty REST API reference.

[Rest API] Get aggregated escalation policy data

This endpoint template retrieves aggregated incident analytics metrics scoped to a specific escalation policy.

For detailed information about this endpoint, request parameters, and response structure, see the PagerDuty REST API reference.

[Rest API] Get aggregated metrics for all escalation policies

This endpoint template retrieves aggregated incident analytics metrics broken down across all escalation policies in your PagerDuty account.

For detailed information about this endpoint, request parameters, and response structure, see the PagerDuty REST API reference.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

PagerDuty data sources can also be manually configured to ingest data from any valid PagerDuty REST API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new PagerDuty data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the PagerDuty destination, and select the Send to Destination option from the menu. Select the PagerDuty connector from the list of available destination connectors, then select the credential that will be used to connect to PagerDuty, and click Next; or, create a new PagerDuty credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common PagerDuty endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Assign tags

This endpoint template assigns or removes tags on an entity (such as a user, team, or escalation policy) using records from a Nexset.

For detailed information about this endpoint, request body format, and available properties, see the PagerDuty REST API reference.

[Rest API] Install an Add-on

This endpoint template installs a new Add-on in your PagerDuty account using records from a Nexset.

For detailed information about this endpoint, request body format, and available properties, see the PagerDuty REST API reference.

[Rest API] Update an Add-on

This endpoint template updates an existing Add-on in your PagerDuty account using records from a Nexset.

For detailed information about this endpoint, request body format, and available properties, see the PagerDuty REST API reference.

[Rest API] Delete an Add-on

This endpoint template removes an installed Add-on from your PagerDuty account, using the Add-on ID supplied in records from a Nexset.

For detailed information about this endpoint, request body format, and available properties, see the PagerDuty REST API reference.

[Rest API] Create an Alert Grouping Setting

This endpoint template creates a new alert grouping setting in your PagerDuty account using records from a Nexset.

For detailed information about this endpoint, request body format, and available properties, see the PagerDuty REST API reference.

[Rest API] Update an Alert Grouping Setting

This endpoint template updates an existing alert grouping setting in your PagerDuty account using records from a Nexset.

For detailed information about this endpoint, request body format, and available properties, see the PagerDuty REST API reference.

[Rest API] Delete an Alert Grouping Setting

This endpoint template removes an alert grouping setting from your PagerDuty account, using the setting ID supplied in records from a Nexset.

For detailed information about this endpoint, request body format, and available properties, see the PagerDuty REST API reference.

[Rest API] Create an Automation Action

This endpoint template creates a new automation action in your PagerDuty account using records from a Nexset.

For detailed information about this endpoint, request body format, and available properties, see the PagerDuty REST API reference.

[Rest API] Update an Automation Action

This endpoint template updates an existing automation action in your PagerDuty account using records from a Nexset.

For detailed information about this endpoint, request body format, and available properties, see the PagerDuty REST API reference.

[Rest API] Delete an Automation Action

This endpoint template removes an automation action from your PagerDuty account, using the action ID supplied in records from a Nexset.

For detailed information about this endpoint, request body format, and available properties, see the PagerDuty REST API reference.

Manual configuration

PagerDuty destinations can also be manually configured to send data to any valid PagerDuty REST API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

PagerDuty REST APIs expect JSON format for most operations. For update operations, include the ID of the object to be updated in the request URL.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured PagerDuty endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the PagerDuty endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.