PagerDuty Component

PagerDuty is a platform for managing on-call operations. This component supports PagerDuty REST API V2.

Component key: pagerduty ·

· Changelog ↓

Description

PagerDuty is an industry leading incident management tool.

This component allows the creation and management of Incidents, events, and more.

API Documentation

This component was built using the PagerDuty REST API.

Connections

API Key

key: pagerduty-api-key

To create a PagerDuty API Key connection, generate a REST API key from the PagerDuty account.

Prerequisites

A PagerDuty account with administrative permissions to create API access keys
Access to the PagerDuty web app

Setup Steps

Log in to PagerDuty and navigate to Integrations | API Access Keys.
Click Create New API Key.
Enter a description for the API key. Check Read-only API Key if read-only behavior is desired.
Click Create Key.
Copy the provided API Key for use in the connection configuration.

Configure the Connection

Create a connection of type API Key.
Enter the Token copied from PagerDuty. This is the API token used to authenticate requests.

Input	Notes	Example
Token	The PagerDuty API token used to authenticate requests.

OAuth 2.0

key: pagerduty-oauth

To create a PagerDuty OAuth 2.0 connection, register an app in PagerDuty to obtain a Client ID and Client Secret. For background, refer to OAuth 2.0 for PagerDuty.

Prerequisites

A PagerDuty account with permissions to register apps
Access to the PagerDuty App Registration page

Setup Steps

Log in to PagerDuty and navigate to Integrations | App Registration.
From the top menu, select Integrations.
Select App Registration from the menu to navigate to the My Apps page.
On the My Apps page, select New App. Enter a name for the app and a brief description.
Check the box next to OAuth 2.0 and/or Events Integration.
For Authorization select one of the following:
1. Scoped OAuth - New OAuth client that allows granular read or write access to PagerDuty resources like incidents, services, users, with other benefits.
  1. Use the table to select Read or Write access to each Resource the integration requires.
2. Classic User OAuth - Existing OAuth client that allows apps to act on behalf of users, with read or write to all PagerDuty resources.
  1. Assign a permission scope of Read or Read and Write.
In the Redirect URL field, enter https://oauth2.prismatic.io/callback.
Select Register App.
Copy and save the Client ID and Client Secret for use in the connection configuration.

Configure the Connection

Create a connection of type OAuth 2.0.
Enter the Scopes granted to the app. Use write for read/write access or read for read-only access to all resources (Classic User OAuth).
Enter the Client ID copied from the PagerDuty OAuth application.
Enter the Client Secret copied from the PagerDuty OAuth application.

Input	Notes	Example
Authorize URL	The OAuth 2.0 authorization URL for the PagerDuty code grant.	https://identity.pagerduty.com/oauth/authorize
Client ID	The client ID of the PagerDuty OAuth application.
Client Secret	The client secret of the PagerDuty OAuth application.
Scopes	The Classic User OAuth scope granting read or read/write access to all resources.	write
Token URL	The OAuth 2.0 token URL for the PagerDuty code grant.	https://identity.pagerduty.com/oauth/token

Triggers

Incident Webhook

Receive incident webhook notifications from PagerDuty when a selected incident event occurs. | key: incidentsTrigger

Input	Notes	Example
Connection	The PagerDuty connection to use.
Incident Events	The incident events that trigger the webhook.
Filter ID	The unique identifier of the object used as the filter.	sampleFilterId
Filter Type	The type of object used as the filter.
Webhook Description	A descriptive label used to identify the webhook.	This Is An Example Description

The Incidents Trigger receives webhook notifications from PagerDuty when incident events occur. This trigger automatically manages webhook subscriptions — the entire lifecycle is handled without manual configuration in the PagerDuty dashboard.

How It Works

When this trigger is used in a flow:

On Instance Deploy: The trigger automatically creates a V3 webhook subscription in PagerDuty pointing to the instance's unique webhook URL. The subscription is configured with the selected incident events, a filter (by account, service, or team), and a description.
On Instance Deletion: The trigger automatically removes all webhook subscriptions associated with the instance's webhook URLs from PagerDuty.

Configuration

Configure the following inputs:

Incident Events: Select which incident events the webhook subscription should monitor. Multiple events can be selected.
Webhook Description: A description for the webhook subscription created in PagerDuty.
Filter ID: The ID of the PagerDuty object (account, service, or team) used to scope the webhook subscription.
Filter Type: The type of object used as the filter — Account, Service, or Team.

Event Types

Available Incident Events (17)

