PagerDuty Connections

PagerDuty connections let agents call the PagerDuty REST API to look up incidents, services, on-call schedules, and escalation policies. Authentication uses a PagerDuty API token.

Recommended: Create and manage connections via the web UI at https://ui.cloud.firetiger.com/settings/connections

Setup

  1. Sign in to PagerDuty as an admin or account owner
  2. Navigate to Integrations → API Access Keys (or open https://app.pagerduty.com/api_keys)
  3. Click Create New API Key
  4. Choose Read-only unless an agent must create or acknowledge incidents
  5. Copy the generated token

Connection Parameters

Parameter Type Description
api_token string PagerDuty API token — sent as Authorization: Token token=<token>

Example Connection

{
  "display_name": "Production PagerDuty",
  "description": "Production PagerDuty account — used for incident lookup and on-call routing",
  "connection_details": {
    "pagerduty": {
      "api_token": "<token>"
    }
  }
}

Description Field

Document the services, escalation policies, and tag conventions that agents should know about:

Production PagerDuty.

Common queries:
- Active incidents → GET /incidents?statuses[]=triggered&statuses[]=acknowledged
- On-call for a schedule → GET /oncalls?schedule_ids[]=PXXXXXX
- Service by name → GET /services?query=<service-name>

Conventions:
- Incident urgency=high → page on-call
- Incident urgency=low → email-only, no page

Best Practices

  • Prefer read-only API keys for agents that only need to look up incidents and on-call info
  • Use a service-account user, not a personal user, so the API key survives personnel changes
  • Rotate tokens periodically — PagerDuty supports multiple keys, so you can issue a new one before revoking the old

This site uses Just the Docs, a documentation theme for Jekyll.