Team
Shared credential for production and unattended runs.
Connect PagerDuty with Hookshot™ and your stack
PagerDuty helps you proactively manage your digital operations by collecting data signals from anywhere, interpreting those signals using machine learning, automatically engaging the right people, and accelerating resolution and learning.
Tools and triggers
What Agents can do in PagerDuty
Available tools and events after PagerDuty is connected.
-
Add Service to Incident Workflow Trigger
Adds a service to an existing incident workflow trigger in PagerDuty, enabling the trigger to fire for incidents on that service. Associates a specific service with an incident workflow trigger to automate incident…
-
Aggregate Escalation Policy Incident Metrics
This endpoint analyzes and aggregates incident metrics across all escalation policies in PagerDuty. It allows for detailed filtering and customization of the analysis, enabling users to gain insights into incident…
-
Aggregate Incident Metrics with Filters
Retrieves and aggregates metrics for incidents across all services in PagerDuty. This endpoint allows for extensive filtering and customization of incident data, enabling detailed analysis of operational performance…
-
Associate Service Dependencies
Associates multiple service dependencies in PagerDuty, allowing you to define relationships between supporting and dependent services. This endpoint is used to establish a hierarchical structure of services, which is…
-
Associate Team with Automation Action
This endpoint associates a specific team with an automation action in PagerDuty. It allows you to link a team to an automated workflow, enabling better organization and management of automation actions within your…
-
Audit Escalation Policy Records
Retrieves the audit records for a specific escalation policy in PagerDuty. This endpoint allows users to access a detailed history of changes made to the escalation policy, including modifications to escalation rules…
-
Check If Service Event Orchestration Is Active
Check if event orchestration is active for a specific PagerDuty service. This endpoint returns a boolean flag indicating whether Service Event Orchestration is currently active for the specified service. When active…
-
Convert Service Rule by Id
Converts a service's Event Rules to Event Orchestration rules. This migration endpoint automatically converts Service Event Rules to the newer Event Orchestration format, identically re-creating existing rules while…
-
Count Paused Incident Reports
Retrieves the count of paused incident reports in the PagerDuty system. This endpoint is part of PagerDuty's Incident Management and Analytics features, providing a quick way to quantify the number of incidents that…
-
Create a Custom Field for an Incident Type
Create a Custom Field for an Incident Type. Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data, to provide additional context and support features such as…
-
Create a Field Option for a Custom Field
Creates a new field option for a custom field on an incident type. Field options represent the allowed values for multi-value or dropdown custom fields. Before using this action: 1. You need a valid incident type ID or…
-
Create an Incident Type
Create a new incident type. Incident Types are a feature which will allow customers to categorize incidents, such as a security incident, a major incident, or a fraud incident. <!-- theme: warning --> > ### Early…
-
Create Automation Runner Endpoint
Creates a new Runbook Automation runner in PagerDuty's Automation Actions. A runner is the execution engine that invokes automation actions. Only 'runbook' type runners can be created via API. Required fields…
-
Create Business Service
This endpoint creates a new Business Service in PagerDuty, which represents a specific service or application that can be monitored and managed within the incident management platform. It allows you to define essential…
-
Create Escalation Policy
Creates a new escalation policy in PagerDuty, defining how incidents are escalated to different responders or teams. This endpoint allows you to set up a structured response plan for managing incidents, including…
-
Create Event Orchestration
Creates a new Event Orchestration in PagerDuty, which defines how incoming events are processed and routed to appropriate services. This endpoint allows you to set up a configuration that manages the flow of events…
-
Create Extension Object
Creates a new extension in PagerDuty, allowing for additional functionality or integrations to be added to your services. This endpoint is used to set up webhooks, custom integrations, or other specific features that…
-
Create Handoff Notification Rule
Creates a new on-call handoff notification rule for a specific user in PagerDuty. This endpoint allows you to set up automated notifications for when a user is about to start or end their on-call shift. It defines how…
-
Create Incident Field Option
Creates a new field option for a specific custom field in PagerDuty's incident management system. This endpoint allows you to add predefined options to custom fields, enhancing the ability to categorize and filter…
-
Create Incident Record
Creates a new incident in PagerDuty with specified details and assignments. Use this endpoint when an event requires immediate attention from on-call teams. It supports comprehensive incident documentation, including…
-
Create Incident Workflow
This endpoint creates a new Incident Workflow in PagerDuty, allowing users to define a series of automated steps to be executed during incident response. It enables the setup of complex, multi-step processes that can…
-
Create Incident Workflow Instance
Creates a new instance of an incident workflow for a specific incident in PagerDuty. This endpoint allows you to initiate a predefined workflow process for managing and resolving an ongoing incident. It links the…
-
Create Incident Workflow Trigger
Creates a new incident workflow trigger in PagerDuty. Triggers define when and how incident workflows are activated - either automatically based on conditions or manually by responders. Trigger types: 'manual' (started…
-
Create Integration for Orchestration
Creates a new integration for an existing event orchestration in PagerDuty. This action adds an integration to an event orchestration, enabling it to receive events from external monitoring tools, alerting systems, or…
-
Create Integration for Service
Creates a new integration for a PagerDuty service to enable incident creation from external monitoring tools and systems. Integrations can be either generic (using 'type' parameter) or vendor-specific (using 'vendor'…
-
Create Maintenance Window Object
Creates a new maintenance window in PagerDuty, allowing you to schedule periods of planned maintenance for specific services. During a maintenance window, incidents are not created for the affected services, preventing…
-
Create New Schedule Layer
Creates a new on-call schedule in PagerDuty with one or more rotation layers. A schedule defines who is on-call at any given time. Each schedule contains one or more layers that specify rotation patterns, with each…
-
Create New Service
Creates a new service in PagerDuty, which is a key component for managing incidents and alerts. This endpoint allows you to set up a service with various configurations including escalation policies, incident urgency…
-
Create New Tag in System
Creates a new tag in PagerDuty for labeling and categorizing entities. This endpoint allows users to add a custom label to their PagerDuty account, which can be used to organize and filter various resources such as…
-
Create New Team with Details
Creates a new team in PagerDuty for organizing users, incident management, and on-call schedules. Required: team.name (unique team name) Optional: team.description, team.parent (for nested hierarchies)…
-
Create New Webhook Subscription
Creates a new webhook subscription in PagerDuty to receive specific event notifications. This endpoint allows users to set up automated notifications for various incident-related events, such as triggers…
-
Create or Update Status Page Post
Creates a new post on a PagerDuty Status Page to communicate service status to users. Use this action to publish incident reports (for service disruptions) or maintenance announcements (for scheduled work). Each post…
-
Create or Update Status Page Postmortem
Creates or updates a postmortem for a specific status page post in PagerDuty. This endpoint allows you to add detailed analysis and insights about an incident after its resolution. The postmortem can include rich-text…
-
Create Schedule Overrides Configuration
Creates one or more overrides for a specific schedule in PagerDuty. This endpoint allows you to temporarily modify the on-call schedule by assigning different users for specific time periods. It's useful for handling…
-
Create Status Update Template
Creates a new status update template in PagerDuty for standardized incident notifications. Templates provide consistent, pre-formatted messages for stakeholder updates across email, SMS, push, and Slack. Supports…
-
Create Statuspage Subscription
Creates a new subscription for a PagerDuty status page. This endpoint allows users to set up notifications for specific status pages or components within those pages. It's used to keep subscribers informed about…
-
Create User Notification Rule
Creates a new notification rule for a specific user in PagerDuty. This endpoint allows you to define how and when a user should be notified about assigned incidents. You can specify the delay before notification, the…
-
Create User Object
Creates a new user in the PagerDuty system with the specified attributes. This endpoint should be used when onboarding new team members or adding users to your PagerDuty account. It allows you to set up essential user…
-
Create User Status Update Notification Rule
Creates a new status update notification rule for a specific user in PagerDuty. This endpoint allows you to define how a user will be notified about incident status updates. It's used to customize notification…
-
Create Workflow Integration Connection
Create a new Workflow Integration Connection. Scoped OAuth requires: `workflow_integrations:connections.write`
-
Delete a Custom Field for an Incident Type
Deletes a custom field from an incident type. This permanently removes the field definition and associated options, but does not affect historical data on existing incidents. Prerequisites: 1. Valid incident type ID or…
-
Delete a Field Option for a Custom Field
Deletes a specific field option from a custom field on an incident type. Field options represent the allowed values for multi-value or dropdown custom fields. This action permanently removes a field option. If…
-
Delete Account Subscription by Id
Deletes the account subscription associated with a specific business service in PagerDuty. This endpoint is used to terminate the subscription or billing relationship between a business service and the account. It…
-
Delete Addon by Id
Deletes a specific add-on from the PagerDuty account using its unique identifier. This endpoint should be used when you want to remove an integration or extension that is no longer needed or active in your PagerDuty…
-
Delete Alert Grouping Setting
This endpoint allows you to delete specific alert grouping settings in PagerDuty. It is used to remove outdated or unnecessary configurations that determine how alerts are grouped into incidents. The deletion is…
-
Delete All Oauth Delegations
Delete all OAuth delegations for a user based on the specified type. An OAuth delegation represents an instance of a user or account's authorization to an app (via OAuth) to access their PagerDuty account. Common apps…
-
Delete All User Sessions
Deletes all active sessions for a specified user in the PagerDuty system. This endpoint is used to forcibly log out a user from all devices and applications where they might be currently authenticated. It's…
-
Delete Automation Action by Id
Deletes a specific Automation Action from the PagerDuty system. This endpoint is used to permanently remove an Automation Action, which includes any associated scripts or jobs in Runbook Automation. It should be used…
-
Delete Automation Action Service by Id
This endpoint removes a specific automation action from a particular service in PagerDuty. It is used to disassociate an automated workflow or action from a service, effectively stopping that action from being…
-
Delete Automation Actions Runner by Id
Permanently deletes an automation actions runner from PagerDuty. Automation runners execute automated tasks and workflows during incident response. Use this when a runner is no longer needed or needs replacement…
-
Delete Business Service by Id
Deletes a specific business service from the PagerDuty system. This endpoint should be used when you want to permanently remove a business service that is no longer needed or relevant to your organization's incident…
-
Delete Business Service Priority Thresholds
Deletes the account-level global priority threshold for business services in PagerDuty. This endpoint removes the configured priority threshold that determines the minimum incident priority level required for incidents…
-
Delete Cache Variable for Event
Deletes a specific cache variable associated with an event orchestration in PagerDuty. This endpoint is used to remove temporary data storage that was previously set up for use in event orchestration workflows. It…
-
Delete Cache Variable From Service
Deletes a cache variable from a service's event orchestration. Cache variables store temporary data used in event orchestration workflows. This action permanently removes the specified cache variable. Returns HTTP 204…
-
Delete Custom Field by Field Id
Deletes a specific custom field from incidents in PagerDuty. This endpoint allows users to remove a custom field that is no longer needed or relevant for incident management. It should be used when you want to…
-
Delete Escalation Policy by Id
Permanently removes a specific escalation policy from the PagerDuty system. This endpoint should be used when an escalation policy is no longer needed or has become obsolete. Once deleted, the escalation policy cannot…
-
Delete Event by Id
Deletes a specific Event Orchestration from the PagerDuty system. This endpoint should be used when you want to permanently remove an Event Orchestration configuration, including all its associated rules and routing…
-
Delete Extension by Id
Deletes a specific extension from the PagerDuty service. This endpoint should be used when you want to remove an additional feature or integration that has been previously added to your PagerDuty account. It's…
-
Delete Field Option
Permanently deletes a field option from a custom incident field. For example, removes "Medium" from a Priority field with options "Critical", "High", "Medium", "Low". **Prerequisites:** Use…
-
Delete Incident Workflow by Id
Deletes a specific incident workflow from the PagerDuty system. This endpoint should be used when you want to permanently remove a customized sequence of automated actions and triggers associated with incident…
-
Delete Incident Workflow Trigger by Id
Deletes a specific trigger associated with an incident workflow in PagerDuty. This endpoint is used to remove an automated trigger that initiates a predefined workflow in response to incidents. It should be used when…
-
Delete Incident Workflow Trigger Service
Removes a service from an incident workflow trigger in PagerDuty. This action disassociates a specific service from a trigger, preventing incidents from that service from automatically activating the workflow. Use this…
-
Delete Integration From Event Orchestration
Removes a specific integration from an event orchestration in PagerDuty. This endpoint is used to disconnect a particular tool or service from the event orchestration setup, effectively stopping it from triggering or…
-
Delete Maintenance Window by Id
Deletes a specific maintenance window in PagerDuty's incident management system. This endpoint is used to permanently remove a scheduled maintenance window, effectively re-enabling any services and integrations that…
-
Delete Oncall Handoff Notification Rule
This endpoint deletes a specific on-call handoff notification rule for a given user in PagerDuty. It is used to remove custom notification settings for when on-call responsibilities are transferred between team…
-
Delete Post From Status Page
This endpoint deletes a specific post from a PagerDuty status page. It is used to remove outdated or irrelevant information from a status page, helping to maintain clear and accurate communication with users about…
-
Delete Post Update by Id
This endpoint deletes a specific post update from a status page post in PagerDuty. It allows users to remove outdated or incorrect information from a status page, ensuring that only relevant and accurate updates are…
-
Delete Rule From Ruleset by Id
Deletes a specific event rule from a ruleset in PagerDuty. This endpoint permanently removes an individual rule from the specified ruleset. The operation cannot be undone, so use with caution as it may affect event…
-
Delete Ruleset by Id
Deletes a specific ruleset from the PagerDuty system based on the provided ID. This endpoint should be used when you need to remove an existing ruleset, which may be necessary during incident management reconfiguration…
-
Delete Runner Team Association
This endpoint removes a team's association from a specific Automation Action runner in PagerDuty. It is used to revoke a team's access to execute or manage tasks on a particular runner. The operation is permanent and…
-
Delete Schedule by Id
The DeleteSchedule endpoint removes a specific schedule from the PagerDuty system. It is used to delete outdated or unnecessary on-call schedules, helping to maintain an organized and efficient incident management…
-
Delete Schedule Override by Id
This endpoint deletes a specific override from a PagerDuty schedule. It allows users to remove temporary changes made to the regular schedule, reverting it back to its original state. This operation is useful for…
-
Delete Service by Id
Deletes a specific service from the PagerDuty account. This endpoint should be used when you need to permanently remove a service that is no longer required or active. It's important to note that this operation is…
-
Delete Service Rule by Id
Deletes a specific rule from a PagerDuty service. This endpoint is used to permanently remove a rule that defines conditions for incident creation or automation within a particular service. It should be used when you…
-
Delete Status Page Postmortem
This endpoint allows you to delete a postmortem associated with a specific post on a PagerDuty status page. It is used to remove the detailed analysis and lessons learned from an incident after it has been resolved and…
-
Delete Status Update Notification Rule
Deletes a specific status update notification rule associated with a user in the PagerDuty system. This endpoint allows administrators or users with appropriate permissions to remove custom notification rules for…
-
Delete Subscription From Status Page
Deletes a specific subscription associated with a PagerDuty status page. This endpoint is used to remove a subscription, effectively stopping notifications or updates related to the status page for the subscribed…
-
Delete Tag by Id
Deletes a specific tag from the PagerDuty system based on its unique identifier. This endpoint should be used when you need to remove a tag that is no longer relevant or necessary for categorizing incidents, services…
-
Delete Team by Id
Deletes a team from PagerDuty by its ID. This is a permanent, irreversible operation. Required: id (team ID to delete, e.g., 'PXXXXXX') Optional: reassignment_team (team ID to reassign unresolved incidents to)…
-
Delete Team Escalation Policy
This endpoint removes an escalation policy association from a specific team in PagerDuty. It is used to update team configurations by disassociating an escalation policy that is no longer needed or relevant for the…
-
Delete Team From Automation Action
This endpoint removes a specific team's access to an Automation Action in PagerDuty. It's used to revoke permissions when a team no longer needs to use or should not have access to a particular Automation Action. This…
-
Delete Template by Id
Deletes a specific template from the PagerDuty account. This endpoint is used to permanently remove a template configuration, which can be useful for cleaning up outdated or unnecessary incident response plans. Once…
-
Delete User by Id
Deletes a specific user from the PagerDuty system using their unique identifier. This endpoint should be used when you need to permanently remove a user's account, such as when an employee leaves the organization or no…
-
Delete User Contact Method
Deletes a specific contact method associated with a user in PagerDuty. This endpoint should be used when you need to remove an outdated or unnecessary contact method from a user's profile. It permanently removes the…
-
Delete User From Team by Id
This endpoint removes a specific user from a designated team within the PagerDuty incident management platform. It is used to update team compositions by disassociating a user from a particular team, which affects the…
-
Delete User Notification Rule
Deletes a specific notification rule for a user in PagerDuty. This endpoint allows administrators or users with appropriate permissions to remove custom notification rules, modifying how and when a user receives alerts…
-
Delete User Session by Type
This endpoint deletes a specific user session in PagerDuty. It is used to forcibly terminate an active session for a given user, effectively logging them out from a particular device or application. This operation is…
-
Delete Webhook Subscription by Id
Deletes a specific webhook subscription from your PagerDuty account. This endpoint should be used when you want to stop receiving notifications for a particular webhook subscription, such as when the integration is no…
-
Delete Workflow Integration Connection
Deletes a specific workflow integration connection from PagerDuty. Workflow integration connections enable PagerDuty workflows to interact with external services like AWS, Azure, Slack, and other platforms. This…
-
Disassociate Service Dependencies
Disassociates (removes) service dependencies in PagerDuty by deleting specified relationships between supporting and dependent services. This endpoint allows for efficient removal of multiple service dependencies in a…
-
Edit Webhook Subscription by Id
Edit an existing webhook subscription in PagerDuty to modify its configuration. This action allows you to: - Update the list of incident event types the webhook subscribes to - Change the subscription description -…
-
Enable Extension by Id
Enables a temporarily disabled extension in PagerDuty. Extensions (such as webhooks and custom integrations) can be automatically disabled by PagerDuty when there are repeated delivery failures, timeouts, or other…
-
Enable Webhook Subscription by Id
Activates a specific webhook subscription in PagerDuty, enabling the system to send notifications for the events configured in that subscription. This endpoint should be used when you want to start receiving webhook…
-
Fetch Cache Variable for Event Orchestration
Retrieves detailed information about a specific cache variable in a PagerDuty event orchestration. Cache variables store dynamic data from events (recent values, trigger counts, or external data) to enable complex…
-
Fetch Custom Incident Field by Id
Retrieves detailed information about a specific custom field associated with incidents in PagerDuty. This endpoint allows users to fetch the configuration and attributes of a custom field by providing its unique…
-
Fetch Escalation Polices List
Retrieves a list of escalation policies configured in the PagerDuty account. This endpoint allows users to access detailed information about how incidents are escalated within their organization, including the sequence…
-
Fetch Event Orchestrations
Retrieves a list of event orchestrations configured in the PagerDuty account. Event orchestrations are used to manage and automate the routing and handling of events and incidents. This endpoint allows you to fetch…
-
Fetch Incident Analytics by Id
Retrieves raw analytics data for a specific incident in PagerDuty. This endpoint provides unprocessed incident information, allowing for detailed analysis and custom reporting. It should be used when in-depth, granular…
-
Fetch Incident List
Retrieves a list of incidents from PagerDuty based on specified criteria. This endpoint allows users to fetch multiple incidents, making it useful for incident management, reporting, and analysis. It supports filtering…
-
Fetch Outlier Incident by Id
Retrieves detailed information about an outlier incident associated with a specific incident in PagerDuty. This endpoint is used to gather insights on incidents that deviate significantly from normal patterns, helping…
-
Fetch Post Update Status
Retrieves detailed information about a specific post update on a PagerDuty status page. This endpoint allows you to fetch the content and metadata of a particular update made to a post, providing insight into the…
-
Fetch Priorities List
Retrieves a list of existing priorities in the PagerDuty system, ordered from most severe to least severe. This endpoint should be used when you need to obtain information about the current priority levels configured…
-
Fetch Related Change Events for Incident
Retrieves change events correlated with a specific incident, along with the reasons for correlation. Change events represent service changes such as deploys, build completions, and configuration updates that may be…
-
Fetch Related Incidents by Id
Retrieves a list of incidents that are potentially related to a specified incident in PagerDuty. This endpoint utilizes machine learning algorithms to identify and return up to 20 recent incidents on other services…
-
Fetch Runner Teams Integration
Retrieves a list of teams associated with a specific Automation Action Runner in PagerDuty. This endpoint allows users to identify which teams have access to or are responsible for a particular runner, facilitating…
-
Fetch Status Pages
Retrieves a list of all status pages configured in the PagerDuty account. Status pages provide real-time information about the operational status of services, ongoing incidents, and planned maintenance. This endpoint…
-
Fetch User Contact Method
Retrieves detailed information about a specific contact method for a particular user in PagerDuty. This endpoint allows you to fetch the configuration and settings of a single contact method, such as an email address…
-
Fetch Vendor List
Retrieves a list of vendors or third-party integrations available in the PagerDuty platform. This endpoint allows users to access information about various services and tools that can be integrated with PagerDuty for…
-
Filter and Aggregate Incident Metrics
Analyzes and aggregates incident metrics across teams in PagerDuty, allowing for detailed filtering and customization of results. This endpoint is used to gain insights into incident patterns, team performance, and…
-
Get a Field Option on a Custom Field
Retrieves a specific field option from a custom field on an incident type. Field options represent the selectable values for multi-value or dropdown custom fields in PagerDuty. This action returns details about a…
-
Get Addons List
Retrieves a list of all addons associated with the PagerDuty account. This endpoint allows users to view the additional features or integrations that have been added to enhance the platform's capabilities. It provides…
-
Get Aggregated Pd Advance Usage Data
Provides aggregated metrics for the usage of PD Advance. <!-- theme: info --> > **Note:** Analytics data is updated [periodically](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule). It…
-
Get Alert Grouping Settings
Lists all alert grouping settings configured in your PagerDuty account. Alert grouping settings control how multiple related alerts are automatically combined into a single incident, reducing noise and improving…
-
Get Alerts by Incident Id
Retrieves all alerts associated with a specific incident in PagerDuty. Alerts are the raw events that triggered or contributed to an incident. This endpoint allows users to fetch detailed information about these…
-
Get an Incident Type
Get detailed information about a single incident type. Accepts either an incident type id, or an incident type name. Incident Types are a feature which will allow customers to categorize incidents, such as a security…
-
Get an Incident Type Custom Field
Get a custom field for an incident type. Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data, to provide additional context and support features such as customized…
-
Get Analytics Metrics Incidents All
Retrieves aggregated incident analytics data for all incidents in PagerDuty. Use when you need comprehensive incident metrics across teams, services, and escalation policies.
-
Get Analytics Metrics Users All
Get aggregated metrics for all users across the account. Returns user adoption and engagement metrics including mobile app downloads, escalation policy assignments, sign-up rates, and notification method configuration…
-
Get Analytics Raw Incidents Responses
Retrieves raw response data from a single incident in PagerDuty. Use this when you need detailed information about who was asked to respond to a specific incident and their response status.
-
Get Analytics Raw Users
Get raw user analytics data from PagerDuty. Use when you need detailed user activity and configuration metrics for analysis and reporting.
-
Get Audit Records
Retrieves a list of audit records from the PagerDuty system. This endpoint allows users to access logs of configuration changes made to PagerDuty resources, such as account objects. The records are sorted by execution…
-
Get Automation Action by Id
Retrieves detailed information about a specific automation action in PagerDuty's incident management platform. This endpoint allows users to fetch the configuration and attributes of a predefined automation action by…
-
Get Automation Action Runner by Id
Retrieves detailed information about a specific Automation Action Runner in PagerDuty. This endpoint allows users to fetch the configuration, status, and other relevant details of a Runner by providing its unique…
-
Get Automation Action Team by Team Id
Retrieves detailed information about a specific team's association with an automation action in PagerDuty. This endpoint returns the details of how a particular team is linked to an automation action, which is useful…
-
Get Automation Actions Runners
Lists all automation action runners in your PagerDuty account. Runners are the execution environments that perform automation actions during incident response. Each runner can be a Runbook Automation instance or a…
-
Get Business Service Subscribers by Id
Retrieves a list of subscribers for a specific business service in PagerDuty. This endpoint allows you to fetch all users or teams configured to receive notifications for incidents related to the specified business…
-
Get Business Services Impacts
List Business Services sorted by impacted status. Returns all business services in the account, sorted with impacted services first, followed by non-impacted services.
-
Get Business Services Priority Thresholds
Retrieves the current priority threshold settings for all business services in PagerDuty. This endpoint allows users to fetch the configured thresholds that determine incident prioritization and escalation for each…
-
Get Cache Variable by Id
Retrieves detailed information about a specific cache variable associated with a particular service within an event orchestration in PagerDuty. This endpoint allows you to access the current state and configuration of…
-
Get Cache Variables for Service
Lists all cache variables configured for a Service Event Orchestration. Cache variables store dynamic event data that can be used in service-level routing and automation workflows. Returns detailed configurations…
-
Get Enablements for a Service
Retrieves feature enablement settings for a specific PagerDuty service. Use this to check which features are enabled or disabled for a service, such as alert grouping or auto-pause notifications. This is useful when…
-
Get Escalation Policy by Id
Retrieves detailed information about a specific escalation policy in PagerDuty. This endpoint allows you to fetch the complete configuration of an escalation policy, including its name, description, escalation rules…
-
Get Event Integrations by Id
Retrieves a list of integrations associated with a specific event orchestration in PagerDuty. This endpoint allows users to fetch all the integrations that are configured for a particular event orchestration, providing…
-
Get Event Orchestration by Id
Retrieves detailed information about a specific event orchestration in PagerDuty using its unique identifier. This endpoint allows users to fetch the configuration and settings of a particular event orchestration…
-
Get Event Orchestration Global
Get the Global Orchestration configuration for an Event Orchestration. Returns the global-level routing rules and configurations that process all events sent to this orchestration before they reach service-specific…
-
Get Event Orchestration Integration
Retrieves detailed information about a specific integration associated with an event orchestration in PagerDuty. This endpoint allows you to fetch the configuration and settings of a particular integration within the…
-
Get Extension Schema by Id
Retrieves a specific extension schema from PagerDuty by its unique identifier. Extension schemas are pre-defined templates that define how PagerDuty integrates with external systems (like webhooks, Slack, Amazon…
-
Get Impact by Status Page Id
Retrieves detailed information about a specific impact level configuration on a PagerDuty status page. Impacts are predefined severity descriptors (such as 'Minor', 'Major', or 'Critical') that describe how business…
-
Get Incident Alert Details
Retrieves detailed information about a specific alert associated with a particular incident in PagerDuty. This endpoint is used when you need to access the properties and current state of an individual alert within the…
-
Get Incident Log Entries by Id
Retrieves all log entries associated with a specific incident in PagerDuty. This endpoint provides a comprehensive history of actions, notifications, and status changes related to the incident. It should be used when…
-
Get Incident Workflow Action by Id
Retrieves detailed information about a specific incident workflow action by its ID. An incident workflow action is a reusable automation step that can be used in incident workflows. This endpoint returns the action's…
-
Get Incident Workflow Trigger
Retrieves details of a specific incident workflow trigger by ID. Incident workflow triggers define when and how workflows are activated - either automatically based on conditions (conditional), manually by responders…
-
Get Incident Workflows
Lists all incident workflows configured in your PagerDuty account. Incident workflows are automated sequences of actions that execute during incident response to streamline processes like notifications, status updates…
-
Get Incident Workflows Actions
Retrieves a list of all available actions that can be used in incident workflows within PagerDuty. This endpoint provides information about the various automated tasks and responses that can be configured to streamline…
-
Get Jira Cloud Account Mappings
Lists all account mappings between PagerDuty and Jira Cloud instances. Use this to retrieve the integration mappings that link PagerDuty accounts (by subdomain) to Jira Cloud instances (by base URL). This is useful for…
-
Get Log Entries
Retrieves log entries from the PagerDuty system, providing a detailed history of events and actions related to incidents and system activities. This endpoint is crucial for auditing purposes, allowing users to track…
-
Get Maintenance Window by Id
Retrieves detailed information about a specific maintenance window in PagerDuty. This endpoint allows users to access the configuration, schedule, and status of a particular maintenance window using its unique…
-
Get Paused Incident Alerts
Retrieves the most recent paused incident alerts from PagerDuty for a specified reporting period. This endpoint returns up to 5 of the most recent alerts that were triggered after being paused, and up to 5 of the most…
-
Get Post From Status Page by Id
Retrieves detailed information about a specific post on a PagerDuty status page. This endpoint allows you to fetch the content, timestamp, and any associated metadata for a particular update or message that has been…
-
Get Rule From Ruleset by Id
Retrieves detailed information about a specific rule within a PagerDuty ruleset. This endpoint allows users to fetch the configuration and settings of an individual rule, which is essential for understanding how…
-
Get Schedules
Retrieves a list of all schedules from your PagerDuty account. This endpoint provides essential information about on-call rotations, helping teams manage and organize their incident response workflows. Use this when…
-
Get SCIM Resource Types
Get SCIM resource types supported by PagerDuty's SCIM service provider. Returns metadata about available resource types (User, Group) including their endpoints, schemas, and names. Use this to discover which SCIM…
-
Get SCIM Schema by ID
Retrieves an individual SCIM schema definition by its unique identifier (ID). Returns the complete schema structure including all attribute definitions, data types, constraints, and metadata. Use this to understand the…
-
Get SCIM Service Provider Config
Retrieves the SCIM 2.0 Service Provider Configuration for PagerDuty. This endpoint returns the capabilities and features supported by PagerDuty's SCIM implementation, including support for PATCH, bulk operations…
-
Get SCIM User
Retrieves detailed information about a specific user from PagerDuty's SCIM directory. Use this action when you need to fetch user profile information including display name, email, role, active status, job title…
-
Get Service Custom Field Values
Retrieves the custom field values for a specific PagerDuty service. Use this when you need to fetch custom metadata or additional structured information associated with a service. Custom fields allow organizations to…
-
Get Service Impacts by Url Slug
Retrieves service impacts for a specific status dashboard in PagerDuty. This endpoint allows users to fetch real-time information about how incidents or maintenance activities are affecting services displayed on a…
-
Get Severity for Status Page
Retrieves detailed information about a specific severity level on a particular status page in PagerDuty. This endpoint is used to fetch the configuration and metadata associated with a severity, which is crucial for…
-
Get Specific Post Update Status
Retrieves the updates for a specific post on a PagerDuty status page. This endpoint allows users to fetch the chronological list of updates made to a particular post, providing detailed information about how the status…
-
Get Status Dashboard by Id
Retrieves detailed information about a specific status dashboard in PagerDuty. Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services. This…
-
Get Status for Status Page by Id
Retrieves the current status of a specific item on a PagerDuty status page. This endpoint is used to fetch up-to-date information about the operational state of a particular service or component listed on a status…
-
Get Status Page Impacts by Id
Retrieves the list of impact level configurations available for a specific status page in PagerDuty. Impact levels are predefined severity descriptors (such as 'Minor', 'Major', 'Critical', or 'All Good') that describe…
-
Get Status Page Subscription
Retrieves detailed information about a specific subscription associated with a particular status page in PagerDuty. This endpoint allows users to fetch subscription details such as the subscriber's contact information…
-
Get Tags by Entity Type
Retrieves all entities of a specific type that are associated with a given tag. Use this when you need to find all users, teams, or escalation policies that have been tagged with a particular tag. The response will…
-
Get Team Members by Id
Retrieves a list of all members associated with a specific team in PagerDuty. This endpoint is useful for obtaining detailed information about the composition of a team, including user IDs, names, roles, and contact…
-
Get Team Notification Subscriptions
Retrieves the notification subscriptions for a specific team in PagerDuty. This endpoint allows you to fetch detailed information about how a team is configured to receive notifications for various events and…
-
Get Teams Associated with Action Id
Retrieves the list of teams associated with a specific automation action in PagerDuty. This endpoint is useful for understanding which teams are responsible for or have access to a particular automated process in the…
-
Get Template by Id
Retrieves detailed information about a specific template in PagerDuty by its unique identifier. This endpoint is used to access the configuration and settings of a pre-defined template, which can include incident…
-
Get the Service Orchestration for a Service
Get a Service Orchestration. A Service Orchestration allows you to create a set of Event Rules. The Service Orchestration evaluates Events sent to this Service against each of its rules, beginning with the rules in the…
-
Get User Notification Subscriptions
Lists notification subscriptions for a specific PagerDuty user. Returns subscriptions to various entities like business services and incidents that the user has subscribed to for receiving notifications. Use this to…
-
Get User Session by Type
Retrieves detailed information about a specific user session in PagerDuty. This endpoint allows you to fetch session-related data for a particular user, filtered by session type and identified by a unique session ID…
-
Get User Sessions by Id
Retrieves all active sessions for a specific user in PagerDuty. This endpoint allows you to fetch information about a user's current login sessions, which can be useful for auditing, security monitoring, or managing…
-
Get User Status Update Notification Rules
Retrieves all status update notification rules for a specific user in PagerDuty. Returns a list of all notification rules that determine how the user receives notifications about incident status updates. Each rule…
-
Get Webhook Subscription by Id
Retrieves detailed information about a specific webhook subscription in PagerDuty. This endpoint allows you to fetch the configuration and status of a webhook subscription, including its delivery method, subscribed…
-
Get Workflow Integration
Get details about a Workflow Integration. Scoped OAuth requires: `workflow_integrations.read`
-
Get Workflow Integration Connection
Get details about a Workflow Integration Connection. Scoped OAuth requires: `workflow_integrations:connections.read`
-
Install Add on Endpoint
This endpoint allows you to install a new add-on to your PagerDuty account, enhancing its functionality with custom integrations. Add-ons can be either full-page or incident-specific, providing additional context or…
-
Invoke Automation Action by ID
Invokes a specific automation action in PagerDuty, associating it with a particular incident. This endpoint allows you to trigger pre-defined automated tasks or workflows within the PagerDuty incident management…
-
List All Workflow Integration Connections
List all Workflow Integration Connections. Scoped OAuth requires: `workflow_integrations:connections.read`
-
List Automation Action Details
This endpoint retrieves a list of automation actions configured in the PagerDuty account. Automation actions are predefined tasks or operations that can be executed automatically in response to incidents or other…
-
List Cache Variables for Event Orchestration
Lists all cache variables configured for a specific Global Event Orchestration. Cache variables store dynamic data extracted from events, enabling complex routing rules and automation workflows based on event history…
-
List Extension Schemas
Retrieves all available extension schemas from the PagerDuty API. This endpoint allows users to fetch custom schema extensions that have been defined for their PagerDuty account. Extension schemas are used to add…
-
List Field Options on a Custom Field
Lists all field options for a custom field on an incident type. Field options represent the selectable values for multi-value or dropdown custom fields in PagerDuty. This action returns all available options that users…
-
List Incident Status Update Subscribers
Retrieves a list of subscribers to status updates for a specific incident in PagerDuty. This endpoint allows you to see all users or services that are currently subscribed to receive notifications about status changes…
-
List Incident Type Custom Fields
List the custom fields for an incident type. Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data, to provide additional context and support features such as…
-
List Incident Types
List the available incident types Incident Types are a feature which will allow customers to categorize incidents, such as a security incident, a major incident, or a fraud incident. These can be filtered by enabled or…
-
List Licenses
Lists all licenses for the PagerDuty account, showing current usage and available allocations. This endpoint retrieves license information including: - License name and type (e.g., "Enterprise Incident Management (Full…
-
List SCIM Schemas
Retrieves all SCIM schemas supported by the PagerDuty service provider. Returns a list of schema definitions including User, Group, and Enterprise User Extension schemas with their complete attribute structures, data…
-
List SCIM Users
Lists users via the SCIM (System for Cross-domain Identity Management) API endpoint. Use when you need to retrieve user information in SCIM format, typically for identity provider integrations or user provisioning…
-
List Service Custom Fields
Lists all custom fields available for services in PagerDuty. This endpoint returns a list of custom fields that can be used to add structured metadata to services. Custom fields allow teams to categorize and organize…
-
List Supporting Service Impacts
Retrieves information about the impacts of supporting services on a specific business service in PagerDuty. This endpoint is used to understand the relationships and dependencies between a primary business service and…
-
List Templates
Retrieves a list of templates available in the PagerDuty system. Templates are pre-defined configurations used for creating alerts, notifications, and other automated processes within PagerDuty. This endpoint should be…
-
List Workflow Integration Connections
List all workflow integration connections for a specific workflow integration. Workflow integration connections represent configured instances of external tools (like AWS, Slack, HTTP APIs) that can be used in incident…
-
List Workflow Integrations
List available Workflow Integrations. Scoped OAuth requires: `workflow_integrations.read`
-
Manage Cache Variables for Event Service
Creates a cache variable for a service event orchestration. Cache variables store temporary event data for use in orchestration rules. Requires Advanced Event Orchestration tier and Manager role. Configuration types: -…
-
Merge Source Incidents Into Target Incident
Merges multiple source incidents into a target incident in PagerDuty's incident management system. This endpoint allows users to consolidate related or duplicate incidents into a single, primary incident for…
-
Migrate Integration Between Orchestrations
This endpoint facilitates the migration of an integration from one event orchestration to another within PagerDuty. It allows users to reassign an existing integration to a different event orchestration, maintaining…
-
Modify Entity Tags
Add and/or remove tags from a PagerDuty entity (user, team, or escalation policy) in a single operation. This action modifies the tags associated with a specific entity. You can: - Add tags by label (creates new tags…
-
Ping Webhook Subscription
The PingWebhookSubscription endpoint sends a test POST request to a specified webhook subscription in your PagerDuty account. This tool is used to verify that a webhook subscription is correctly configured and can…
-
Post Account Subscription for Business Service
This endpoint creates or updates an account subscription for a specific business service in PagerDuty. It allows users to manage subscription settings, such as notification preferences or service-level agreements, for…
-
Post Alert Grouping Settings
Creates a new Alert Grouping Setting in PagerDuty, defining how alerts will be automatically grouped into incidents based on specified configurations. This endpoint allows users to set up intelligent alert grouping…
-
Post Analytic Metrics on Escalation Policies
Retrieves and aggregates analytics metrics for incidents related to escalation policies in PagerDuty. This endpoint allows for detailed filtering and customization of incident data, enabling users to analyze trends…
-
Post Analytics Metrics Responder Filters
The AnalyzeResponderMetrics endpoint aggregates and analyzes responder performance metrics for PagerDuty incidents. It provides insights into response times, efficiency, and workload distribution. This tool is ideal…
-
Post Event Orchestration Cache Variables
Creates a new cache variable within a PagerDuty event orchestration. This endpoint allows you to define a cache variable that can store dynamic data related to events, either based on recent values extracted from event…
-
Post Incident Metrics
Retrieve analytics metrics for responders and teams including incident counts, response times, on-call hours, interruptions, escalations, and engagement statistics. Returns metrics like total incidents, mean time to…
-
Post Incident Metrics with Filters
This endpoint retrieves and aggregates analytics metrics for incidents across all teams in PagerDuty. It allows users to apply various filters and parameters to analyze incident data, such as creation date range…
-
Post Incident Note Using Id
Adds a new note to an existing incident in PagerDuty. This endpoint allows users to append additional information, updates, or comments to a specific incident identified by its unique ID. It's particularly useful for…
-
Post Incident Status Update
Posts a status update for a specific incident in PagerDuty. This endpoint allows you to add new information or progress reports to an ongoing incident, keeping stakeholders informed about the current state of the…
-
Post Incidents Analytics with Filters
The AnalyzeRawIncidents endpoint retrieves and analyzes raw incident data from PagerDuty. It allows users to fetch detailed information about incidents with various filtering options. This endpoint is useful for…
-
Post Incidents Metrics Filtered by Service
The AnalyzeIncidentMetrics endpoint aggregates and analyzes incident data for PagerDuty services based on specified filters and parameters. It allows users to generate detailed reports and insights on incident…
-
Post Responder Incidents with Filters
Retrieves a list of incidents associated with a specific responder in the PagerDuty incident management system. This endpoint allows for detailed filtering and pagination of incident data, making it ideal for analyzing…
-
Post Service Automation Action
This endpoint adds a service to an existing automation action in PagerDuty. It allows users to associate a specific service with an automation action, enabling the action to be applied to incidents or events related to…
-
Post Team Notification Subscription
Creates notification subscriptions for a specific team in PagerDuty. This endpoint allows you to subscribe a team to receive notifications for one or more incidents or business services. Use this when you want to…
-
Post Team to Runner
This endpoint adds a team to an Automation Action Runner in PagerDuty. It allows you to associate a specific team with a runner, enabling better organization and management of automation processes within your incident…
-
Preview Schedule Object
The preview_schedule endpoint allows you to simulate and visualize a PagerDuty schedule configuration before actually creating or updating it. This tool is essential for validating complex on-call rotations, ensuring…
-
Render Template for Incident
Renders a specific template for a given incident in PagerDuty. This endpoint allows you to generate a formatted report or message based on a pre-defined template and the provided incident information. It's particularly…
-
Retrieve Abilities List
Retrieves a list of abilities or capabilities available in the PagerDuty system. This endpoint allows users to query and understand the features and functionalities they can access or perform within PagerDuty. It's…
-
Retrieve Action Services by Id
Retrieves a list of services associated with a specific automation action in PagerDuty. This endpoint allows users to fetch all services that are linked to a particular automation action, providing insights into which…
-
Retrieve Addon by Id
Retrieves detailed information about a specific addon installed on a PagerDuty account. This endpoint allows users to fetch the current configuration, status, and other relevant details of an addon without modifying…
-
Retrieve Alert Grouping Settings by Id
Retrieves the alert grouping settings for a specific configuration identified by its unique ID in PagerDuty. This endpoint allows users to access detailed information about how alerts are grouped for a particular…
-
Retrieve Automation Action Invocation by Id
Retrieves detailed information about a specific automation action invocation in PagerDuty. This endpoint allows you to fetch the current state, results, and metadata of a previously executed automation action. It's…
-
Retrieve Automation Action Invocations
Retrieves a list of automation action invocations from the PagerDuty incident management platform. This endpoint allows users to query and review the history of automated actions that have been executed within their…
-
Retrieve Automation Action Runner Teams
Retrieves detailed information about a specific team association with an Automation Actions runner in PagerDuty. This endpoint confirms whether a particular team has access to a given runner and returns the team's…
-
Retrieve Automation Service Action
Retrieves detailed information about the association between a specific automation action and a service in PagerDuty. This endpoint returns both the automation action details (including ID, name, type, and…
-
Retrieve Business Service by Id
Retrieves detailed information about a specific business service by its ID. Returns the business service's name, description, point of contact, associated team, and other metadata. Use this when you need to view or…
-
Retrieve Business Service Dependencies
Retrieves the service dependencies for a specific business service in PagerDuty. This endpoint allows you to fetch a list of services that are dependent on or related to the specified business service, helping to…
-
Retrieve Business Service Impactors
Retrieves impactors (typically incidents) currently affecting business services. Use this to monitor which incidents are impacting services, identify cascading failures, and prioritize incident response based on…
-
Retrieve Business Service Impacts
Retrieves a list of business services impacted by a specific PagerDuty incident. This helps assess the broader business impact and identify which business stakeholders need to be notified during incident response. Use…
-
Retrieve Business Services
Retrieve a list of business services from your PagerDuty account. Business services represent the high-level business capabilities that your technical services support. They provide a business-oriented view of your…
-
Retrieve Change Event by Id
Retrieves detailed information about a specific change event by its unique ID. Change events represent deployments, configuration changes, infrastructure updates, or other system modifications that are tracked for…
-
Retrieve Change Event Information
Retrieves change events from PagerDuty. Change events track deployments, configuration changes, and infrastructure updates in your external systems. They provide context for incident correlation by showing what changed…
-
Retrieve Current User Info
Retrieves the profile information of the currently authenticated user in the PagerDuty system. This endpoint provides access to personal details, settings, and account information associated with the user making the…
-
Retrieve Entity Tags by Id
Retrieves the tags associated with a specific entity in the PagerDuty system. This endpoint allows you to fetch all tags that have been assigned to a particular resource. Supported entity types are users, teams, and…
-
Retrieve Event Orchestration Router by Id
Retrieves the router configuration for a specific event orchestration in PagerDuty. This endpoint allows you to fetch detailed information about how incidents and events are routed within a particular event…
-
Retrieve Extension by Id
Retrieves detailed information about a specific extension in PagerDuty. This endpoint allows users to fetch the configuration and status of an individual extension by providing its unique identifier. It is particularly…
-
Retrieve Extension List
Retrieves a paginated list of extensions associated with the authenticated PagerDuty account. Extensions are integrations that enhance PagerDuty's functionality, such as webhooks, custom notification methods, or…
-
Retrieve Incident by Incident Id
Retrieves detailed information about a specific incident in PagerDuty using its unique identifier. This endpoint allows users to access comprehensive data about an individual incident, including its current status…
-
Retrieve Incident Custom Field Values
Retrieves the custom field values associated with a specific incident in PagerDuty. This endpoint allows users to access additional metadata that has been added to an incident, providing more context and enabling…
-
Retrieve Incident Custom Fields
Retrieves a list of custom fields associated with incidents in PagerDuty. Custom fields are additional data points that can be added to incidents to provide more detailed information tailored to specific organizational…
-
Retrieve Incident Field Options
Retrieves the available field options for a specific custom incident field in PagerDuty. This action returns the predefined set of values that can be assigned to a multi-value or dropdown custom field. Field options…
-
Retrieve Incident Workflow by Id
Retrieves detailed information about a specific incident workflow in PagerDuty. This endpoint allows users to fetch the configuration, steps, and other relevant details of an incident workflow based on its unique…
-
Retrieve Incident Workflow Triggers
Retrieves a list of triggers associated with incident workflows in PagerDuty. This endpoint allows you to fetch information about the conditions or events that initiate automated incident response processes. Use this…
-
Retrieve Integration by Service Id
Retrieves detailed information about a specific integration associated with a particular service in PagerDuty. This endpoint allows you to fetch the configuration and status of an integration, which can be crucial for…
-
Retrieve License Allocations
Retrieves the current license allocations for the PagerDuty account, showing which users have been allocated which licenses. Use this endpoint to audit license usage, track license distribution, or manage license…
-
Retrieve List of Services
Retrieves a list of services configured in the PagerDuty account. This endpoint allows you to fetch details about various services set up for incident management and alerting. It's particularly useful for getting an…
-
Retrieve Log Entry by Id
Retrieves detailed information about a specific log entry in the PagerDuty system. This endpoint is used to access the complete record of an event or action that occurred within PagerDuty, such as incident updates…
-
Retrieve Maintenance Windows
Retrieves a list of maintenance windows from the PagerDuty incident management platform. Maintenance windows are scheduled periods during which alerts and notifications for specified services are suppressed to allow…
-
Retrieve Notes for Incident
Retrieves all notes associated with a specific incident in PagerDuty. This endpoint allows users to access the complete history of comments, updates, and additional information added to an incident throughout its…
-
Retrieve Notifications
Retrieves a list of notifications sent to users in PagerDuty within a specified date range. This endpoint returns notifications that were delivered via email, SMS, phone, or push notifications for incidents, alerts…
-
Retrieve Oncall Handoff Notification Rule
Retrieves detailed information about a specific on-call handoff notification rule for a given user in PagerDuty. This endpoint is crucial for managing and reviewing the notification settings that govern how users are…
-
Retrieve Oncall Handoff Notification Rules
Retrieves the on-call handoff notification rules for a specific user in PagerDuty. This endpoint allows you to fetch the configured rules that determine how and when a user is notified about on-call schedule…
-
Retrieve Oncall List
Retrieves the current on-call information for your PagerDuty account. This endpoint provides a comprehensive view of who is currently on-call across various schedules and escalation policies. It's particularly useful…
-
Retrieve Past Incidents
Retrieves a list of past similar incidents for a specific incident using machine learning. This endpoint uses PagerDuty's AIOps-powered Past Incidents feature to find historical incidents from the same service that are…
-
Retrieve Postmortem by Id
Retrieves the postmortem analysis for a specific post on a PagerDuty status page. This endpoint allows users to access detailed information about an incident after it has been resolved, including root cause analysis…
-
Retrieve Rule by Service Id
Retrieves a specific service event rule by ID from a PagerDuty service. Service Event Rules configure how incoming events are processed, including setting severity and priority based on conditions. **Important:** This…
-
Retrieve Rules for Service Id
Retrieves all rules associated with a specific PagerDuty service. This endpoint allows users to fetch the set of rules that define when and how incidents are triggered for a particular service. It's essential for…
-
Retrieve Rules From Ruleset by Id
Retrieves a list of event rules associated with a specific ruleset in PagerDuty. **Note**: Rulesets reached end-of-life on January 31, 2025 and are no longer visible in the PagerDuty web app. However, read-only API…
-
Retrieve Ruleset by Id
Retrieves detailed information about a specific ruleset in PagerDuty using its unique identifier. This endpoint allows you to fetch the complete configuration and settings of a single ruleset, which is essential for…
-
Retrieve Ruleset List
Retrieves a list of rulesets from the PagerDuty system. Rulesets are collections of event rules that define how incidents are managed and alerts are configured. This endpoint allows you to view all available rulesets…
-
Retrieve Schedule Audit Records by Id
Retrieves the audit records for a specific PagerDuty schedule. This endpoint allows you to access a comprehensive log of all changes made to the specified schedule, including modifications to on-call rotations, time…
-
Retrieve Schedule by Id
Retrieves detailed information about a specific schedule in PagerDuty using its unique identifier. This endpoint is essential for viewing the configuration of an existing on-call schedule, including its name, time…
-
Retrieve Schedule Override by Id
Lists all schedule overrides for a specific schedule within a date range. Schedule overrides are temporary modifications to the regular on-call rotation, allowing you to assign different users for specific time periods…
-
Retrieve Service Audit Records by Id
Retrieves the audit records for a specific PagerDuty service. This endpoint allows you to fetch a historical log of all configuration changes made to the service, providing transparency and accountability in incident…
-
Retrieve Service by Id
Retrieves detailed information about a specific PagerDuty service using its unique identifier. This endpoint allows users to access configuration details, integration settings, and other relevant information for a…
-
Retrieve Service Change Events by Id
Retrieves change events associated with a specific PagerDuty service. This endpoint allows you to fetch informational updates about recent changes such as code deploys, system configuration modifications, and other…
-
Retrieve Service Impacts From Status Dashboards
Retrieves the service impacts associated with a specific status dashboard in PagerDuty. This endpoint allows users to fetch detailed information about how incidents are affecting various services within the context of…
-
Retrieve Service Status by Id
Retrieves a list of services associated with a specific status page in PagerDuty. This endpoint fetches all services that are being monitored and displayed on a particular status page. Status pages provide real-time…
-
Retrieve Service Status Page
Retrieves detailed information about a specific service associated with a particular status page in PagerDuty. This endpoint is used to fetch the current status, configuration, and other relevant details of a service…
-
Retrieve Standards List
Retrieves the current set of Service Standards defined in the PagerDuty account. Service Standards are configurable criteria that help organizations define, share, and track service configuration best practices. These…
-
Retrieve Standards Scores by Resource Type and Id
Retrieves the standards scores for a specific technical service in PagerDuty. Returns a detailed evaluation showing which PagerDuty best practices and standards the service meets, including whether it has proper…
-
Retrieve Standards Scores by Resourcetype
Retrieves the standards scores for a specified resource type in PagerDuty. This endpoint allows users to access performance metrics and evaluations based on predefined standards for different components of their…
-
Retrieve Status Dashboard by Slug
Retrieves detailed information about a specific PagerDuty status dashboard using its URL slug. This endpoint allows users to fetch the current state, components, and other relevant data associated with a particular…
-
Retrieve Status Dashboards Information
Retrieves a list of status dashboards and their associated information from the PagerDuty system. This endpoint provides a comprehensive overview of the current operational status, performance metrics, and health…
-
Retrieve Status Page Post
Retrieves all posts associated with a specific status page in PagerDuty. This endpoint allows you to fetch updates, messages, and status information that have been posted to a particular status page. Use this to…
-
Retrieve Status Page Severities by Id
Retrieves the list of severities associated with a specific status page in PagerDuty. This endpoint allows users to fetch the current severity levels configured for a particular status page, which is crucial for…
-
Retrieve Status Page Subscription by Id
Retrieves a list of subscriptions associated with a specific PagerDuty status page. This endpoint allows users to fetch all current subscriptions for a given status page, enabling them to monitor who is receiving…
-
Retrieve Status Pages Status
Retrieves the current statuses for a specified PagerDuty status page. This endpoint allows users to fetch real-time status information for a given status page, providing up-to-date details on service availability and…
-
Retrieve Tag by Id
Retrieves detailed information about a specific tag in the PagerDuty system using its unique identifier. This endpoint allows users to fetch the properties and metadata associated with a particular tag, which can be…
-
Retrieve Tags
Retrieves a list of tags from your PagerDuty account with optional filtering and pagination. Tags are used to categorize and label entities such as teams, users, and escalation policies in PagerDuty. This endpoint is…
-
Retrieve Team Audit Records
Retrieves the audit records for a specific team in PagerDuty. This endpoint allows users to access a detailed history of configuration changes made to the team, including modifications to team members, escalation…
-
Retrieve Team Details by Id
Retrieves detailed information about a specific team in PagerDuty based on the provided team ID. This endpoint allows users to fetch comprehensive data about a team, including its members, roles, and configurations. It…
-
Retrieve Team List
The ListTeams endpoint retrieves a list of teams within a PagerDuty account. It provides an overview of all teams or a filtered subset based on the optional query parameter. This endpoint is useful for obtaining team…
-
Retrieve Technical Service Details
Retrieves detailed information about a specific technical service and its dependencies within the PagerDuty incident management platform. This endpoint is used to fetch comprehensive data about a single technical…
-
Retrieve Template Fields
Retrieves the available field definitions for PagerDuty status update templates. This endpoint returns metadata about the fields that can be used when creating or modifying templates within the PagerDuty platform…
-
Retrieve Unrouted Event Orchestration by Id
Retrieves the unrouted orchestration configuration for a specific Event Orchestration in PagerDuty. The unrouted orchestration defines how events that don't match any routing rules are handled - they can be suppressed…
-
Retrieve User Audit Records by Id
Retrieves the audit records for a specific user in the PagerDuty system. This endpoint allows you to access a historical log of activities and changes associated with the user, providing valuable insights for…
-
Retrieve User by Id
Retrieves detailed information about a specific PagerDuty user by their ID. Returns user profile data including name, email, role, timezone, and other account details. Use the 'include' parameter to optionally fetch…
-
Retrieve User Contact Methods via Id
Retrieves all contact methods associated with a specific user in PagerDuty. This endpoint allows you to fetch the various ways a user can be contacted during an incident, such as email addresses, phone numbers, or push…
-
Retrieve User License Information
Retrieves the license information for a specific user in the PagerDuty system. This endpoint allows you to check the current licensing status, type, and any associated details for a given user. It should be used when…
-
Retrieve User Notification Rule
Retrieves a specific notification rule for a given user in PagerDuty. This endpoint allows you to fetch detailed information about how and when a particular user receives alerts and notifications. It's useful for…
-
Retrieve User Notification Rules
Retrieves the notification rules for a specific user in PagerDuty. This endpoint allows you to fetch all configured notification rules associated with a given user, providing insight into how and when the user receives…
-
Retrieve User Status Update Notification Rule
Retrieves a specific status update notification rule for a given user in PagerDuty. This endpoint allows you to fetch detailed information about how and when a particular user receives notifications for status updates…
-
Retrieve Users by Schedule Id
Retrieves a list of users associated with a specific PagerDuty schedule. This endpoint is essential for managing on-call rotations and understanding who is responsible for incident response during different time…
-
Retrieve Users List
Retrieves a list of users from the PagerDuty system. This endpoint allows you to fetch information about multiple users in your PagerDuty account, which can be useful for user management, generating reports, or…
-
Retrieve Vendor by Id
Get detailed information about a specific PagerDuty vendor integration by its ID. Returns vendor details including name, description, integration type, logo URLs, documentation links, and connection capabilities. Use…
-
Retrieve Webhook Subscriptions
Retrieves a list of all webhook subscriptions associated with the authenticated PagerDuty account. This endpoint allows users to view and manage their existing webhook configurations, which are used to receive…
-
Send Change Event to PagerDuty
Send a change event to PagerDuty to track deployments, configuration changes, or other significant system modifications. Change events do not create incidents or notifications but provide valuable context for incident…
-
Send MCP Request
Tool to send JSON-RPC requests to PagerDuty's Model Context Protocol (MCP) endpoint. Use when you need to interact with MCP servers for tool execution, resource management, or prompt operations.
-
Send Responder Requests for Incidents
Send responder requests to users or escalation policies for a PagerDuty incident. Use this action to request additional help for an ongoing incident by notifying specific users or escalation policies. This is useful…
-
Set Business Service Impact Status
This endpoint updates the impact status of a specific incident on a particular business service in PagerDuty. It allows you to either set a business service as impacted by an incident or remove the impact, which in…
-
Set Global Priority Threshold
Sets the global Priority Threshold for Business Services in PagerDuty, determining which incidents can impact these services based on their priority level. This endpoint allows you to configure the minimum incident…
-
Snooze Incident by Duration
Snooze an acknowledged incident in PagerDuty for a specified duration. This temporarily suppresses notifications for the incident, automatically returning it to the "triggered" state when the snooze period expires. The…
-
Subscribe Entities to Business Services
This endpoint allows you to subscribe users or teams to a specific business service in PagerDuty. It enables you to add multiple subscribers in a single request, streamlining the process of setting up notification…
-
Subscribe Entities to Incident Status Updates
Subscribes specified users or teams to receive status updates for a particular incident in PagerDuty. This endpoint allows you to add multiple subscribers at once, ensuring that relevant parties are kept informed about…
-
Subscribe to User Notifications
Creates notification subscriptions for a specific user in PagerDuty. This endpoint allows you to subscribe a user to multiple incidents or business services in a single API call. It's particularly useful for setting up…
-
Test Ability Availability by ID
Tests whether a specific ability (feature capability) is available to your PagerDuty account using its unique identifier. This endpoint checks if a particular feature, such as 'urgencies', 'manage_schedules', or…
-
Unsubscribe Business Service Entity
This endpoint unsubscribes specified users or teams from receiving notifications for a particular business service in PagerDuty. It allows bulk unsubscription of multiple entities in a single API call. The endpoint…
-
Unsubscribe From Incident Status Updates
Unsubscribes specified users or teams from receiving status updates for a particular incident in PagerDuty. This endpoint is used when certain entities no longer need to be notified about changes to an incident's…
-
Unsubscribe Team Notification Subscriptions
Unsubscribes a team from notifications for specific incidents or business services in PagerDuty. This endpoint is used to stop a team from receiving alerts and updates about particular entities. It's particularly…
-
Unsubscribe User Notification Subscriptions
This endpoint allows unsubscribing a user from notifications for specific incidents or business services in PagerDuty. It's used to modify a user's notification preferences, removing them from receiving updates about…
-
Update a Custom Field for an Incident Type
Update a custom field for an incident type. Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data, to provide additional context and support features such as…
-
Update Add on by Id
Updates an existing Add-on in PagerDuty with new properties. This endpoint allows you to modify the type, name, and source URL of a specific Add-on identified by its unique ID. It's used when you need to change the…
-
Update Alert Grouping Settings Byid
Update an existing Alert Grouping Setting in PagerDuty by its ID. Alert Grouping Settings control how alerts are automatically grouped into incidents, reducing noise and streamlining incident management. This endpoint…
-
Update Alert in Incident
Updates the status of a specific alert within an incident in PagerDuty. This endpoint allows you to modify an alert's status, primarily to mark it as resolved. It's crucial for managing the lifecycle of alerts and…
-
Update an Incident Type
Update an Incident Type. Incident Types are a feature which will allow customers to categorize incidents, such as a security incident, a major incident, or a fraud incident. <!-- theme: warning --> > ### Early Access >…
-
Update Automation Runner Info
This endpoint allows you to update an existing Automation Action Runner in PagerDuty. It is used to modify the properties of a runner, such as its name, description, and, for runbook runners, the runbook server…
-
Update Business Service by Id
This endpoint allows you to update an existing Business Service in PagerDuty. It is used to modify the details of a specific service, such as its name, description, point of contact, or the team responsible for it…
-
Update Change Event by ID
Update an existing change event in PagerDuty by its unique ID. Modify summary, source, custom_details, or links for change events tracking deployments, configuration changes, or system modifications. **Updatable…
-
Update Custom Field Display Name
Updates an existing custom field for incidents in PagerDuty. This endpoint allows you to modify the display name, description, and default value of a custom field identified by its unique field_id. Use this action when…
-
Update Custom Field Option
Updates a field option for a custom field on an incident type in PagerDuty. Field options represent the selectable values for multi-value or dropdown custom fields. Use this action to modify the display value or data…
-
Update Escalation Policy by Id
Updates an existing escalation policy in PagerDuty with new settings and rules. This endpoint allows you to modify various aspects of an escalation policy, including its name, description, escalation rules, associated…
-
Update Escalation Policy for Team
Associates an escalation policy with a team in PagerDuty. This creates or updates the link between a team and an escalation policy, enabling the team to use that policy for incident management. When an escalation…
-
Update Event Orchestration by Id
Updates an existing Event Orchestration in PagerDuty. This endpoint allows you to modify the name, description, and team ownership of a specific Orchestration identified by its ID. It's used to refine and adjust your…
-
Update Event Orchestration Cache Variable
This endpoint updates a cache variable associated with a specific service in PagerDuty's event orchestrations. It allows you to modify the cache variable's name, configuration, conditions, and disabled state. Use this…
-
Update Event Rule by Id
This endpoint allows you to update an existing Event Rule within a specified Ruleset in PagerDuty. Event Rules define conditions for matching events and actions to take when those conditions are met. You can modify…
-
Update Event Rule for Service
This endpoint allows you to update an existing Event Rule for a specific service in PagerDuty. Event Rules are used to define how incoming events should be processed, including conditions for matching events and…
-
Update Extension by Id
Updates an existing extension in PagerDuty. This endpoint allows you to modify the configuration of a previously created extension, such as a webhook or custom integration. You can update properties like the…
-
Update Incident Alerts
This endpoint allows you to update the status of multiple alerts associated with a specific incident in PagerDuty. It is particularly useful for bulk operations when you need to resolve or update the status of several…
-
Update Incident by Id
The UpdateIncident endpoint allows you to modify various attributes of an existing incident in PagerDuty's incident management system. This PUT operation enables users to update incident status, priority, assignments…
-
Update Incident Custom Field Values
Updates custom field values for a specific incident in PagerDuty. Custom fields enrich incidents with metadata like environment, severity, version info, runbook links, etc. Supports string, number, boolean, URL…
-
Update Incident Details
This endpoint allows for bulk updating of multiple PagerDuty incidents in a single API call. It can be used to modify various attributes of incidents such as status, priority, assignments, and more. This is…
-
Update Incident Workflow
This endpoint updates an existing Incident Workflow in PagerDuty by its unique identifier. It allows you to modify various aspects of the workflow, including its name, description, associated team, and the sequence of…
-
Update Incident Workflow Trigger
Updates an existing incident workflow trigger in PagerDuty. Triggers define when and how incident workflows are activated - either automatically based on conditions, manually by responders, or for specific incident…
-
Update Integration by Id and Integration Id
Updates an existing integration for a specific PagerDuty service. This endpoint allows you to modify the configuration of an integration, including its type, name, and various settings related to email processing for…
-
Update Integration Label
This endpoint updates the label (name) of an integration associated with a specific event orchestration in PagerDuty. It allows users to rename integrations for better organization and clarity within their incident…
-
Update Log Entry Channel
Updates collaboration channel information for a specific log entry in PagerDuty. This endpoint is specifically designed for updating details of Slack, Microsoft Teams, or Zoom channels that were created when responders…
-
Update Maintenance Window by Id
Updates an existing maintenance window in PagerDuty's incident management system. This endpoint allows you to modify the details of a scheduled maintenance period, including its start and end times, affected services…
-
Update Oncall Handoff Notification Rule
This endpoint updates an existing on-call handoff notification rule for a specific user in PagerDuty. It allows you to modify the notification delay, handoff type, and contact method for the rule. Use this endpoint…
-
Update Orchestration Router Details
Updates the configuration of an existing Event Orchestration Router in PagerDuty. This endpoint allows you to modify the rules and routing logic for incoming events, determining how they are directed to specific…
-
Update Ruleset by Id
Updates an existing ruleset in the PagerDuty incident management system. This endpoint allows you to modify the name of a ruleset or change its team association. It's used when you need to adjust the configuration of a…
-
Update Schedule by Id
The UpdateSchedule endpoint modifies an existing on-call schedule in PagerDuty. It updates the schedule's name, time zone, description, and layers. Each layer defines a rotation pattern for on-call duties. Use this to…
-
Update Service by Id
Updates an existing service in PagerDuty with the provided configuration. This endpoint allows you to modify various aspects of a service, such as its name, description, escalation policy, incident urgency rules, and…
-
Update Service Orchestration Active Status
Update the active status of a service orchestration in PagerDuty. This endpoint enables or disables event orchestration for a specific service. When orchestration is active (true), incoming events are processed through…
-
Update Standard by Id
Updates an existing standard in the PagerDuty incident management platform. This endpoint allows you to modify various attributes of a standard, including its active status, filtering criteria, description, and the…
-
Update Status Page Post
Updates an existing status page post update with new information. This endpoint modifies a specific update within a status page post, allowing you to change the message content, status (e.g., investigating, identified…
-
Update Status Page Post Info
Creates or updates a post update on a specific PagerDuty status page. This endpoint allows you to add new information or modify existing updates related to an incident or maintenance event. Use this when you need to…
-
Update Status Page Post Resource
Updates an existing status page post on a PagerDuty Status Page. Modify post details like title, type (incident/maintenance), and timing. Required fields: type, title, post_type, and status_page reference. For…
-
Update Team by Id
Updates an existing team in PagerDuty by modifying its name, description, visibility, or parent team. You can update: - name: Change the team name (must be unique) - description: Update team purpose/responsibilities -…
-
Update Template by Id
The UpdateTemplate endpoint allows you to modify an existing status update template in PagerDuty. This tool is used to customize notification templates for incident status updates, enabling consistent and efficient…
-
Update the Global Orchestration for an Event Orchestration
Update the Global Orchestration configuration for an Event Orchestration. This action allows you to update global-level event routing rules and processing logic that apply to all events sent to an orchestration before…
-
Update the Service Orchestration for a Service
Update a Service Orchestration for a service. Service Orchestrations allow you to create Event Rules that evaluate and process events sent to this service. The orchestration_path parameter must include: - 'sets': List…
-
Update Unrouted Orchestration Rules
Updates the unrouted orchestration rules for a specific Event Orchestration in PagerDuty. This endpoint allows you to define how events that don't match any service-specific rules should be handled. It's used to create…
-
Update User Information
Updates an existing user's information in PagerDuty. Modifies user profile attributes including name, email, time zone, role, job title, description, color, and license. Only include fields you want to update in the…
-
Update User Role on Team
Adds a user to a team or updates their role on a team. This endpoint manages team membership by assigning users to teams with specific roles. Use this to: - Add a new user to a team with a specified role - Update an…
-
Update User Status Update Notification Rule by Id
Updates a specific status update notification rule for a PagerDuty user. This endpoint modifies how a user receives notifications about status updates on incidents they're subscribed to (as stakeholders, not as…
-
Update Workflow Integration Connection
Update an existing Workflow Integration Connection. Updates properties of a workflow integration connection such as name, service URL, authentication settings, and team permissions. This action is idempotent - sending…
Setup
Connect PagerDuty in Hookshot™
Pick a scope, then confirm what can start a Protege and what it can do.
Trigger Access
What can start a Protege from this app.
Tool Access
What a Protege can do after it starts.
Connection scope
Prefer team for production.
Personal
Tied to one user—only when the workflow needs their account.
Chat
Team-scoped for supported chat surfaces.
Build with us
See Hookshot™ in your stack.
Request early access or book a live walkthrough with the team.