Event	Description
`incident.acknowledged`	An incident is acknowledged
`incident.annotated`	A note is added to an incident
`incident.conference_bridge.updated`	An incident's conference bridge is updated
`incident.delegated`	An incident is delegated
`incident.escalated`	An incident is escalated
`incident.priority_updated`	An incident's priority is updated
`incident.reassigned`	An incident is reassigned
`incident.reopened`	An incident is reopened
`incident.resolved`	An incident is resolved
`incident.responder.added`	A responder is added to an incident
`incident.responder.replied`	A responder replies to an incident
`incident.service_updated`	An incident's service is updated
`incident.status_update_published`	A status update is published for an incident
`incident.triggered`	An incident is triggered
`incident.unacknowledged`	An incident is unacknowledged
`incident.workflow.started`	An incident workflow is started
`incident.workflow.completed`	An incident workflow is completed

Refer to the PagerDuty webhooks documentation for the complete and up-to-date list of event types.

Returned Data

Example Payload

{
  "event": {
    "id": "01DEN0M0L0OCDNR0CDEVP4SRGH",
    "event_type": "incident.triggered",
    "resource_type": "incident",
    "occurred_at": "2024-01-15T10:30:00.000Z",
    "data": {
      "id": "Q1P5SQEISWZ3K4",
      "type": "incident",
      "title": "Server is on fire",
      "status": "triggered",
      "urgency": "high",
      "service": {
        "id": "PF9KMXH",
        "type": "service_reference",
        "summary": "Production API"
      }
    }
  }
}

Example Payload for Incident Webhook⤓

Loading…

New Incidents

Fetches incidents created since the last execution on a recurring schedule. | key: pollChangesTrigger

Input	Notes	Example
Connection	The PagerDuty connection to use.
Show New Incidents	When enabled, newly created incidents will be included in the trigger output.	true

The New Incidents polling trigger fetches PagerDuty incidents created since the last execution on a recurring schedule. Unlike the webhook-based triggers, this trigger does not require any external subscription — the integration polls the PagerDuty REST API directly.

How It Works

On each scheduled execution, the trigger calls the PagerDuty REST API to retrieve incidents created since the timestamp of the previous run.
The last poll timestamp is persisted in the trigger's polling state and updated after every execution.
When no new incidents are returned, the trigger signals polledNoChanges so the flow does not execute downstream steps.

Returned Data

Example Payload

{
  "body": {
    "data": {
      "created": [
        {
          "id": "Q1P5SQEISWZ3K4",
          "type": "incident",
          "summary": "[#1234] Server is on fire",
          "status": "triggered",
          "urgency": "high",
          "created_at": "2024-01-15T10:30:00Z",
          "service": {
            "id": "PF9KMXH",
            "type": "service_reference",
            "summary": "Production API"
          }
        }
      ],
      "updated": []
    }
  }
}

Fields shown are representative. The full response object includes additional properties.

Example Payload for New Incidents⤓

Loading…

Service Webhook

Receive service webhook notifications from PagerDuty when a selected service event occurs. | key: serviceTrigger

Input	Notes	Example
Connection	The PagerDuty connection to use.
Service Events	The service events that trigger the webhook.
Filter ID	The unique identifier of the object used as the filter.	sampleFilterId
Filter Type	The type of object used as the filter.
Webhook Description	A descriptive label used to identify the webhook.	This Is An Example Description

The Service Trigger receives webhook notifications from PagerDuty when service events occur. This trigger works identically to the Incidents Trigger, automatically managing webhook subscriptions throughout the instance lifecycle.

See Incidents Trigger for complete documentation on how lifecycle management, configuration, and webhook subscriptions work.

Configuration

Configure the following inputs:

Service Events: Select which service events the webhook subscription should monitor.
Webhook Description: A description for the webhook subscription created in PagerDuty.
Filter ID: The ID of the PagerDuty object (account, service, or team) used to scope the webhook subscription.
Filter Type: The type of object used as the filter — Account, Service, or Team.

Event Types

Available Service Events (3)

Event	Description
`service.created`	A service is created
`service.deleted`	A service is deleted
`service.updated`	A service is updated

Refer to the PagerDuty webhooks documentation for the complete and up-to-date list of event types.

Example Payload for Service Webhook⤓

Loading…

Data Sources

Select Incident

Retrieve and select an incident. | key: selectIncident | type: picklist

Input	Notes	Example
Connection	The PagerDuty connection to use.

Select Service

Retrieve and select a service. | key: selectService | type: picklist

Input	Notes	Example
Connection	The PagerDuty connection to use.

Select Template

Retrieve and select a template. | key: selectTemplate | type: picklist

Input	Notes	Example
Connection	The PagerDuty connection to use.

Select User

Retrieve and select a user. | key: selectUser | type: picklist

Input	Notes	Example
Connection	The PagerDuty connection to use.

Actions

Create Incident

Create a new incident. | key: createIncident

Input Notes Example

Connection

The PagerDuty connection to use.

Incident

The JSON object body describing the incident to create.

