PagerDuty empowers teams with real-time incident management and response orchestration. Connect with PagerDuty to build custom internal tools to view and manage on-call rotations, streamline incident resolution, and analyze and report on service health.
To get started you'll need a PagerDuty API key. To create an API key:
Once you have an access token, you're ready to set up your Superblocks integration.
Once your PagerDuty integration is created, you can start calling
PagerDuty actions in Superblocks APIs.
PagerDuty actions are REST requests. To learn more about REST requests in
Superblocks, see the
Building REST requests guide.
List incidents
List existing incidents.
An incident represents a problem or an issue that needs to be addressed and resolved.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)
Scoped OAuth requires: `incidents.read`
Create an Incident
Create an incident synchronously without a corresponding event from a monitoring service.
An incident represents a problem or an issue that needs to be addressed and resolved.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)
Scoped OAuth requires: `incidents.write`
Manage incidents
Acknowledge, resolve, escalate or reassign one or more incidents.
An incident represents a problem or an issue that needs to be addressed and resolved.
A maximum of 250 incidents may be updated at a time. If more than this number of incidents are given, the API will respond with status 413 (Request Entity Too Large).
Note: the manage incidents API endpoint is rate limited to 500 requests per minute.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)
Scoped OAuth requires: `incidents.write`
Get an incident
Show detailed information about an incident. Accepts either an incident id, or an incident number.
An incident represents a problem or an issue that needs to be addressed and resolved.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)
Scoped OAuth requires: `incidents.read`
Update an incident
Acknowledge, resolve, escalate or reassign an incident.
An incident represents a problem or an issue that needs to be addressed and resolved.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)
Scoped OAuth requires: `incidents.write`
Create a status update on an incident
Create a new status update for the specified incident. Optionally pass `subject` and `html_message` properties in the request body to override the email notification that gets sent.
An incident represents a problem or an issue that needs to be addressed and resolved.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)
Scoped OAuth requires: `incidents.write`
List alerts for an incident
List alerts for the specified incident.
An incident represents a problem or an issue that needs to be addressed and resolved.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)
Scoped OAuth requires: `incidents.read`
Manage alerts
Resolve multiple alerts or associate them with different incidents.
An incident represents a problem or an issue that needs to be addressed and resolved. An alert represents a digital signal that was emitted to PagerDuty by the monitoring systems that detected or identified the issue.
A maximum of 500 alerts may be updated at a time. If more than this number of alerts are given, the API will respond with status 413 (Request Entity Too Large).
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)
Scoped OAuth requires: `incidents.write`
Get an alert
Show detailed information about an alert. Accepts an alert id.
An incident represents a problem or an issue that needs to be addressed and resolved.
When a service sends an event to PagerDuty, an alert and corresponding incident is triggered in PagerDuty.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)
Scoped OAuth requires: `incidents.read`
Update an alert
Resolve an alert or associate an alert with a new parent incident.
An incident represents a problem or an issue that needs to be addressed and resolved.
When a service sends an event to PagerDuty, an alert and corresponding incident is triggered in PagerDuty.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)
Scoped OAuth requires: `incidents.write`
List log entries for an incident
List log entries for the specified incident.
An incident represents a problem or an issue that needs to be addressed and resolved.
A Log Entry are a record of all events on your account.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents)
Scoped OAuth requires: `incidents.read`
Get Outlier Incident
Gets Outlier Incident information for a given Incident on its Service.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#outlier-incident)
Scoped OAuth requires: `incidents.read`
Get Past Incidents
Past Incidents returns Incidents within the past 6 months that have similar metadata and were generated on the same Service as the parent Incident. By default, 5 Past Incidents are returned. Note: This feature is currently available as part of the Event Intelligence package or Digital Operations plan only.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#past_incidents)
Scoped OAuth requires: `incidents.read`
Get Related Incidents
Returns the 20 most recent Related Incidents that are impacting other Responders and Services. Note: This feature is currently available as part of the Event Intelligence package or Digital Operations plan only.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#related_incidents)
Scoped OAuth requires: `incidents.read`
List all of the on-calls
List the on-call entries during a given time range.
An on-call represents a contiguous unit of time for which a User will be on call for a given Escalation Policy and Escalation Rules.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#on-calls)
Scoped OAuth requires: `oncalls.read`
List schedules
List the on-call schedules.
A Schedule determines the time periods that users are On-Call.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)
Scoped OAuth requires: `schedules.read`
Get a schedule
Show detailed information about a schedule, including entries for each layer and sub-schedule.
Scoped OAuth requires: `schedules.read`
List users on call
List all of the users on call in a given schedule for a given time range.
A Schedule determines the time periods that users are On-Call.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)
Scoped OAuth requires: `users.read`
Preview a schedule
Preview what an on-call schedule would look like without saving it.
A Schedule determines the time periods that users are On-Call.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#schedules)
Scoped OAuth requires: `schedules.write`
List services
List existing Services.
A service may represent an application, component, or team you wish to open incidents against.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)
Scoped OAuth requires: `services.read`
Create a service
Create a new service.
If `status` is included in the request, it must have a value of `active` when creating a new service. If a different status is required, make a second request to update the service.
A service may represent an application, component, or team you wish to open incidents against.
There is a limit of 25,000 services per account. If the limit is reached, the API will respond with an error. There is also a limit of 100,000 open Incidents per Service. If the limit is reached and `auto_resolve_timeout` is disabled (set to 0 or null), the `auto_resolve_timeout` property will automatically be set to 84600 (1 day).
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)
Scoped OAuth requires: `services.write`
Get a service
Get details about an existing service.
A service may represent an application, component, or team you wish to open incidents against.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)
Scoped OAuth requires: `services.read`
Update a service
Update an existing service.
A service may represent an application, component, or team you wish to open incidents against.
There is a limit of 100,000 open Incidents per Service. If the limit is reached and you disable `auto_resolve_timeout` (set to 0 or null), the API will respond with an error.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)
Scoped OAuth requires: `services.write`
Delete a service
Delete an existing service.
Once the service is deleted, it will not be accessible from the web UI and new incidents won't be able to be created for this service.
A service may represent an application, component, or team you wish to open incidents against.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)
Scoped OAuth requires: `services.write`
List teams
List teams of your PagerDuty account, optionally filtered by a search query.
A team is a collection of Users and Escalation Policies that represent a group of people within an organization.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)
Scoped OAuth requires: `teams.read`
Create a team
Create a new Team.
A team is a collection of Users and Escalation Policies that represent a group of people within an organization.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)
Scoped OAuth requires: `teams.write`
Get a team
Get details about an existing team.
A team is a collection of Users and Escalation Policies that represent a group of people within an organization.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)
Scoped OAuth requires: `teams.read`
Update a team
Update an existing team.
A team is a collection of Users and Escalation Policies that represent a group of people within an organization.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)
Scoped OAuth requires: `teams.write`
List members of a team
Get information about members on a team.
A team is a collection of Users and Escalation Policies that represent a group of people within an organization.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)
Scoped OAuth requires: `teams.read`
Add a user to a team
Add a user to a team. Attempting to add a user with the `read_only_user` role will return a 400 error.
A team is a collection of Users and Escalation Policies that represent a group of people within an organization.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)
Scoped OAuth requires: `teams.write`
Remove a user from a team
Remove a user from a team.
A team is a collection of Users and Escalation Policies that represent a group of people within an organization.
For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#teams)
Scoped OAuth requires: `teams.write`
List users
List users of your PagerDuty account, optionally filtered by a search query.
Scoped OAuth requires: `users.read`
Create a user
Create a new user.
Scoped OAuth requires: `users.write`
Get a user
Get details about an existing user.
Scoped OAuth requires: `users.read`
Update a user
Update an existing user.
Scoped OAuth requires: `users.write`
Delete a user
Remove an existing user.
Returns 400 if the user has assigned incidents unless your [pricing plan](https://www.pagerduty.com/pricing) has the `offboarding` feature and the account is [configured](https://support.pagerduty.com/docs/offboarding#section-additional-configurations) appropriately.
Note that the incidents reassignment process is asynchronous and has no guarantee to complete before the api call return.
[*Learn more about `offboarding` feature*](https://support.pagerduty.com/docs/offboarding).
Scoped OAuth requires: `users.write`
Get aggregated incident data
Provides aggregated enriched metrics for incidents.
The provided metrics are aggregated by day, week, month using the aggregate_unit parameter, or for the entire period if no aggregate_unit is provided.
### 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.
A `team_ids` or `service_ids` filter is required for [user-level API keys](https://support.pagerduty.com/docs/using-the-api#section-generating-a-personal-rest-api-key) or keys generated through an OAuth flow. Account-level API keys do not have this requirement.
**Note:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.
Scoped OAuth requires: `analytics.read`Get aggregated service data
Provides aggregated metrics for incidents aggregated into units of time by service.
Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics).
Data can be aggregated by day, week or month in addition to by service, or provided just as a collection of aggregates for each service in the dataset for the entire period. If a unit is provided, each row in the returned dataset will include a 'range_start' timestamp.
### 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.
A `team_ids` or `service_ids` filter is required for [user-level API keys](https://support.pagerduty.com/docs/using-the-api#section-generating-a-personal-rest-api-key) or keys generated through an OAuth flow. Account-level API keys do not have this requirement.
**Note:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.
Scoped OAuth requires: `analytics.read`
Get aggregated team data
Provides aggregated metrics for incidents aggregated into units of time by team.
Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics).
Data can be aggregated by day, week or month in addition to by team, or provided just as a collection of aggregates for each team in the dataset for the entire period. If a unit is provided, each row in the returned dataset will include a 'range_start' timestamp.
### 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.
A `team_ids` or `service_ids` filter is required for [user-level API keys](https://support.pagerduty.com/docs/using-the-api#section-generating-a-personal-rest-api-key) or keys generated through an OAuth flow. Account-level API keys do not have this requirement.
**Note:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.
Scoped OAuth requires: `analytics.read`
Get raw data - multiple incidents
Provides enriched incident data and metrics for multiple incidents.
Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics).
### 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.
A `team_ids` or `service_ids` filter is required for [user-level API keys](https://support.pagerduty.com/docs/using-the-api#section-generating-a-personal-rest-api-key) or keys generated through an OAuth flow. Account-level API keys do not have this requirement.
**Note:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.
Scoped OAuth requires: `analytics.read`
Get raw data - single incident
Provides enriched incident data and metrics for a single incident.
Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Some metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/pagerduty-analytics).
### 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.
**Note:** Analytics data is updated once per day. It takes up to 24 hours before new incidents appear in the Analytics API.
Scoped OAuth requires: `analytics.read`Get raw responses from a single incident
Provides enriched responder data for a single incident.
Example metrics include Time to Respond, Responder Type, and Response Status. See metric definitions below.
### 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.
**Note:** Analytics data is updated once per day. It takes up to 24 hours before new incident responses appear in the Analytics API.
Scoped OAuth requires: `analytics.read`and 27 moreTo use this action simply add the method, path, required query parameters, and body for the desired endpoint.
