# PagerDuty Component ![](/docs/img/components/icons/60/cGFnZXJkdXR5.png) #### PagerDuty is a platform for managing on-call operations. This component supports PagerDuty REST API V2. Component key: **pagerduty** · External docs ▾ * [API Docs](https://developer.pagerduty.com/api-reference/e65c5833eeb07-pager-duty-api) * [Changelog](https://developer.pagerduty.com/api-reference/f1a95bb9397ba-changelog) · [Changelog ↓](#changelog) ## Description[​](#description "Direct link to Description") PagerDuty is an industry leading incident management tool. Use the component to create and manage Incidents, events, and more. #### API Documentation:[​](#api-documentation "Direct link to API Documentation:") The component was built using the [PagerDuty REST API](https://developer.pagerduty.com/api-reference/e65c5833eeb07-pager-duty-api) ## Connections[​](#connections "Direct link to Connections") ### Api Key[​](#pagerduty-api-key "Direct link to Api Key") **key: pagerduty-api-key** Steps to generate and use an API Key for PagerDuty: 1. [Log in to PagerDuty](https://app.pagerduty.com/) and navigate to [Integrations | API Access Keys](https://support.pagerduty.com/main/docs/api-access-keys#section-generate-a-user-token-rest-api-key). 2. Click the "Create New API Key" button. 3. Enter a description for the API key. Check "Read-only API Key" if read-only behavior is desired. 4. Click Create Key. 5. Copy the provided API Key into the connection's configuration. | Input | Notes | Example | | ----- | ----- | ------- | | Token | | | ### OAuth 2.0[​](#pagerduty-oauth "Direct link to OAuth 2.0") **key: pagerduty-oauth** Steps to generate app credentials for [OAuth 2.0 for PagerDuty](https://developer.pagerduty.com/docs/b2a19cce2867a-classic-user-o-auth): 1. [Log in to PagerDuty](https://app.pagerduty.com/) and navigate to [Integrations | App Registration](https://developer.pagerduty.com/docs/dd91fbd09a1a1-register-an-app). 2. From the top menu, select **Integrations**. 3. Select **App Registration** from the menu to navigate to the **My Apps** page. 4. On the **My Apps** page, select **New App**. Enter a name for your app and a brief description. 5. Check the box next to **OAuth2.0** and/or **Events Integration.** 6. For Authorization select one of the following: 1. [**Scoped OAuth**](https://developer.pagerduty.com/docs/f59fdbd94ceab-o-auth-functionality#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 below to select Read or Write access to each Resource your integration will need access to. 2. [**Classic User OAuth**](https://developer.pagerduty.com/docs/f59fdbd94ceab-o-auth-functionality#scoped-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** 7. In the Redirect URL field enter `https://oauth2.prismatic.io/callback` 8. Select **Register App** 9. Copy and save the Client ID and Client Secret into your integration. | Input | Notes | Example | | ------------- | ----------------------------------------------------------------------------- | ----------------------------------------------- | | Authorize URL | The OAuth 2.0 Authorization URL for PagerDuty Code Grant | https\://identity.pagerduty.com/oauth/authorize | | Client ID | Client ID of your PagerDuty app | | | Client Secret | Client Secret of your PagerDuty app | | | Scopes | Classic User OAuth scope allowing read or read/write access to all resources. | write | | Token URL | The OAuth 2.0 Token URL for PagerDuty Code Grant | https\://identity.pagerduty.com/oauth/token | ## Triggers[​](#triggers "Direct link to Triggers") ### Incidents Trigger[​](#incidentstrigger "Direct link to Incidents Trigger") Handle Incident webhook notifications from PagerDuty. | **key: incidentsTrigger** | Input | Notes | Example | | ------------------- | ---------------------------------------------- | ------------------------------ | | Connection | | | | Incident Events | The events that trigger the webhook. | | | Filter ID | The ID of the object being used as the filter. | sampleFilterId | | Filter Type | The type of object being used as the filter. | | | Webhook Description | The description of the webhook. | This Is An Example Description | The Incidents Trigger receives [webhook notifications](https://support.pagerduty.com/main/docs/webhooks) 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[​](#how-it-works "Direct link to 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[​](#configuration "Direct link to 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[​](#event-types "Direct link to 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](https://support.pagerduty.com/main/docs/webhooks) for the complete and up-to-date list of event types. #### Returned Data[​](#returned-data "Direct link to Returned Data") Example Payload ```json { "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" } } } } ``` *** ### Service Trigger[​](#servicetrigger "Direct link to Service Trigger") Handle Service webhook notifications from PagerDuty. | **key: serviceTrigger** | Input | Notes | Example | | ------------------- | ---------------------------------------------- | ------------------------------ | | Connection | | | | Service Events. | The events that trigger the webhook. | | | Filter ID | The ID of the object being used as the filter. | sampleFilterId | | Filter Type | The type of object being used as the filter. | | | Webhook Description | The description of the webhook. | This Is An Example Description | The Service Trigger receives [webhook notifications](https://support.pagerduty.com/main/docs/webhooks) 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](#incidentstrigger) for complete documentation on how lifecycle management, configuration, and webhook subscriptions work. #### Configuration[​](#configuration-1 "Direct link to 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[​](#event-types-1 "Direct link to 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](https://support.pagerduty.com/main/docs/webhooks) for the complete and up-to-date list of event types. *** ## Data Sources[​](#data-sources "Direct link to Data Sources") ### Select Incident[​](#selectincident "Direct link to Select Incident") Retrieve and select an incident. | **key: selectIncident** | **type: picklist** | Input | Notes | Example | | ---------- | ----- | ------- | | Connection | | | *** ### Select Service[​](#selectservice "Direct link to Select Service") Retrieve and select a service. | **key: selectService** | **type: picklist** | Input | Notes | Example | | ---------- | ----- | ------- | | Connection | | | *** ### Select Template[​](#selecttemplate "Direct link to Select Template") Retrieve and select a template. | **key: selectTemplate** | **type: picklist** | Input | Notes | Example | | ---------- | ----- | ------- | | Connection | | | *** ### Select User[​](#selectuser "Direct link to Select User") Retrieve and select a user. | **key: selectUser** | **type: picklist** | Input | Notes | Example | | ---------- | ----- | ------- | | Connection | | | *** ## Actions[​](#actions "Direct link to Actions") ### Create Incident[​](#createincident "Direct link to Create Incident") Create an Incident | **key: createIncident** | Input | Notes | Example | | ---------- | ---------------------------------------------- | ----------- | | Connection | | | | Incident | JSON object body of the incident to be created | See Example | Example Payload for Create Incident[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/createIncident.json "Download example payload") Loading… *** ### Create Incident Note[​](#createincidentnote "Direct link to Create Incident Note") Create a note on an incident | **key: createIncidentNote** | Input | Notes | Example | | ----------- | ---------------------- | ----------- | | Connection | | | | Incident ID | The ID of the Incident | PT4KHLK | | Note | Note to create. | See Example | Example Payload for Create Incident Note[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/createIncidentNote.json "Download example payload") Loading… *** ### Create Service[​](#createservice "Direct link to Create Service") Create a service | **key: createService** | Input | Notes | Example | | ---------- | ----------------------------------------- | ------- | | Connection | | | | Service | JSON object body of the Service to create | | Example Payload for Create Service[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/createService.json "Download example payload") Loading… *** ### Create Template[​](#createtemplate "Direct link to Create Template") Create a template in PagerDuty's API | **key: createTemplate** | Input | Notes | Example | | --------------- | -------------------------------------------------- | ----------- | | Connection | | | | Template Object | JSON object body of the new Template to be created | See Example | Example Payload for Create Template[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/createTemplate.json "Download example payload") Loading… *** ### Create User[​](#createuser "Direct link to Create User") Create a user | **key: createUser** | Input | Notes | Example | | ---------- | --------------------------------------- | ----------- | | Connection | | | | User | JSON object body of the User to create. | See Example | Example Payload for Create User[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/createUser.json "Download example payload") Loading… *** ### Create Webhook Subscription[​](#createwebhooksubscription "Direct link to Create Webhook Subscription") Create a webhook subscription | **key: createWebhookSubscription** | Input | Notes | Example | | -------------------- | ----- | ----------- | | Connection | | | | Webhook Subscription | | See Example | Example Payload for Create Webhook Subscription[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/createWebhookSubscription.json "Download example payload") Loading… *** ### Delete All Instance Webhooks[​](#deleteallinstancewebhooks "Direct link to Delete All Instance Webhooks") Delete all webhooks associated with this instance | **key: deleteAllInstanceWebhooks** | Input | Notes | Example | | ---------- | ----- | ------- | | Connection | | | *** ### Delete Service[​](#deleteservice "Direct link to Delete Service") Delete a service | **key: deleteService** | Input | Notes | Example | | ---------- | ---------------------- | ------- | | Connection | | | | Service ID | The ID of the Service. | | Example Payload for Delete Service[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/deleteService.json "Download example payload") Loading… *** ### Delete Template[​](#deletetemplate "Direct link to Delete Template") Delete a template | **key: deleteTemplate** | Input | Notes | Example | | ---------- | ----------------------- | ------- | | Connection | | | | Id | The ID of the Template. | PBZUP2B | Example Payload for Delete Template[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/deleteTemplate.json "Download example payload") Loading… *** ### Delete User[​](#deleteuser "Direct link to Delete User") Delete a user | **key: deleteUser** | Input | Notes | Example | | ---------- | ----------------------------- | ------- | | Connection | | | | Id | The ID of the User to update. | | Example Payload for Delete User[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/deleteUser.json "Download example payload") Loading… *** ### Delete Webhook Subscription[​](#deletewebhooksubscription "Direct link to Delete Webhook Subscription") Delete a webhook subscription | **key: deleteWebhookSubscription** | Input | Notes | Example | | ----------- | ---------------------- | --------------- | | Connection | | | | Webhook ID. | The ID of the webhook. | sampleWebhookId | Example Payload for Delete Webhook Subscription[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/deleteWebhookSubscription.json "Download example payload") Loading… *** ### Enable Webhook Subscription[​](#enablewebhooksubscription "Direct link to Enable Webhook Subscription") Enable a webhook subscription | **key: enableWebhookSubscription** | Input | Notes | Example | | ----------- | ---------------------- | --------------- | | Connection | | | | Webhook ID. | The ID of the webhook. | sampleWebhookId | Example Payload for Enable Webhook Subscription[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/enableWebhookSubscription.json "Download example payload") Loading… *** ### Get Change Event[​](#getchangeevent "Direct link to Get Change Event") Get a Change Event | **key: getChangeEvent** | Input | Notes | Example | | ---------- | --------------------------- | ------- | | Connection | | | | Event Id | The ID of the Change Event. | 12 | Example Payload for Get Change Event[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/getChangeEvent.json "Download example payload") Loading… *** ### Get Incident[​](#getincident "Direct link to Get Incident") Get an incident | **key: getIncident** | Input | Notes | Example | | ----------- | -------------------------------------- | ------- | | Connection | | | | Incident ID | The ID of the Incident | PT4KHLK | | Include | Array of additional details to include | | Example Payload for Get Incident[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/getIncident.json "Download example payload") Loading… *** ### Get Incident Alert[​](#getincidentalert "Direct link to Get Incident Alert") Get an alert | **key: getIncidentAlert** | Input | Notes | Example | | ----------------- | ---------------------------- | ------- | | Incident Alert ID | The ID of the Incident Alert | PT4KHLK | | Connection | | | | Incident ID | The ID of the Incident | PT4KHLK | Example Payload for Get Incident Alert[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/getIncidentAlert.json "Download example payload") Loading… *** ### Get Service[​](#getservice "Direct link to Get Service") Get a service | **key: getService** | Input | Notes | Example | | ---------- | --------------------------------------- | ------- | | Connection | | | | Service ID | The ID of the Service. | | | Include | Array of additional details to include. | | Example Payload for Get Service[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/getService.json "Download example payload") Loading… *** ### Get Template[​](#gettemplate "Direct link to Get Template") Get a template | **key: getTemplate** | Input | Notes | Example | | ---------- | ----------------------- | ------- | | Connection | | | | Id | The ID of the Template. | PBZUP2B | Example Payload for Get Template[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/getTemplate.json "Download example payload") Loading… *** ### Get User[​](#getuser "Direct link to Get User") Get a user | **key: getUser** | Input | Notes | Example | | ---------- | -------------------------------------------------- | ------- | | Connection | | | | Id | The ID of the User to update. | | | Include | Array of additional Models to include in response. | | Example Payload for Get User[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/getUser.json "Download example payload") Loading… *** ### Get Webhook Subscription[​](#getwebhooksubscription "Direct link to Get Webhook Subscription") Get a webhook subscription | **key: getWebhookSubscription** | Input | Notes | Example | | ----------- | ---------------------- | --------------- | | Connection | | | | Webhook ID. | The ID of the webhook. | sampleWebhookId | Example Payload for Get Webhook Subscription[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/getWebhookSubscription.json "Download example payload") Loading… *** ### List Change Events[​](#listchangeevents "Direct link to List Change Events") List Change Events | **key: listChangeEvents** | Input | Notes | Example | | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | | Connection | | | | Fetch All | Performs pagination on this endpoint. | true | | Integration Ids | An array of integration IDs. | PEYSGVF | | Limit | The number of results per page. | 10 | | Offset | Offset to start pagination search results. | 18 | | Since | The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. | 2020-07-17T07:42:58Z | | Team Ids | An array of team IDs. | PEYSGVF | | Total | By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for the response to be populated. | false | | Until | The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. | 2020-07-17T07:42:58Z | Example Payload for List Change Events[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/listChangeEvents.json "Download example payload") Loading… *** ### List Incident Alerts[​](#listincidentalerts "Direct link to List Incident Alerts") List alerts for an incident | **key: listIncidentAlerts** | Input | Notes | Example | | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | | Alert Key | Alert de-duplication key | baf7cf21b1da41b4b0221008339ff357 | | Connection | | | | Fetch All | Performs pagination on this endpoint. | true | | Incident ID | The ID of the Incident | PT4KHLK | | Include | Array of additional details to include | | | Limit | The number of results per page. | 10 | | Offset | Offset to start pagination search results. | 18 | | Sort By | Used to specify both the field you wish to sort the results on (created\_at/resolved\_at), as well as the direction (asc/desc) of the results | | | Statuses | Return only incidents with the given statuses | | | Total | By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for the response to be populated. | false | Example Payload for List Incident Alerts[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/listIncidentAlerts.json "Download example payload") Loading… *** ### List Incident Notes[​](#listincidentnotes "Direct link to List Incident Notes") List notes for an incident | **key: listIncidentNotes** | Input | Notes | Example | | ----------- | ---------------------- | ------- | | Connection | | | | Incident ID | The ID of the Incident | PT4KHLK | Example Payload for List Incident Notes[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/listIncidentNotes.json "Download example payload") Loading… *** ### List Incidents[​](#listincidents "Direct link to List Incidents") List incidents | **key: listIncidents** | Input | Notes | Example | | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | | Connection | | | | Date Range | When set to all, the since and until parameters and defaults are ignored | | | Fetch All | Performs pagination on this endpoint. | true | | Incident Key | Incident de-duplication key | baf7cf21b1da41b4b0221008339ff357 | | Include | Array of additional details to include | | | Limit | The number of results per page. | 10 | | Offset | Offset to start pagination search results. | 18 | | Service Ids | Returns only the incidents associated with the passed service(s) | PIJ90N7 | | Since | The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. | 2020-07-17T07:42:58Z | | Sort By | Used to specify both the field you wish to sort the results on (incident\_number/created\_at/resolved\_at/urgency), as well as the direction (asc/desc) of the results | | | Statuses | Return only incidents with the given statuses | | | Team Ids | An array of team IDs. | PEYSGVF | | Time Zone | TZInfo-formatted time zone in which results will be rendered | | | Total | By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for the response to be populated. | false | | Until | The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. | 2020-07-17T07:42:58Z | | Urgencies | Return only incidents with this urgency | | | User Ids | Returns only the incidents currently assigned to the passed user(s) | PXPGF42 | Example Payload for List Incidents[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/listIncidents.json "Download example payload") Loading… *** ### List Notifications[​](#listnotifications "Direct link to List Notifications") List notifications | **key: listNotifications** | Input | Notes | Example | | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | | Connection | | | | Fetch All | Performs pagination on this endpoint. | true | | Filter | Return notification of this type only | | | Include | Array of additional details to include | | | Limit | The number of results per page. | 10 | | Offset | Offset to start pagination search results. | 18 | | Since | The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. | 2020-07-17T07:42:58Z | | Time Zone | TZInfo-formatted time zone in which results will be rendered | | | Total | By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for the response to be populated. | false | | Until | The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. | 2020-07-17T07:42:58Z | Example Payload for List Notifications[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/listNotifications.json "Download example payload") Loading… *** ### List Priorities[​](#listpriorities "Direct link to List Priorities") List priorities | **key: listPriorities** | Input | Notes | Example | | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | | Connection | | | | Fetch All | Performs pagination on this endpoint. | true | | Limit | The number of results per page. | 10 | | Offset | Offset to start pagination search results. | 18 | | Total | By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for the response to be populated. | false | Example Payload for List Priorities[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/listPriorities.json "Download example payload") Loading… *** ### List Services[​](#listservices "Direct link to List Services") List services | **key: listServices** | Input | Notes | Example | | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | | Connection | | | | Fetch All | Performs pagination on this endpoint. | true | | Include | Array of additional details to include. | | | Limit | The number of results per page. | 10 | | Name | Filters the results, showing only services with the specified name | My Service | | Offset | Offset to start pagination search results. | 18 | | Query | Filters the result, showing only the records whose name matches the query. | sampleName | | Sort By | Used to specify the field you wish to sort the results on. | | | Team Ids | An array of team IDs. | PEYSGVF | | Time Zone | TZInfo-formatted time zone in which results will be rendered | | | Total | By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for the response to be populated. | false | Example Payload for List Services[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/listServices.json "Download example payload") Loading… *** ### List Templates[​](#gettemplates "Direct link to List Templates") List all templates | **key: getTemplates** | Input | Notes | Example | | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | | Connection | | | | Fetch All | Performs pagination on this endpoint. | true | | Limit | The number of results per page. | 10 | | Offset | Offset to start pagination search results. | 18 | | Query | Template name or description to search | Template Name 1 | | Sort By | Used to specify both the field you wish to sort the results on (name/created\_at), as well as the direction (asc/desc) of the results | created\_at:asc | | Template Type | Filters templates by type. | status\_update | | Total | By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for the response to be populated. | false | Example Payload for List Templates[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/getTemplates.json "Download example payload") Loading… *** ### List Users[​](#listusers "Direct link to List Users") List all users | **key: listUsers** | Input | Notes | Example | | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | | Connection | | | | Fetch All | Performs pagination on this endpoint. | true | | Include | Array of additional Models to include in response. | | | Limit | The number of results per page. | 10 | | Offset | Offset to start pagination search results. | 18 | | Query | Filters the result, showing only the records whose name matches the query. | sampleName | | Team Ids | An array of team IDs. | PEYSGVF | | Total | By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for the response to be populated. | false | Example Payload for List Users[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/listUsers.json "Download example payload") Loading… *** ### List Webhook Subscriptions[​](#listwebhooksubscriptions "Direct link to List Webhook Subscriptions") List webhook subscriptions | **key: listWebhookSubscriptions** | Input | Notes | Example | | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | | Connection | | | | Fetch All | Performs pagination on this endpoint. | true | | Filter Id | The ID of the resource to filter upon. | 123 | | Filter Type | The type of resource to filter upon. | | | Limit | The number of results per page. | 10 | | Offset | Offset to start pagination search results. | 18 | | Total | By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for the response to be populated. | false | Example Payload for List Webhook Subscriptions[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/listWebhookSubscriptions.json "Download example payload") Loading… *** ### Manage Incident Alerts[​](#updateincidentalerts "Direct link to Manage Incident Alerts") Manage alerts | **key: updateIncidentAlerts** | Input | Notes | Example | | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | | Alerts | An array of alert objects, including the parameters to update for each alert | | | Connection | | | | Incident ID | The ID of the Incident | PT4KHLK | | Limit | The number of results per page. | 10 | | Offset | Offset to start pagination search results. | 18 | | Total | By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for the response to be populated. | false | Example Payload for Manage Incident Alerts[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/updateIncidentAlerts.json "Download example payload") Loading… *** ### Manage Incidents[​](#updateincidents "Direct link to Manage Incidents") Manage Incidents | **key: updateIncidents** | Input | Notes | Example | | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | | Connection | | | | Incidents | An array of incidents, including the parameters to update. | See Example | | Limit | The number of results per page. | 10 | | Offset | Offset to start pagination search results. | 18 | | Total | By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for the response to be populated. | false | Example Payload for Manage Incidents[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/updateIncidents.json "Download example payload") Loading… *** ### Raw Request[​](#rawrequest "Direct link to 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[​](#rendertemplate "Direct link to Render Template") Render a template | **key: renderTemplate** | Input | Notes | Example | | -------------- | -------------------------------------------------------------------- | --------------------- | | Connection | | | | Id | The ID of the Template. | PBZUP2B | | Incident ID | The ID of the Incident | PT4KHLK | | Update Message | An optional status update message that will be sent to the template. | Status update message | Example Payload for Render Template[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/renderTemplate.json "Download example payload") Loading… *** ### Send Change Event[​](#sendchangeevent "Direct link to Send Change Event") Send Change Event to Events API | **key: sendChangeEvent** | Input | Notes | Example | | -------------------- | ---------------------------------- | ----------- | | Change Event To Send | The JSON object body of the event. | See Example | Example Payload for Send Change Event[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/sendChangeEvent.json "Download example payload") Loading… *** ### Send Event[​](#sendevent "Direct link to Send Event") Sends PagerDuty a trigger event to report a new event | **key: sendEvent** | Input | Notes | Example | | ------------- | ---------------------------------- | ----------- | | Event to Send | The JSON object body of the event. | See Example | Example Payload for Send Event[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/sendEvent.json "Download example payload") Loading… *** ### Test Webhook Subscription[​](#testwebhooksubscription "Direct link to Test Webhook Subscription") Test a webhook subscription | **key: testWebhookSubscription** | Input | Notes | Example | | ----------- | ---------------------- | --------------- | | Connection | | | | Webhook ID. | The ID of the webhook. | sampleWebhookId | Example Payload for Test Webhook Subscription[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/testWebhookSubscription.json "Download example payload") Loading… *** ### Update Change Event[​](#updatechangeevent "Direct link to Update Change Event") Update a Change Event | **key: updateChangeEvent** | Input | Notes | Example | | ---------------------- | ---------------------------------- | ----------- | | Connection | | | | Change Event to Update | The JSON object body of the event. | See Example | | Event Id | The ID of the Change Event. | 12 | Example Payload for Update Change Event[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/updateChangeEvent.json "Download example payload") Loading… *** ### Update Incident[​](#updateincident "Direct link to Update Incident") Update an incident | **key: updateIncident** | Input | Notes | Example | | ----------- | ---------------------------------------- | ------- | | Connection | | | | Incident ID | The ID of the Incident | PT4KHLK | | Incident | The parameters of the incident to update | | Example Payload for Update Incident[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/updateIncident.json "Download example payload") Loading… *** ### Update Incident Alert[​](#updateincidentalert "Direct link to Update Incident Alert") Update an incident alert | **key: updateIncidentAlert** | Input | Notes | Example | | ----------------- | ---------------------------------------------------------------------------- | ------- | | Alerts | An array of alert objects, including the parameters to update for each alert | | | Incident Alert ID | The ID of the Incident Alert | PT4KHLK | | Connection | | | | Incident ID | The ID of the Incident | PT4KHLK | Example Payload for Update Incident Alert[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/updateIncidentAlert.json "Download example payload") Loading… *** ### Update Service[​](#updateservice "Direct link to Update Service") Update a service | **key: updateService** | Input | Notes | Example | | ---------- | ----------------------------------------- | ----------- | | Connection | | | | Service ID | The ID of the Service. | | | Service | JSON object body of the Service to update | See Example | Example Payload for Update Service[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/updateService.json "Download example payload") Loading… *** ### Update Template[​](#updatetemplate "Direct link to Update Template") Update a template | **key: updateTemplate** | Input | Notes | Example | | ---------- | ---------------------------------------------- | ----------- | | Connection | | | | Id | The ID of the Template. | PBZUP2B | | Template | JSON object body of the Template to be updated | See Example | Example Payload for Update Template[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/updateTemplate.json "Download example payload") Loading… *** ### Update User[​](#updateuser "Direct link to Update User") Update a user | **key: updateUser** | Input | Notes | Example | | ---------- | --------------------------------------- | ----------- | | Connection | | | | Id | The ID of the User to update. | | | User | JSON object body of the User to create. | See Example | Example Payload for Update User[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/updateUser.json "Download example payload") Loading… *** ### Update Webhook Subscription[​](#updatewebhooksubscription "Direct link to Update Webhook Subscription") Update a webhook subscription | **key: updateWebhookSubscription** | Input | Notes | Example | | ---------------------- | ---------------------------------------- | --------------- | | Connection | | | | Webhook ID. | The ID of the webhook. | sampleWebhookId | | Update Webhook Payload | The updated webhook subscription object. | See Example | Example Payload for Update Webhook Subscription[⤓](https://prismatic.io/docs/example-payloads/pagerduty/actions/updateWebhookSubscription.json "Download example payload") Loading… *** ## Changelog[​](#changelog "Direct link to Changelog") ### 2026-04-30[​](#2026-04-30 "Direct link to 2026-04-30") Updated spectral version ### 2026-04-07[​](#2026-04-07 "Direct link to 2026-04-07") Various modernizations and documentation updates