{"incident":{"type":"incident","title":"The server is on fire.","service":{"id":"PWIXJZS","type":"service_reference"},"priority":{"id":"P53ZZH5","type":"priority_reference"},"urgency":"high","incident_key":"baf7cf21b1da41b4b0221008339ff357","body":{"type":"incident_body","details":"A disk is getting full on this machine. You should investigate what is causing the disk to fill, and ensure that there is an automated process in place for ensuring data is rotated (eg. logs should have logrotate around them). If data is expected to stay on this disk forever, you should start planning to scale up to a larger disk."},"escalation_policy":{"id":"PT20YPA","type":"escalation_policy_reference"}}}

Example Payload for Create Incident⤓

Loading…

Create Incident Note

Create a note on an incident. | key: createIncidentNote

Input	Notes	Example
Connection	The PagerDuty connection to use.
Incident ID	The unique identifier for the incident.	PT4KHLK
Note	The JSON object containing the note content to attach to the incident.	`{"note":"Firefighters are on the scene."}`

Example Payload for Create Incident Note⤓

Loading…

Create Service

Create a new service. | key: createService

Input	Notes	Example
Connection	The PagerDuty connection to use.
Service	The JSON object body describing the service to create.

Example Payload for Create Service⤓

Loading…

Create Template

Create a new template. | key: createTemplate

Input Notes Example

Connection

The PagerDuty connection to use.

Template Object

The JSON object body describing the template to create.

{
  "description": "Sample template description",
  "templated_fields": {
    "email_body": "<div> sample </div>",
    "email_subject": "Sample email Subject",
    "message": "Sample SMS message"
  },
  "name": "Sample Template",
  "template_type": "status_update"
}

Example Payload for Create Template⤓

Loading…

Create User

Create a new user. | key: createUser

Input Notes Example

Connection

The PagerDuty connection to use.

User

The JSON object body describing the user to create.

{
  "user": {
    "type": "user",
    "name": "Earline Greenholt",
    "email": "125.greenholt.earline@graham.name",
    "time_zone": "America/Lima",
    "color": "green",
    "role": "admin",
    "job_title": "Director of Engineering",
    "avatar_url": "https://secure.gravatar.com/avatar/1d1a39d4635208d5664082a6c654a73f.png?d=mm&r=PG",
    "description": "I'm the boss",
    "license": {
      "id": "PTDVERC",
      "type": "license_reference"
    }
  }
}

Example Payload for Create User⤓

Loading…

Create Webhook Subscription

Create a new webhook subscription. | key: createWebhookSubscription

Input Notes Example

Connection

The PagerDuty connection to use.

Webhook Subscription

The JSON object body describing the webhook subscription to create.

{
  "delivery_method": {
    "id": "PF9KMXH",
    "secret": null,
    "temporarily_disabled": false,
    "type": "http_delivery_method",
    "url": "https://example.com/receive_a_pagerduty_webhook",
    "custom_headers": [
      {
        "name": "your-header-name",
        "value": "-- redacted --"
      }
    ]
  },
  "description": "Sends PagerDuty v3 webhook events somewhere interesting.",
  "events": [
    "incident.acknowledged",
    "incident.annotated",
    "incident.delegated",
    "incident.escalated",
    "incident.priority_updated",
    "incident.reassigned",
    "incident.reopened",
    "incident.resolved",
    "incident.responder.added",
    "incident.responder.replied",
    "incident.triggered",
    "incident.unacknowledged"
  ],
  "filter": {
    "id": "P393ZNQ",
    "type": "service_reference"
  },
  "id": "PY1OL64",
  "type": "webhook_subscription",
  "active": true
}

Example Payload for Create Webhook Subscription⤓

Loading…

Delete All Instance Webhooks

Delete all webhook subscriptions associated with this instance. | key: deleteAllInstanceWebhooks

Input	Notes	Example
Connection	The PagerDuty connection to use.

Delete Service

Delete a service by ID. | key: deleteService

Input	Notes	Example
Connection	The PagerDuty connection to use.
Service ID	The unique identifier for the service.	PIJ90N7

Example Payload for Delete Service⤓

Loading…

Delete Template

Delete a template by ID. | key: deleteTemplate

Input	Notes	Example
Connection	The PagerDuty connection to use.
Template ID	The unique identifier for the template.	PBZUP2B

Example Payload for Delete Template⤓

Loading…

Delete User

Delete a user by ID. | key: deleteUser

Input	Notes	Example
Connection	The PagerDuty connection to use.
User ID	The unique identifier for the user.	PXPGF42

Example Payload for Delete User⤓

Loading…

Delete Webhook Subscription

Delete a webhook subscription by ID. | key: deleteWebhookSubscription

Input	Notes	Example
Connection	The PagerDuty connection to use.
Webhook ID	The unique identifier for the webhook.	sampleWebhookId

Example Payload for Delete Webhook Subscription⤓

Loading…

Enable Webhook Subscription

Enable a disabled webhook subscription. | key: enableWebhookSubscription

Input	Notes	Example
Connection	The PagerDuty connection to use.
Webhook ID	The unique identifier for the webhook.	sampleWebhookId

