Skip to content

PagerDuty integration

Connecting PagerDuty lets DXDT read your incidents and their timelines, services, on-call users and incident alerts for incident-response context. The integration is used read-only.

Setup time ~5 minutes
Difficulty Easy

Access required: Account owner or admin, to create a read-only REST API key

Prerequisites

  • A PagerDuty account on a plan that includes API access
  • Admin rights to create a General Access REST API key

Setup

1. Open the API access settings

In PagerDuty, go to Integrations > API Access Keys (on some accounts: Automation > API Access or Integrations > Developer Tools > API Access Keys).

Note

Use a General Access REST API key, not a user-specific token, so it is not tied to one person's session.

2. Create a read-only API key

Click Create New API Key, give it a description like DXDT read-only, and check the Read-only API Key option before saving.

Note

Always tick Read-only — DXDT only needs to read incidents, services and on-calls, and a read-only key removes any ability to modify PagerDuty.

3. Copy the key and record the owner email

Copy the generated key immediately (it is shown only once) — this is your api_token. Also note the email address of the PagerDuty user DXDT should present as the requesting user; this is used for user-context on API calls.

  • The token is sent as Authorization: Token token=<API_TOKEN>.
  • The From user email must be a valid user in your PagerDuty account.

Configuration fields

Field Where to find it
REST API Token (api_token) The Read-only API Key from Integrations > API Access Keys. Sent as Token token=<value>.
Requesting User Email (user_email) The email of a valid PagerDuty user, supplied as the From context on API calls.

Verify the connection

Enter the API token and user email in the PagerDuty plugin's Configuration tab and click Install & Configure; the Live Status panel should show a healthy connection validated against the PagerDuty API.

Security

Your PagerDuty API token and requesting-user email are stored encrypted per-tenant and are used only for read-only PagerDuty API operations.

Troubleshooting

401 Unauthorized

The API token is invalid or was deleted. Recreate a Read-only API key and re-save the configuration.

400 / user-related error

The user_email is missing or is not a real user in the account. Enter the email of an existing PagerDuty user.

402 or feature-not-available

The account plan does not include REST API access. Upgrade to a plan with API access or contact your PagerDuty admin.


Vendor documentation: https://support.pagerduty.com/main/docs/api-access-keys