PagerDuty

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.

356 actions Integration catalog
Request access
Connect PagerDuty once you're in Boring.
01 · WHAT THE AGENT CAN DO

Actions

Every capability is a discrete, logged action the agent calls by name — scoped to what you authorize and recorded in the run trace.

Add service to incident workflow triggerPAGERDUTY_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 management for that service. Prerequisites: - The incident workflow trigger must already exist (create with CREATE_A_TRIGGER) - The service must already exist in your account - The trigger must not be subscribed to all services Use when expanding automated workflows to additional services or incrementally rolling out workflows. This is an additive operation - use DELETE_INCIDENT_WORKFLOW_TRIGGER_SERVICE to remove services. Requires incident_workflows:write OAuth scope.
Aggregate escalation policy incident metricsPAGERDUTY_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 patterns, response times, and escalation effectiveness. The endpoint is particularly useful for operational reviews, performance analysis, and identifying areas for improvement in incident management processes. It provides flexibility in data selection through various filters and supports different time-based aggregations for comprehensive reporting.
Aggregate incident metrics with filtersPAGERDUTY_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. It's particularly useful for generating reports, identifying trends, and assessing incident management efficiency over specified time periods. The endpoint supports various filtering criteria, time zone adjustments, and aggregation options, making it a powerful tool for both high-level overviews and granular incident analytics. However, users should be aware of the complexity of the filtering options and ensure they provide accurate parameters to obtain relevant data.
Associate service dependenciesPAGERDUTY_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 crucial for effective incident management and impact analysis. It enables you to create multiple dependencies in a single API call, improving efficiency when setting up complex service relationships. Use this endpoint when you need to define or update the dependency structure of your services in PagerDuty, such as during initial setup, service restructuring, or when adding new services to your incident management workflow.
Associate team with automation actionPAGERDUTY_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 incident response processes. Use this endpoint when you need to assign responsibility for an automation action to a particular team or when restructuring your automation workflows. The association helps in tracking, auditing, and managing permissions for automation actions across different teams in your organization. Note that this endpoint only creates the association; it does not create new teams or automation actions.
Audit escalation policy recordsPAGERDUTY_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, associated services, and on-call schedules. It's particularly useful for compliance tracking, troubleshooting, and understanding how the incident response process has been adjusted over time. The audit records provide transparency into who made changes, what was changed, and when the changes occurred, helping teams maintain accountability and optimize their incident management workflows.
Convert service rule by idPAGERDUTY_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 retaining the same behavior. Note: Event Rules reached end-of-life in January 2025. This endpoint migrates from legacy Event Rules to Event Orchestration. Important: Conversion does NOT automatically enable Event Orchestration. You must manually enable it in the service Settings or via API for rules to take effect. Safe to run multiple times - returns existing orchestration URL if already converted. Works even when service has no event rules (returns success with orchestration URL).
Count paused incident reportsPAGERDUTY_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 are currently in a paused state. It's particularly useful for generating high-level analytics, tracking incident management efficiency, and identifying trends in incident handling. The endpoint returns a simple count, making it ideal for dashboard displays or periodic system status checks. It should be used when a rapid overview of paused incidents is needed, but it won't provide detailed information about individual incidents.
Create a custom field for an incident typePAGERDUTY_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 customized filtering, search and analytics. Custom Fields can be applied to different incident types. <!-- theme: warning --> > ### Early Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. Scoped OAuth requires: `custom_fields.write`
Create a field option for a custom fieldPAGERDUTY_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 name (use LIST_INCIDENT_TYPES to find one) 2. The incident type must have a custom field already created (use CREATE_A_CUSTOM_FIELD_FOR_AN_INCIDENT_TYPE) 3. The custom field should be of type 'multi_value' or 'multi_value_fixed' to support multiple options Use this action to add selectable options to custom fields, enabling users to choose from predefined values when categorizing or tagging incidents. Note: This is an Early Access endpoint that requires the X-EARLY-ACCESS header and the 'custom_fields.write' scope.
Create and manage custom incident fieldsPAGERDUTY_CREATE_AND_MANAGE_CUSTOM_INCIDENT_FIELDS
Creates a new custom field for incidents in PagerDuty. This endpoint allows you to define additional data points to be associated with incidents, enhancing incident management and reporting capabilities. Custom fields can be used to store various types of information such as environment, severity, or any other relevant metadata. The field can be configured with different data types and value constraints, allowing for flexible and structured data capture. Use this endpoint when you need to extend the incident data model with organization-specific information. Note that once created, certain properties of a custom field cannot be changed, so careful planning of field structure is important. DEPRECATED: PagerDuty has deprecated this Base Incident Type endpoint. Use `create_a_custom_field_for_an_incident_type` for new integrations.
Create an incident typePAGERDUTY_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 Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidentType) Scoped OAuth requires: `incident_types.write`
Create a rulesetPAGERDUTY_CREATE_A_RULESET
Creates a new Ruleset in PagerDuty for managing incident routing and notification rules. This endpoint allows you to define a named set of rules that determine how incidents are processed and directed to specific teams or users. It's particularly useful when setting up or modifying your incident management workflow. The created Ruleset can be global, affecting all incoming incidents, or assigned to a specific team for more targeted incident routing. Note that while you can create the Ruleset structure with this call, the actual rules within the Ruleset must be added separately using other API endpoints. DEPRECATED: Rulesets/Event Rules are EOL; creates are rejected. Use Event Orchestrations.
Create incident workflow triggerPAGERDUTY_CREATE_A_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 by responders) or 'conditional' (fires when conditions are met, e.g., "incident.priority matches 'P1'"). Conditional triggers require a PCL condition string. Specify either a services list or subscribed_to_all_services (not both). Manual triggers support permission restrictions. Requires incident_workflows.write OAuth scope.
Create automation runner endpointPAGERDUTY_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: runner_type ('runbook'), name (max 255 chars), description (max 1024 chars), runbook_base_uri (your Runbook instance subdomain), and runbook_api_key (User API token from Runbook). Use this to connect a Runbook Automation server to PagerDuty for executing automation actions during incidents. Requires a subscription with Automation Actions capabilities.
Create business servicePAGERDUTY_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 properties of the service, including its name, description, point of contact, and the team responsible for it. Use this endpoint when you need to add a new service to your PagerDuty account for monitoring and incident management. The created Business Service can be later associated with technical services, incidents, and escalation policies. Note that this endpoint only creates the Business Service; additional configuration may be required to set up monitoring and alerting for the service.
Create escalation policyPAGERDUTY_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 escalation rules, targets, and associated services or teams. Use this when setting up or modifying incident management workflows. The created policy determines the sequence of notifications and assignments for unacknowledged incidents. Note that while you can create the policy structure, actual service associations are read-only and must be managed separately. Only one team can be associated with a policy, and the account must have the 'teams' ability to use this feature.
Create event orchestrationPAGERDUTY_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 from various integrations, ensuring efficient incident handling. Use this when you need to establish a new set of rules for event routing, especially when introducing new services or reorganizing your incident management workflow. The created Orchestration can later be associated with specific integrations using their routing keys. Note that while you can create the Orchestration structure, the actual integrations and routing details are managed separately and will be populated as read-only information once configured.
Create event rule in rulesetPAGERDUTY_CREATE_EVENT_RULE_IN_RULESET
Creates a new Event Rule within a specified Ruleset in PagerDuty's incident management system. This endpoint allows you to define complex conditions for event matching and specify actions to be taken when an event meets those conditions. Use this to automate incident response, customize alert routing, and fine-tune event processing based on specific criteria. The created rule becomes part of the Ruleset's evaluation sequence, affecting how incoming events are processed and managed. **DEPRECATION WARNING**: Rulesets and Event Rules reached end-of-life on January 31, 2025. While the API still supports accessing and modifying existing rulesets/rules, creating new rulesets is disabled. PagerDuty strongly recommends migrating to Event Orchestration for improved UI, advanced conditions, rule nesting, and better API/Terraform support. This action only works with pre-existing rulesets created before the EOL date. DEPRECATED: Rulesets/Event Rules are EOL; creates are rejected. Use Event Orchestrations.
Create extension objectPAGERDUTY_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 enhance the capabilities of your PagerDuty account. The extension is defined by its name, associated services, and a specific extension schema that determines its behavior. Use this endpoint when you need to automate the creation of extensions, such as setting up multiple webhooks or implementing custom workflows. It's particularly useful for large-scale deployments or when programmatically managing your PagerDuty configuration. Note that the extension can be temporarily disabled by PagerDuty if issues arise, such as repeated rejections from a webhook server.
Create handoff notification rulePAGERDUTY_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 and when the user should be notified about upcoming handoffs, helping to ensure smooth transitions between on-call periods. Use this when you need to establish or modify the way a user is informed about their on-call responsibilities. The rule can be set for incoming shifts, outgoing shifts, or both, and can use various contact methods like email, phone, push notifications, or SMS. Note that this endpoint creates a new rule and does not modify existing ones.
Create incident field optionPAGERDUTY_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 incidents with consistent, structured data. Use this when you need to expand the list of selectable values for a string-type custom field. The new option becomes immediately available for selection when updating or creating incidents. Note that this operation is specific to custom fields of type 'string' and cannot be used for other data types. Ensure that the field_id in the URL corresponds to an existing custom field in your PagerDuty account.
Create incident recordPAGERDUTY_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 priority, urgency, and conference bridge information. The 'incident_key' parameter helps prevent duplicate incidents, crucial for maintaining a clean incident list.
Create incident workflowPAGERDUTY_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 include actions like sending notifications, updating statuses, or triggering other integrated systems. The workflow creation is highly customizable, supporting various action types and nested workflows, making it suitable for diverse incident management scenarios across different team structures and response protocols.
Create incident workflow instancePAGERDUTY_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 workflow instance to a particular incident, enabling automated and standardized incident response procedures. Use this when you need to start a structured response process for a newly created or existing incident. The endpoint is particularly useful for ensuring consistent handling of incidents across your organization and for tracking the progress of incident resolution through defined stages.
Create integration for orchestrationPAGERDUTY_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 custom applications. Each integration gets a unique routing key for use with the PagerDuty Events API v2. Use cases: Connect monitoring tools (Datadog, New Relic, CloudWatch), set up custom alerting systems, create multiple event sources, or separate event streams by environment. Requirements: Event orchestration ID and a descriptive integration label. Returns: Integration with unique ID, routing key for Events API v2, and label. Note: Max 10 integrations per orchestration.
Create integration for servicePAGERDUTY_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' parameter). **Common integration types:** - events_api_v2_inbound_integration: Modern Events API v2 for custom integrations - generic_events_api_inbound_integration: Generic Events API v1 integration - generic_email_inbound_integration: Email-based incident creation **Vendor integrations:** Use the 'vendor' parameter with an ID from the vendors endpoint to create integrations for specific tools like Datadog, AWS CloudWatch, Nagios, New Relic, etc. **Returns:** The created integration object with an integration_key (for API integrations) or integration_email (for email integrations) that can be used to send events to PagerDuty. **Note:** Each integration belongs to exactly one service. Use this action after creating a service to establish monitoring channels.
Create maintenance window objectPAGERDUTY_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 unnecessary alerts and notifications. This endpoint is useful for planning and executing system upgrades, patches, or other maintenance tasks without triggering false alarms. The maintenance window has a defined start and end time, can be associated with multiple services, and optionally linked to specific teams. It's important to note that while incidents are suppressed during the maintenance window, underlying issues are still logged and can be reviewed later if needed.
Create new schedule layerPAGERDUTY_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 layer having: - User assignments (who participates in the rotation) - Rotation timing (how long each person is on-call) - Time zone for the schedule - Optional restrictions (e.g., only active during business hours) Use this action to: - Set up new on-call rotations for incident response - Define daily, weekly, or custom rotation patterns - Create multi-layer schedules (e.g., business hours + after-hours) - Establish coverage schedules for escalation policies The schedule will be available immediately after creation and can be referenced in escalation policies to route incidents to the right people.
Create new servicePAGERDUTY_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 rules, support hours, and alert grouping parameters. Use this when you need to add a new monitored service to your PagerDuty account, such as a new application, infrastructure component, or business process. The created service will be used as a target for incoming alerts and incidents, helping to organize and streamline your incident management process. Note that some advanced features like intelligent alert grouping may depend on your PagerDuty plan.
Create new tag in systemPAGERDUTY_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 incidents, services, or teams. The created tag can be subsequently assigned to relevant entities to improve organization and searchability within the PagerDuty platform. Use this endpoint when you need to introduce a new categorization or labeling scheme in your PagerDuty setup. Note that this endpoint only creates the tag; assigning it to specific entities would require separate API calls.
Create new team with detailsPAGERDUTY_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), team.default_role Use when setting up departments, project teams, or organizing users with shared incident response responsibilities. After creation, use separate API calls to add members to the team. Examples: - Basic: {"team": {"name": "Platform Team"}} - With details: {"team": {"name": "SRE Team", "description": "Site Reliability Engineering"}} - Nested: {"team": {"name": "Backend API", "parent": "PXXXXXX", "default_role": "responder"}} Note: Requires paid PagerDuty plan with Teams feature enabled.
Create new webhook subscriptionPAGERDUTY_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, acknowledgments, and resolutions. The webhook can be configured to filter events by service, team, or account-wide, and supports custom HTTP headers for enhanced integration capabilities. Use this when you need to integrate PagerDuty's real-time incident updates with external systems or workflows. Note that the webhook's secret for payload verification is only provided in the initial creation response and cannot be retrieved later.
Create or update status page postPAGERDUTY_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 includes a title, type, and one or more updates describing the current situation. You can specify which services are impacted, the severity level, whether to notify subscribers, and expected update frequency. For maintenance posts, include start and end times. For incident posts, these times are optional. This action is essential for transparent customer communication during service issues or planned work.
Create or update status page postmortemPAGERDUTY_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 content and offers the option to notify subscribers. Use this when you need to provide a comprehensive review of an incident, its root causes, and lessons learned. It's particularly useful for maintaining transparency and improving incident response processes. Note that the postmortem is limited to 10,000 characters and is always associated with an existing status page post.
Create response play for incidentsPAGERDUTY_CREATE_RESPONSE_PLAY_FOR_INCIDENTS
Creates a new Response Play in PagerDuty, which is a predefined set of actions to be executed in response to an incident. This endpoint allows you to configure automated responses, including adding subscribers, assigning responders, setting up conference details, and defining how the Response Play can be triggered. Use this when you want to standardize and automate your incident management process, ensuring consistent and efficient responses to different types of incidents. The Response Play can be set to run automatically for specific services or be manually triggered by team members or responders, depending on the configuration. This tool is particularly useful for creating templated responses for common incident types or for implementing best practices across your organization's incident management workflow. DEPRECATED: Response Plays are EOL. On accounts with Incident Workflows enabled this always fails; use the Incident Workflows actions instead.
Create schedule overrides configurationPAGERDUTY_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 planned absences, shift swaps, or special coverage requirements without permanently altering the regular schedule. The overrides are applied to the schedule identified by the {id} parameter in the endpoint URL. Multiple overrides can be created in a single request, enabling efficient batch modifications to the schedule. Each override specifies a start time, end time, and the user who will be on call during that period. The endpoint should be used when temporary changes to the on-call rotation are needed. It does not modify the underlying schedule configuration.
Create service event rulePAGERDUTY_CREATE_SERVICE_EVENT_RULE
Creates a new event rule for a specific service in PagerDuty. This endpoint allows you to define complex conditions and actions for handling incoming events, enabling automated incident management and alert routing. Use this when you need to set up custom logic for processing events, such as setting priorities, annotating incidents, or suppressing alerts based on specific criteria. The rule's position in the evaluation order can be specified, and various time-based conditions can be applied to control when the rule is active. This endpoint is crucial for fine-tuning your incident response workflow and reducing alert noise. DEPRECATED: Rulesets/Event Rules are EOL; creates are rejected. Use Event Orchestrations.
Create statuspage subscriptionPAGERDUTY_CREATE_STATUS_PAGE_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 updates, incidents, or changes to the monitored services. The subscription can be configured for either email or webhook notifications, allowing for flexible integration with various notification systems. This tool should be used when setting up new monitoring or alert systems, or when adding new stakeholders who need to be kept informed about service status. It's particularly useful for DevOps teams, IT managers, or customer support teams who need real-time updates on service health. Note that this endpoint only creates the subscription; it does not manage or trigger the actual notifications.
Create status update templatePAGERDUTY_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 dynamic variables like {{incident.title}}, {{incident.status}}, etc. Requires PagerDuty Business or Enterprise plan (returns 402 error otherwise). Only 'status_update' template type is currently supported. At minimum, provide a template name.
Create user notification rulePAGERDUTY_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 method of contact, and the urgency level of incidents that trigger this rule. This is particularly useful for customizing alert behaviors for different users based on their preferences or role within the organization. The rule created will be associated with the user identified by the provided ID in the URL path.
Create user objectPAGERDUTY_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 information, including name, email, role, and time zone preferences. The created user will have default contact methods and notification rules, which can be customized later. Note that some fields like teams, contact methods, and notification rules cannot be set during user creation and must be managed separately. The endpoint requires at minimum a name, email, and user type, with several optional fields for further customization.
Create user status update notification rulePAGERDUTY_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 preferences for individual users, ensuring they receive timely updates through their preferred contact method. The rule specifies which contact method (email, phone, push notification, or SMS) should be used for sending status updates. This is particularly useful for tailoring notification strategies to match users' roles and responsibilities within the incident management process.
Create workflow integration connectionPAGERDUTY_CREATE_WORKFLOW_INTEGRATION_CONNECTION
Create a new Workflow Integration Connection. Scoped OAuth requires: `workflow_integrations:connections.write`
Delete account subscription by idPAGERDUTY_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 should be used when you need to discontinue the subscription for a particular business service, such as when the service is no longer needed or when restructuring your PagerDuty setup. This action is irreversible, so it should be used with caution. The endpoint does not return any specific data upon successful deletion, likely providing only a success status code.
Delete a custom field for an incident typePAGERDUTY_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 name (use LIST_INCIDENT_TYPES) 2. Custom field on that incident type (use LIST_INCIDENT_TYPE_CUSTOM_FIELDS) 3. API token with 'custom_fields.write' scope Note: Early Access endpoint requiring X-EARLY-ACCESS header with 'analytics-v2'. Use case: Remove deprecated fields or clean up test fields. Scoped OAuth requires: `custom_fields.write`
Delete addon by idPAGERDUTY_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 setup. It's important to note that this action is irreversible, and once an add-on is deleted, it cannot be recovered without re-adding it. Use this endpoint with caution, as removing an add-on may impact any automated workflows or integrations that depend on it.
Delete a field option for a custom fieldPAGERDUTY_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 incidents are using this field option value, the behavior depends on PagerDuty's configuration for handling deleted options. Prerequisites: 1. A valid incident type ID or name (use LIST_INCIDENT_TYPES to find one) 2. A custom field on that incident type (use LIST_INCIDENT_TYPE_CUSTOM_FIELDS) 3. A field option on that custom field (use LIST_FIELD_OPTIONS_ON_A_CUSTOM_FIELD) Note: This is an Early Access endpoint that requires the X-EARLY-ACCESS header with 'analytics-v2' and the 'custom_fields.write' scope. Example use case: Remove an obsolete option from a severity or category dropdown field after it's no longer needed for incident classification.
Delete alert grouping settingPAGERDUTY_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 permanent and cannot be undone, so it should be used with caution. This operation is particularly useful when updating your incident management strategy or cleaning up unused configurations to maintain an efficient alert grouping system. Note that deleting these settings may affect how future alerts are grouped, potentially impacting your team's incident response workflow.
Delete all oauth delegationsPAGERDUTY_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 include the PagerDuty mobile app, Slack, Microsoft Teams, and third-party apps. Deleting an OAuth delegation will revoke that instance of an app's access to that user or account. To grant access again, reauthorization/reauthentication may be required. Currently, this endpoint only supports deleting mobile app OAuth delegations for a given user. This is equivalent to signing users out of the PagerDuty mobile app. The deletion is processed synchronously and takes effect immediately. Scoped OAuth requires: `oauth_delegations.write`
Delete automation action by idPAGERDUTY_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 when an Automation Action is no longer needed or has become obsolete. Once deleted, the action cannot be recovered, so use this endpoint with caution. This operation is typically performed by administrators or users with appropriate permissions to manage Automation Actions.
Delete automation action service by idPAGERDUTY_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 triggered for incidents related to the specified service. This operation is useful when you need to update your incident management workflow or when an automated action is no longer relevant for a specific service. It's important to note that this endpoint only removes the association between the action and the service; it does not delete the automation action itself from the system. Use this endpoint with caution, as removing an automation action from a service will immediately affect the incident response process for that service.
Delete automation actions runner by idPAGERDUTY_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. WARNING: Deletion is irreversible and will affect all automation actions and schedules using this runner. Requires Automation Actions feature subscription. To use: First obtain the runner ID via list_automation_actions_runners or get_automation_action_runner_by_id, then call this endpoint with that ID.
Delete business service by idPAGERDUTY_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 management structure. It's important to note that this action is irreversible and will remove all associations between the deleted business service and any technical services or incidents. Use this endpoint with caution, as it may impact reporting and historical data related to the deleted business service. Before deletion, ensure that no active incidents or dependencies rely on this business service to avoid disruptions in your incident management workflow.
Delete business service priority thresholdsPAGERDUTY_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 to impact business services. When a global threshold is set, only incidents at or above that priority level will affect business services. Use this action to remove the global threshold entirely, allowing incidents of any priority to impact business services (or reverting to default behavior). This operation is idempotent - it can be called even when no threshold is currently set. The action does not delete business services themselves, only the global priority threshold configuration. Note that this affects all business services across the account.
Delete cache variable for eventPAGERDUTY_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 should be used when you need to clean up or remove outdated cache variables that are no longer needed in your event management process. This operation is idempotent - attempting to delete a cache variable that doesn't exist will return a successful response. The endpoint requires both the event orchestration ID and the specific cache variable ID to ensure precise removal of the intended data. Requirements: - Event Intelligence/Digital Operations plan OR PagerDuty AIOps add-on - Advanced Event Orchestration pricing tier - API token with event_orchestrations:write scope - User with Team Manager-level permissions or above
Delete cache variable from servicePAGERDUTY_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 No Content on successful deletion. Use this when cleaning up obsolete cache variables or freeing resources. Note: This action cannot be undone.
Delete custom field by field idPAGERDUTY_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 permanently delete a custom field from all incidents, both existing and future. The operation is irreversible, so caution should be exercised when using this endpoint. It's important to note that this action will remove the specified custom field and its associated data from all incidents, which could impact reporting and analysis based on that field.
Delete escalation policy by idPAGERDUTY_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 be recovered, and any services or incidents associated with it will need to be reassigned. Exercise caution when using this endpoint, as it will impact incident routing and may affect your team's ability to respond to alerts if not properly managed. It's recommended to review and update any dependent services before deleting an escalation policy.
Delete event by idPAGERDUTY_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 logic. It's important to note that this action is irreversible, and once an Event Orchestration is deleted, it cannot be recovered. Before using this endpoint, ensure that the Event Orchestration is no longer needed and that its deletion won't disrupt any critical event routing or automation processes in your PagerDuty setup. This endpoint is particularly useful during cleanup operations or when restructuring your event management workflow.
Showing the first 60 of 356 actions.