Example Payload for Enable Webhook Subscription⤓

Loading…

Get Change Event

Retrieve a change event by ID. | key: getChangeEvent

Input	Notes	Example
Connection	The PagerDuty connection to use.
Event ID	The unique identifier for the change event.	12

Example Payload for Get Change Event⤓

Loading…

Get Incident

Retrieve an incident by ID. | key: getIncident

Input	Notes	Example
Connection	The PagerDuty connection to use.
Incident ID	The unique identifier for the incident.	PT4KHLK
Include	The additional details to include in the response.

Example Payload for Get Incident⤓

Loading…

Get Incident Alert

Retrieve a single alert from an incident. | key: getIncidentAlert

Input	Notes	Example
Incident Alert ID	The unique identifier for the incident alert.	PT4KHLK
Connection	The PagerDuty connection to use.
Incident ID	The unique identifier for the incident.	PT4KHLK

Example Payload for Get Incident Alert⤓

Loading…

Get Service

Retrieve a service by ID. | key: getService

Input	Notes	Example
Connection	The PagerDuty connection to use.
Service ID	The unique identifier for the service.	PIJ90N7
Include	The additional details to include in the response.

Example Payload for Get Service⤓

Loading…

Get Template

Retrieve a template by ID. | key: getTemplate

Input	Notes	Example
Connection	The PagerDuty connection to use.
Template ID	The unique identifier for the template.	PBZUP2B

Example Payload for Get Template⤓

Loading…

Get User

Retrieve a user by ID. | key: getUser

Input	Notes	Example
Connection	The PagerDuty connection to use.
User ID	The unique identifier for the user.	PXPGF42
Include	The additional models to include in the response.

Example Payload for Get User⤓

Loading…

Get Webhook Subscription

Retrieve a webhook subscription by ID. | key: getWebhookSubscription

Input	Notes	Example
Connection	The PagerDuty connection to use.
Webhook ID	The unique identifier for the webhook.	sampleWebhookId

Example Payload for Get Webhook Subscription⤓

Loading…

List Change Events

List change events with optional filters. | key: listChangeEvents

Input	Notes	Example
Connection	The PagerDuty connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the first page is returned.	false
Integration IDs	The unique identifiers of the integrations to filter results by.	PEYSGVF
Limit	The maximum number of results to return per page.	10
Offset	The number of results to skip before starting to return results. Used for pagination.	18
Since	The start of the date range over which to search, as a UTC ISO 8601 datetime string.	2020-07-17T07:42:58Z
Team IDs	The unique identifiers of the teams to filter results by.	PEYSGVF
Total	When true, the total field in pagination responses is populated. By default this field is null to provide the fastest possible response times.	false
Until	The end of the date range over which to search, as a UTC ISO 8601 datetime string.	2020-07-17T07:42:58Z

Example Payload for List Change Events⤓

Loading…

List Incident Alerts

List alerts for an incident. | key: listIncidentAlerts

Input	Notes	Example
Alert Key	The de-duplication key used to prevent duplicate alerts from being created.	baf7cf21b1da41b4b0221008339ff357
Connection	The PagerDuty connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the first page is returned.	false
Incident ID	The unique identifier for the incident.	PT4KHLK
Include	The additional details to include in the response.
Limit	The maximum number of results to return per page.	10
Offset	The number of results to skip before starting to return results. Used for pagination.	18
Sort By	The field and direction used to sort results. Field options: created_at, resolved_at. Direction: asc or desc.
Statuses	The statuses to filter incidents by.
Total	When true, the total field in pagination responses is populated. By default this field is null to provide the fastest possible response times.	false

Example Payload for List Incident Alerts⤓

Loading…

List Incident Notes

List notes for an incident. | key: listIncidentNotes

Input	Notes	Example
Connection	The PagerDuty connection to use.
Incident ID	The unique identifier for the incident.	PT4KHLK

Example Payload for List Incident Notes⤓

Loading…

List Incidents

List incidents with optional filters. | key: listIncidents

Input	Notes	Example
Connection	The PagerDuty connection to use.
Date Range	When set to 'all', the since and until parameters and defaults are ignored.
Fetch All	When true, automatically fetches all pages of results. When false, only the first page is returned.	false
Incident Key	The de-duplication key used to prevent duplicate incidents from being created.	baf7cf21b1da41b4b0221008339ff357
Include	The additional details to include in the response.
Limit	The maximum number of results to return per page.	10
Offset	The number of results to skip before starting to return results. Used for pagination.	18
Service IDs	The unique identifiers of the services to filter incidents by. Only incidents associated with the listed services are returned.	PIJ90N7
Since	The start of the date range over which to search, as a UTC ISO 8601 datetime string.	2020-07-17T07:42:58Z
Sort By	The field and direction used to sort results. Field options: incident_number, created_at, resolved_at, urgency. Direction: asc or desc. Example: 'incident_number:desc'.	incident_number:desc
Statuses	The statuses to filter incidents by.
Team IDs	The unique identifiers of the teams to filter results by.	PEYSGVF
Time Zone	The TZInfo-formatted time zone in which results are rendered. Example: 'America/Los_Angeles'.	America/Los_Angeles
Total	When true, the total field in pagination responses is populated. By default this field is null to provide the fastest possible response times.	false
Until	The end of the date range over which to search, as a UTC ISO 8601 datetime string.	2020-07-17T07:42:58Z
Urgencies	The urgency levels to filter incidents by.
User IDs	The unique identifiers of the users currently assigned to the incidents to return.	PXPGF42

Example Payload for List Incidents⤓

Loading…

List Notifications

List notifications sent within a specified time range. | key: listNotifications

Input	Notes	Example
Connection	The PagerDuty connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the first page is returned.	false
Filter	The notification type to filter results by.
Include	The additional details to include in the response.
Limit	The maximum number of results to return per page.	10
Offset	The number of results to skip before starting to return results. Used for pagination.	18
Since	The start of the date range over which to search, as a UTC ISO 8601 datetime string.	2020-07-17T07:42:58Z
Time Zone	The TZInfo-formatted time zone in which results are rendered. Example: 'America/Los_Angeles'.	America/Los_Angeles
Total	When true, the total field in pagination responses is populated. By default this field is null to provide the fastest possible response times.	false
Until	The end of the date range over which to search, as a UTC ISO 8601 datetime string.	2020-07-17T07:42:58Z

Example Payload for List Notifications⤓

Loading…

List Priorities

List available incident priorities. | key: listPriorities

Input	Notes	Example
Connection	The PagerDuty connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the first page is returned.	false
Limit	The maximum number of results to return per page.	10
Offset	The number of results to skip before starting to return results. Used for pagination.	18
Total	When true, the total field in pagination responses is populated. By default this field is null to provide the fastest possible response times.	false

Example Payload for List Priorities⤓

Loading…

List Services

List services with optional filters. | key: listServices

Input	Notes	Example
Connection	The PagerDuty connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the first page is returned.	false
Include	The additional details to include in the response.
Limit	The maximum number of results to return per page.	10
Name	The name to filter results by. Only services with the specified name are returned.	My Service
Offset	The number of results to skip before starting to return results. Used for pagination.	18
Query	The search query used to filter results. Only records whose name matches the query are returned.	sampleName
Sort By	The field used to sort the results.
Team IDs	The unique identifiers of the teams to filter results by.	PEYSGVF
Time Zone	The TZInfo-formatted time zone in which results are rendered. Example: 'America/Los_Angeles'.	America/Los_Angeles
Total	When true, the total field in pagination responses is populated. By default this field is null to provide the fastest possible response times.	false

Example Payload for List Services⤓

Loading…

List Templates

List all templates with optional filters. | key: getTemplates

Input	Notes	Example
Connection	The PagerDuty connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the first page is returned.	false
Limit	The maximum number of results to return per page.	10
Offset	The number of results to skip before starting to return results. Used for pagination.	18
Query	The template name or description to search for.	Template Name 1
Sort By	The field and direction used to sort results. Field options: name, created_at. Direction: asc or desc.	created_at:asc
Template Type	The template type used to filter results.	status_update
Total	When true, the total field in pagination responses is populated. By default this field is null to provide the fastest possible response times.	false

Example Payload for List Templates⤓

Loading…

List Users

List all users with optional filters. | key: listUsers

Input	Notes	Example
Connection	The PagerDuty connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the first page is returned.	false
Include	The additional models to include in the response.
Limit	The maximum number of results to return per page.	10
Offset	The number of results to skip before starting to return results. Used for pagination.	18
Query	The search query used to filter results. Only records whose name matches the query are returned.	sampleName
Team IDs	The unique identifiers of the teams to filter results by.	PEYSGVF
Total	When true, the total field in pagination responses is populated. By default this field is null to provide the fastest possible response times.	false

Example Payload for List Users⤓

Loading…

List Webhook Subscriptions

List webhook subscriptions with optional filters. | key: listWebhookSubscriptions

Input	Notes	Example
Connection	The PagerDuty connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the first page is returned.	false
Filter ID	The unique identifier of the resource to filter results upon.	123
Filter Type	The type of resource to filter results upon.
Limit	The maximum number of results to return per page.	10
Offset	The number of results to skip before starting to return results. Used for pagination.	18
Total	When true, the total field in pagination responses is populated. By default this field is null to provide the fastest possible response times.	false

Example Payload for List Webhook Subscriptions⤓

Loading…

Manage Incident Alerts

Update multiple alerts on an incident in bulk. | key: updateIncidentAlerts

Input	Notes	Example
Alerts	The JSON array of alert objects, including the parameters to update for each alert.
Connection	The PagerDuty connection to use.
Incident ID	The unique identifier for the incident.	PT4KHLK
Limit	The maximum number of results to return per page.	10
Offset	The number of results to skip before starting to return results. Used for pagination.	18
Total	When true, the total field in pagination responses is populated. By default this field is null to provide the fastest possible response times.	false

Example Payload for Manage Incident Alerts⤓

Loading…

Manage Incidents

Acknowledge, resolve, or update multiple incidents in bulk. | key: updateIncidents

Input	Notes	Example
Connection	The PagerDuty connection to use.
Incidents	The JSON array of incidents to manage, including the parameters to update.	`[ { "id": "PT4KHLK", "type": "incident_reference", "status": "acknowledged" }, { "id": "PQMF62U", "type": "incident_reference", "priority": { "id": "P53ZZH5", "type": "priority_reference" } }, { "id": "PPVZH9X", "type": "incident_reference", "status": "resolved" }, { "id": "P8JOGX7", "type": "incident_reference", "assignments": [ { "assignee": { "id": "PXPGF42", "type": "user_reference" } } ] }, { "id": "PYJ9K7I", "type": "incident_reference", "incident_type": { "name": "major_incident" } } ]`
Limit	The maximum number of results to return per page.	10
Offset	The number of results to skip before starting to return results. Used for pagination.	18
Total	When true, the total field in pagination responses is populated. By default this field is null to provide the fastest possible response times.	false

Example Payload for Manage Incidents⤓

Loading…

Raw Request

Issue a raw HTTP request | key: rawRequest

Input	Notes	Example
Connection
Data	The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request	Enabling this flag will log out the current request.	false
File Data	File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data	The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header	A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Method	The HTTP method to use.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Timeout	The maximum time that a client will await a response to its request	2000
URL	This is the URL to call.	/sobjects/Account
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false

Render Template

Render a template for a given incident. | key: renderTemplate

Input	Notes	Example
Connection	The PagerDuty connection to use.
Template ID	The unique identifier for the template.	PBZUP2B
Incident ID	The unique identifier for the incident.	PT4KHLK
Update Message	An optional status update message sent along with the rendered template.	Status update message

Example Payload for Render Template⤓

Loading…

Send Change Event

Send a change event to the Events API. | key: sendChangeEvent

Input Notes Example

Input	Notes	Example
Change Event To Send	The JSON object describing the event payload to send.	{ "routing_key": "testRoutingKey", "payload": { "summary": "Build Success: Increase snapshot create timeout to 30 seconds", "timestamp": "2015-07-17T08:42:58.315+0000", "source": "prod-build-agent-i-0b148d1040d565540", "custom_details": { "build_state": "passed", "build_number": "220", "run_time": "1236s" } }, "links": [ { "href": "https://buildpipeline.com/pagerduty/deployment/builds/220", "text": "View in Build Pipeline" } ], "images": [ { "src": "https://chart.googleapis.com/chart?chs=600x400&chd=t:6,2,9,5,2,5,7,4,8,2,1&cht=lc&chds=a&chxt=y&chm=D,0033FF,0,0,5,1", "href": "https://google.com", "alt": "An example link with an image" } ] }

Change Event To Send

The JSON object describing the event payload to send.

{
  "routing_key": "testRoutingKey",
  "payload": {
    "summary": "Build Success: Increase snapshot create timeout to 30 seconds",
    "timestamp": "2015-07-17T08:42:58.315+0000",
    "source": "prod-build-agent-i-0b148d1040d565540",
    "custom_details": {
      "build_state": "passed",
      "build_number": "220",
      "run_time": "1236s"
    }
  },
  "links": [
    {
      "href": "https://buildpipeline.com/pagerduty/deployment/builds/220",
      "text": "View in Build Pipeline"
    }
  ],
  "images": [
    {
      "src": "https://chart.googleapis.com/chart?chs=600x400&chd=t:6,2,9,5,2,5,7,4,8,2,1&cht=lc&chds=a&chxt=y&chm=D,0033FF,0,0,5,1",
      "href": "https://google.com",
      "alt": "An example link with an image"
    }
  ]
}

Example Payload for Send Change Event⤓

Loading…

Send Event

Send a trigger event to the Events API to report a new event. | key: sendEvent

Input Notes Example

Input	Notes	Example
Event to Send	The JSON object describing the event payload to send.	{ "payload": { "summary": "DISK at 99% on machine prod-datapipe03.example.com", "timestamp": "2015-07-17T08:42:58.315+0000", "severity": "critical", "source": "prod-datapipe03.example.com", "component": "mysql", "group": "prod-datapipe", "class": "disk", "custom_details": { "free space": "1%", "ping time": "1500ms", "load avg": 0.75 } }, "routing_key": "e93facc04764012d7bfb002500d5d1a6", "dedup_key": "srv01/mysql", "event_action": "trigger", "client": "Sample Monitoring Service", "client_url": "https://monitoring.service.com", "links": [ { "href": "http://pagerduty.example.com", "text": "An example link." } ], "images": [ { "src": "https://chart.googleapis.com/chart?chs=600x400&chd=t:6,2,9,5,2,5,7,4,8,2,1&cht=lc&chds=a&chxt=y&chm=D,0033FF,0,0,5,1", "href": "https://google.com", "alt": "An example link with an image" } ] }

Event to Send

The JSON object describing the event payload to send.

{
  "payload": {
    "summary": "DISK at 99% on machine prod-datapipe03.example.com",
    "timestamp": "2015-07-17T08:42:58.315+0000",
    "severity": "critical",
    "source": "prod-datapipe03.example.com",
    "component": "mysql",
    "group": "prod-datapipe",
    "class": "disk",
    "custom_details": {
      "free space": "1%",
      "ping time": "1500ms",
      "load avg": 0.75
    }
  },
  "routing_key": "e93facc04764012d7bfb002500d5d1a6",
  "dedup_key": "srv01/mysql",
  "event_action": "trigger",
  "client": "Sample Monitoring Service",
  "client_url": "https://monitoring.service.com",
  "links": [
    {
      "href": "http://pagerduty.example.com",
      "text": "An example link."
    }
  ],
  "images": [
    {
      "src": "https://chart.googleapis.com/chart?chs=600x400&chd=t:6,2,9,5,2,5,7,4,8,2,1&cht=lc&chds=a&chxt=y&chm=D,0033FF,0,0,5,1",
      "href": "https://google.com",
      "alt": "An example link with an image"
    }
  ]
}

Example Payload for Send Event⤓

Loading…

Test Webhook Subscription

Send a test ping to a webhook subscription. | key: testWebhookSubscription

Input	Notes	Example
Connection	The PagerDuty connection to use.
Webhook ID	The unique identifier for the webhook.	sampleWebhookId

Example Payload for Test Webhook Subscription⤓

Loading…

Update Change Event

Update an existing change event. | key: updateChangeEvent

Input Notes Example

Connection

The PagerDuty connection to use.

Change Event to Update

The JSON object describing the event payload to send.

{
  "change_event": {
    "summary": "Build Success - Increase snapshot create timeout to 30 seconds",
    "type": "change_event",
    "custom_details": {
      "build_state": "passed",
      "build_number": "2",
      "run_time": "1236s"
    }
  }
}

Event ID

The unique identifier for the change event.

Example Payload for Update Change Event⤓

Loading…

Update Incident

Update an existing incident. | key: updateIncident

Input	Notes	Example
Connection	The PagerDuty connection to use.
Incident ID	The unique identifier for the incident.	PT4KHLK
Incident	The JSON object containing the parameters of the incident to update.

Example Payload for Update Incident⤓

Loading…

Update Incident Alert

Update a single alert on an incident. | key: updateIncidentAlert

Input	Notes	Example
Alerts	The JSON array of alert objects, including the parameters to update for each alert.
Incident Alert ID	The unique identifier for the incident alert.	PT4KHLK
Connection	The PagerDuty connection to use.
Incident ID	The unique identifier for the incident.	PT4KHLK

Example Payload for Update Incident Alert⤓

Loading…

Update Service

Update an existing service. | key: updateService

Input Notes Example

Connection

The PagerDuty connection to use.

Service ID

The unique identifier for the service.

PIJ90N7

Service

The JSON object body describing the service to update.

{
  "type": "service",
  "name": "My Web App",
  "description": "My cool web application that does things.",
  "auto_resolve_timeout": 14400,
  "acknowledgement_timeout": 600,
  "status": "active",
  "escalation_policy": {
    "id": "PWIP6CQ",
    "type": "escalation_policy_reference"
  },
  "incident_urgency_rule": {
    "type": "use_support_hours",
    "during_support_hours": {
      "type": "constant",
      "urgency": "high"
    },
    "outside_support_hours": {
      "type": "constant",
      "urgency": "low"
    }
  },
  "support_hours": {
    "type": "fixed_time_per_day",
    "time_zone": "America/Lima",
    "start_time": "09:00:00",
    "end_time": "17:00:00",
    "days_of_week": [
      1,
      2,
      3,
      4,
      5
    ]
  },
  "scheduled_actions": [
    {
      "type": "urgency_change",
      "at": {
        "type": "named_time",
        "name": "support_hours_start"
      },
      "to_urgency": "high"
    }
  ],
  "alert_creation": "create_alerts_and_incidents",
  "alert_grouping_parameters": {
    "type": "time",
    "config": {
      "timeout": 2
    }
  },
  "auto_pause_notifications_parameters": {
    "enabled": true,
    "timeout": 300
  }
}

Example Payload for Update Service⤓

Loading…

Update Template

Update an existing template. | key: updateTemplate

Input Notes Example

Connection

The PagerDuty connection to use.

Template ID

The unique identifier for the template.

PBZUP2B

Template

The JSON object body describing the template to update.

{
  "description": "Sample template description",
  "templated_fields": {
    "email_body": "<div> sample </div>",
    "email_subject": "Sample email Subject",
    "message": "Sample SMS message"
  },
  "name": "Sample Template",
  "template_type": "status_update"
}

Example Payload for Update Template⤓

Loading…

Update User

Update an existing user. | key: updateUser

Input Notes Example

Connection

The PagerDuty connection to use.

User ID

The unique identifier for the user.

PXPGF42

User

The JSON object body describing the user to create.

{
  "user": {
    "type": "user",
    "name": "Earline Greenholt",
    "email": "125.greenholt.earline@graham.name",
    "time_zone": "America/Lima",
    "color": "green",
    "role": "admin",
    "job_title": "Director of Engineering",
    "avatar_url": "https://secure.gravatar.com/avatar/1d1a39d4635208d5664082a6c654a73f.png?d=mm&r=PG",
    "description": "I'm the boss",
    "license": {
      "id": "PTDVERC",
      "type": "license_reference"
    }
  }
}

Example Payload for Update User⤓

Loading…

Update Webhook Subscription

Update an existing webhook subscription. | key: updateWebhookSubscription

Input Notes Example

Connection

The PagerDuty connection to use.

Webhook ID

The unique identifier for the webhook.

sampleWebhookId

Update Webhook Payload

The JSON object body describing the updated webhook subscription.

{
  "webhook_subscription": {
    "events": [
      "incident.acknowledged",
      "incident.annotated",
      "incident.delegated",
      "incident.escalated",
      "incident.priority_updated",
      "incident.reassigned",
      "incident.reopened",
      "incident.resolved",
      "incident.responder.added",
      "incident.responder.replied",
      "incident.triggered",
      "incident.unacknowledged"
    ]
  }
}

Example Payload for Update Webhook Subscription⤓

Loading…

Changelog

2026-05-26

Added New Incidents polling trigger for detecting newly created incidents

2026-04-30

Various modernizations and documentation updates

2026-04-07

Various modernizations and documentation updates

PagerDuty is a platform for managing on-call operations. This component supports PagerDuty REST API V2.

Description​

API Documentation​

Connections​

API Key​

Prerequisites​

Setup Steps​

Configure the Connection​

OAuth 2.0​

Prerequisites​

Setup Steps​

Configure the Connection​

Triggers​

Incident Webhook​

How It Works​

Configuration​

Event Types​

Returned Data​

New Incidents​

How It Works​

Returned Data​

Service Webhook​

Configuration​

Event Types​

Data Sources​

Select Incident​

Select Service​

Select Template​

Select User​

Actions​

Create Incident​

Create Incident Note​

Create Service​

Create Template​

Create User​

Create Webhook Subscription​

Delete All Instance Webhooks​

Delete Service​

Delete Template​

Delete User​

Delete Webhook Subscription​

Enable Webhook Subscription​

Get Change Event​

Get Incident​

Get Incident Alert​

Get Service​

Get Template​

Get User​

Get Webhook Subscription​

List Change Events​

List Incident Alerts​

List Incident Notes​

List Incidents​

List Notifications​

List Priorities​

List Services​

List Templates​

List Users​

List Webhook Subscriptions​

Manage Incident Alerts​

Manage Incidents​

Raw Request​

Render Template​

Send Change Event​

Send Event​

Test Webhook Subscription​

Update Change Event​

Update Incident​

Update Incident Alert​

Update Service​

Update Template​

Update User​

Update Webhook Subscription​

Changelog​

2026-05-26​

2026-04-30​

2026-04-07​

Description

API Documentation

Connections

API Key

Prerequisites

Setup Steps

Configure the Connection

OAuth 2.0

Prerequisites

Setup Steps

Configure the Connection

Triggers

Incident Webhook

How It Works

Configuration

Event Types

Returned Data

New Incidents

How It Works

Returned Data

Service Webhook

Configuration

Event Types

Data Sources

Select Incident

Select Service

Select Template

Select User

Actions

Create Incident

Create Incident Note

Create Service

Create Template

Create User

Create Webhook Subscription

Delete All Instance Webhooks

Delete Service

Delete Template

Delete User

Delete Webhook Subscription

Enable Webhook Subscription

Get Change Event

Get Incident

Get Incident Alert

Get Service

Get Template

Get User

Get Webhook Subscription

List Change Events

List Incident Alerts

List Incident Notes

List Incidents

List Notifications

List Priorities

List Services

List Templates

List Users

List Webhook Subscriptions

Manage Incident Alerts

Manage Incidents

Raw Request

Render Template

Send Change Event

Send Event

Test Webhook Subscription

Update Change Event

Update Incident

Update Incident Alert

Update Service

Update Template

Update User

Update Webhook Subscription

Changelog

2026-05-26

2026-04-30

2026-04-07