Use PagerDuty to manage incidents, add investigation notes, and find services, escalation policies, and on-call responders. The REST API uses API-key authentication; Send Event uses Events API v2.
Integrate PagerDuty into your workflow to list, get, create, update, snooze, and merge incidents, add notes and list alerts, look up services and escalation policies, check on-call schedules, list users, and send monitoring events through the Events API v2.
List incidents from PagerDuty with optional filters.
Inputs and outputsParameter Type Required Description apiKeystring Yes PagerDuty REST API Key statusesstring No Comma-separated statuses to filter (triggered, acknowledged, resolved) urgenciesstring No Comma-separated urgencies to filter (high, low) serviceIdsstring No Comma-separated service IDs to filter sincestring No Start date filter (ISO 8601 format) untilstring No End date filter (ISO 8601 format) sortBystring No Sort field (e.g., created_at:desc) limitstring No Maximum number of results (max 100) offsetstring No Offset to start pagination search results
Parameter Type Description incidentsarray Array of incidents ↳ id string Incident ID ↳ incidentNumber number Incident number ↳ title string Incident title ↳ status string Incident status ↳ urgency string Incident urgency ↳ createdAt string Creation timestamp ↳ updatedAt string Last updated timestamp ↳ serviceName string Service name ↳ serviceId string Service ID ↳ assigneeName string Assignee name ↳ assigneeId string Assignee ID ↳ escalationPolicyName string Escalation policy name ↳ htmlUrl string PagerDuty web URL totalnumber Total number of matching incidents (null unless explicitly requested by PagerDuty) moreboolean Whether more results are available offsetnumber Offset used for this page of results
Get a single incident from PagerDuty by ID.
Inputs and outputsParameter Type Required Description apiKeystring Yes PagerDuty REST API Key incidentIdstring Yes ID of the incident to fetch
Parameter Type Description idstring Incident ID incidentNumbernumber Incident number titlestring Incident title statusstring Incident status urgencystring Incident urgency createdAtstring Creation timestamp updatedAtstring Last updated timestamp resolvedAtstring Resolution timestamp serviceNamestring Service name serviceIdstring Service ID assigneeNamestring Assignee name assigneeIdstring Assignee ID escalationPolicyNamestring Escalation policy name escalationPolicyIdstring Escalation policy ID incidentKeystring De-duplication key htmlUrlstring PagerDuty web URL
Create a new incident in PagerDuty.
Inputs and outputsParameter Type Required Description apiKeystring Yes PagerDuty REST API Key fromEmailstring Yes Email address of a valid PagerDuty user titlestring Yes Incident title/summary serviceIdstring Yes ID of the PagerDuty service urgencystring No Urgency level (high or low) bodystring No Detailed description of the incident escalationPolicyIdstring No Escalation policy ID to assign assigneeIdstring No User ID to assign the incident to incidentKeystring No De-duplication key. A subsequent request with the same service and incident key updates the existing open incident instead of creating a new one
Parameter Type Description idstring Created incident ID incidentNumbernumber Incident number titlestring Incident title statusstring Incident status urgencystring Incident urgency createdAtstring Creation timestamp serviceNamestring Service name serviceIdstring Service ID htmlUrlstring PagerDuty web URL
Update an incident in PagerDuty (acknowledge, resolve, change urgency, etc.).
Inputs and outputsParameter Type Required Description apiKeystring Yes PagerDuty REST API Key fromEmailstring Yes Email address of a valid PagerDuty user incidentIdstring Yes ID of the incident to update statusstring No New status (triggered, acknowledged, or resolved) titlestring No New incident title urgencystring No New urgency (high or low) escalationLevelstring No Escalation level to escalate to resolutionstring No Resolution note added to the incident's log entry. Only used when status is set to resolved
Parameter Type Description idstring Incident ID incidentNumbernumber Incident number titlestring Incident title statusstring Updated status urgencystring Updated urgency updatedAtstring Last updated timestamp htmlUrlstring PagerDuty web URL
Snooze a triggered PagerDuty incident for a number of seconds, after which it returns to triggered.
Inputs and outputsParameter Type Required Description apiKeystring Yes PagerDuty REST API Key fromEmailstring Yes Email address of a valid PagerDuty user incidentIdstring Yes ID of the incident to snooze durationstring Yes Number of seconds to snooze the incident for (1 to 604800)
Parameter Type Description idstring Incident ID incidentNumbernumber Incident number statusstring Incident status after snoozing htmlUrlstring PagerDuty web URL
Merge one or more source incidents into a target incident. Source incidents are resolved and their alerts move to the target.
Inputs and outputsParameter Type Required Description apiKeystring Yes PagerDuty REST API Key fromEmailstring Yes Email address of a valid PagerDuty user targetIncidentIdstring Yes ID of the incident that will absorb the source incidents sourceIncidentIdsstring Yes Comma-separated IDs of the incidents to merge into the target incident
Parameter Type Description idstring Target incident ID incidentNumbernumber Target incident number titlestring Target incident title statusstring Target incident status htmlUrlstring PagerDuty web URL
Add a note to an existing PagerDuty incident.
Inputs and outputsParameter Type Required Description apiKeystring Yes PagerDuty REST API Key fromEmailstring Yes Email address of a valid PagerDuty user incidentIdstring Yes ID of the incident to add the note to contentstring Yes Note content text
Parameter Type Description idstring Note ID contentstring Note content createdAtstring Creation timestamp userNamestring Name of the user who created the note
List the individual alerts attached to a PagerDuty incident.
Inputs and outputsParameter Type Required Description apiKeystring Yes PagerDuty REST API Key incidentIdstring Yes ID of the incident whose alerts to list statusesstring No Comma-separated statuses to filter (triggered, resolved) limitstring No Maximum number of results (max 100) offsetstring No Offset to start pagination search results
Parameter Type Description alertsarray Array of alerts attached to the incident ↳ id string Alert ID ↳ summary string Alert summary ↳ status string Alert status ↳ severity string Alert severity ↳ createdAt string Creation timestamp ↳ alertKey string De-duplication key ↳ serviceName string Service name ↳ serviceId string Service ID ↳ htmlUrl string PagerDuty web URL totalnumber Total number of matching alerts (null unless explicitly requested by PagerDuty) moreboolean Whether more results are available offsetnumber Offset used for this page of results
List services from PagerDuty with optional name filter.
Inputs and outputsParameter Type Required Description apiKeystring Yes PagerDuty REST API Key querystring No Filter services by name limitstring No Maximum number of results (max 100) offsetstring No Offset to start pagination search results
Parameter Type Description servicesarray Array of services ↳ id string Service ID ↳ name string Service name ↳ description string Service description ↳ status string Service status ↳ escalationPolicyName string Escalation policy name ↳ escalationPolicyId string Escalation policy ID ↳ createdAt string Creation timestamp ↳ htmlUrl string PagerDuty web URL totalnumber Total number of matching services (null unless explicitly requested by PagerDuty) moreboolean Whether more results are available offsetnumber Offset used for this page of results
Get a single service from PagerDuty by ID.
Inputs and outputsParameter Type Required Description apiKeystring Yes PagerDuty REST API Key serviceIdstring Yes ID of the service to fetch
Parameter Type Description idstring Service ID namestring Service name descriptionstring Service description statusstring Service status autoResolveTimeoutnumber Seconds before an open incident auto-resolves acknowledgementTimeoutnumber Seconds before an acknowledged incident reverts to triggered createdAtstring Creation timestamp lastIncidentTimestampstring Timestamp of the most recent incident escalationPolicyNamestring Escalation policy name escalationPolicyIdstring Escalation policy ID htmlUrlstring PagerDuty web URL
List current on-call entries from PagerDuty.
Inputs and outputsParameter Type Required Description apiKeystring Yes PagerDuty REST API Key escalationPolicyIdsstring No Comma-separated escalation policy IDs to filter scheduleIdsstring No Comma-separated schedule IDs to filter sincestring No Start time filter (ISO 8601 format) untilstring No End time filter (ISO 8601 format) limitstring No Maximum number of results (max 100) offsetstring No Offset to start pagination search results
Parameter Type Description oncallsarray Array of on-call entries ↳ userName string On-call user name ↳ userId string On-call user ID ↳ escalationLevel number Escalation level ↳ escalationPolicyName string Escalation policy name ↳ escalationPolicyId string Escalation policy ID ↳ scheduleName string Schedule name ↳ scheduleId string Schedule ID ↳ start string On-call start time ↳ end string On-call end time totalnumber Total number of matching on-call entries (null unless explicitly requested by PagerDuty) moreboolean Whether more results are available offsetnumber Offset used for this page of results
List escalation policies from PagerDuty with an optional name filter.
Inputs and outputsParameter Type Required Description apiKeystring Yes PagerDuty REST API Key querystring No Filter escalation policies by name limitstring No Maximum number of results (max 100) offsetstring No Offset to start pagination search results
Parameter Type Description escalationPoliciesarray Array of escalation policies ↳ id string Escalation policy ID ↳ name string Escalation policy name ↳ description string Escalation policy description ↳ numLoops number Number of times the policy repeats ↳ onCallHandoffNotifications string Handoff notification setting (if_has_services or always) ↳ htmlUrl string PagerDuty web URL totalnumber Total number of matching escalation policies (null unless explicitly requested by PagerDuty) moreboolean Whether more results are available offsetnumber Offset used for this page of results
List on-call schedules from PagerDuty with an optional name filter.
Inputs and outputsParameter Type Required Description apiKeystring Yes PagerDuty REST API Key querystring No Filter schedules by name limitstring No Maximum number of results (max 100) offsetstring No Offset to start pagination search results
Parameter Type Description schedulesarray Array of on-call schedules ↳ id string Schedule ID ↳ name string Schedule name ↳ description string Schedule description ↳ timeZone string Schedule time zone ↳ htmlUrl string PagerDuty web URL totalnumber Total number of matching schedules (null unless explicitly requested by PagerDuty) moreboolean Whether more results are available offsetnumber Offset used for this page of results
List users from PagerDuty with an optional name/email filter.
Inputs and outputsParameter Type Required Description apiKeystring Yes PagerDuty REST API Key querystring No Filter users by name or email limitstring No Maximum number of results (max 100) offsetstring No Offset to start pagination search results
Parameter Type Description usersarray Array of users ↳ id string User ID ↳ name string User name ↳ email string User email ↳ role string User role ↳ jobTitle string User job title ↳ timeZone string User preferred time zone ↳ htmlUrl string PagerDuty web URL totalnumber Total number of matching users (null unless explicitly requested by PagerDuty) moreboolean Whether more results are available offsetnumber Offset used for this page of results
Send a trigger, acknowledge, or resolve event to PagerDuty Events API v2 using a service integration key. Used to page from monitoring/alerting sources without a PagerDuty user account.
Inputs and outputsParameter Type Required Description routingKeystring Yes The Events API v2 integration key (routing key) for the target service eventActionstring Yes Event action: trigger, acknowledge, or resolve summarystring No Brief summary of the event. Required when eventAction is trigger sourcestring No Unique location of the affected system (e.g. hostname). Required when eventAction is trigger severitystring No Perceived severity: critical, warning, error, or info. Required when eventAction is trigger dedupKeystring No De-duplication key identifying the alert. Required when eventAction is acknowledge or resolve; optional on trigger componentstring No Component of the source machine responsible for the event groupstring No Logical grouping of components of a service classstring No The class/type of the event
Parameter Type Description statusstring Result status ("success" if accepted) messagestring Description of the result dedupKeystring De-duplication key for the alert
A trigger starts a workflow when a supported event occurs in this service.
Trigger workflow when an incident is acknowledged in PagerDuty
Configuration and outputsParameter Type Required Description apiKeystring Yes Used to create the webhook subscription. Must be a read/write REST API key.
Parameter Type Description event_idstring Unique ID of the webhook event event_typestring Event type (e.g. incident.triggered, incident.resolved) occurred_atstring When the event occurred (ISO 8601) agentjson The user or service that caused the event (may be null) incidentobject ↳ id string Incident ID ↳ number number Incident number ↳ title string Incident title ↳ status string Incident status (triggered, acknowledged, resolved) ↳ urgency string Incident urgency (high or low) ↳ html_url string Web URL of the incident ↳ created_at string Incident creation timestamp ↳ priority string Priority label (may be null) ↳ service object ↳ id string Service ID ↳ summary string Service name ↳ html_url string Service web URL ↳ escalation_policy object ↳ id string Escalation policy ID ↳ summary string Escalation policy name ↳ html_url string Escalation policy web URL ↳ assignees json Array of assignee references ({ id, summary, html_url })
Trigger workflow when an incident is escalated in PagerDuty
Configuration and outputsParameter Type Required Description apiKeystring Yes Used to create the webhook subscription. Must be a read/write REST API key.
Parameter Type Description event_idstring Unique ID of the webhook event event_typestring Event type (e.g. incident.triggered, incident.resolved) occurred_atstring When the event occurred (ISO 8601) agentjson The user or service that caused the event (may be null) incidentobject ↳ id string Incident ID ↳ number number Incident number ↳ title string Incident title ↳ status string Incident status (triggered, acknowledged, resolved) ↳ urgency string Incident urgency (high or low) ↳ html_url string Web URL of the incident ↳ created_at string Incident creation timestamp ↳ priority string Priority label (may be null) ↳ service object ↳ id string Service ID ↳ summary string Service name ↳ html_url string Service web URL ↳ escalation_policy object ↳ id string Escalation policy ID ↳ summary string Escalation policy name ↳ html_url string Escalation policy web URL ↳ assignees json Array of assignee references ({ id, summary, html_url })
Trigger workflow from any PagerDuty incident event
Configuration and outputsParameter Type Required Description apiKeystring Yes Used to create the webhook subscription. Must be a read/write REST API key.
Parameter Type Description event_idstring Unique ID of the webhook event event_typestring Event type (e.g. incident.triggered, incident.resolved) occurred_atstring When the event occurred (ISO 8601) agentjson The user or service that caused the event (may be null) incidentobject ↳ id string Incident ID ↳ number number Incident number ↳ title string Incident title ↳ status string Incident status (triggered, acknowledged, resolved) ↳ urgency string Incident urgency (high or low) ↳ html_url string Web URL of the incident ↳ created_at string Incident creation timestamp ↳ priority string Priority label (may be null) ↳ service object ↳ id string Service ID ↳ summary string Service name ↳ html_url string Service web URL ↳ escalation_policy object ↳ id string Escalation policy ID ↳ summary string Escalation policy name ↳ html_url string Escalation policy web URL ↳ assignees json Array of assignee references ({ id, summary, html_url })
Trigger workflow when an incident is reassigned in PagerDuty
Configuration and outputsParameter Type Required Description apiKeystring Yes Used to create the webhook subscription. Must be a read/write REST API key.
Parameter Type Description event_idstring Unique ID of the webhook event event_typestring Event type (e.g. incident.triggered, incident.resolved) occurred_atstring When the event occurred (ISO 8601) agentjson The user or service that caused the event (may be null) incidentobject ↳ id string Incident ID ↳ number number Incident number ↳ title string Incident title ↳ status string Incident status (triggered, acknowledged, resolved) ↳ urgency string Incident urgency (high or low) ↳ html_url string Web URL of the incident ↳ created_at string Incident creation timestamp ↳ priority string Priority label (may be null) ↳ service object ↳ id string Service ID ↳ summary string Service name ↳ html_url string Service web URL ↳ escalation_policy object ↳ id string Escalation policy ID ↳ summary string Escalation policy name ↳ html_url string Escalation policy web URL ↳ assignees json Array of assignee references ({ id, summary, html_url })
Trigger workflow when an incident is resolved in PagerDuty
Configuration and outputsParameter Type Required Description apiKeystring Yes Used to create the webhook subscription. Must be a read/write REST API key.
Parameter Type Description event_idstring Unique ID of the webhook event event_typestring Event type (e.g. incident.triggered, incident.resolved) occurred_atstring When the event occurred (ISO 8601) agentjson The user or service that caused the event (may be null) incidentobject ↳ id string Incident ID ↳ number number Incident number ↳ title string Incident title ↳ status string Incident status (triggered, acknowledged, resolved) ↳ urgency string Incident urgency (high or low) ↳ html_url string Web URL of the incident ↳ created_at string Incident creation timestamp ↳ priority string Priority label (may be null) ↳ service object ↳ id string Service ID ↳ summary string Service name ↳ html_url string Service web URL ↳ escalation_policy object ↳ id string Escalation policy ID ↳ summary string Escalation policy name ↳ html_url string Escalation policy web URL ↳ assignees json Array of assignee references ({ id, summary, html_url })
Trigger workflow when a new incident is triggered in PagerDuty
Configuration and outputsParameter Type Required Description apiKeystring Yes Used to create the webhook subscription. Must be a read/write REST API key.
Parameter Type Description event_idstring Unique ID of the webhook event event_typestring Event type (e.g. incident.triggered, incident.resolved) occurred_atstring When the event occurred (ISO 8601) agentjson The user or service that caused the event (may be null) incidentobject ↳ id string Incident ID ↳ number number Incident number ↳ title string Incident title ↳ status string Incident status (triggered, acknowledged, resolved) ↳ urgency string Incident urgency (high or low) ↳ html_url string Web URL of the incident ↳ created_at string Incident creation timestamp ↳ priority string Priority label (may be null) ↳ service object ↳ id string Service ID ↳ summary string Service name ↳ html_url string Service web URL ↳ escalation_policy object ↳ id string Escalation policy ID ↳ summary string Escalation policy name ↳ html_url string Escalation policy web URL ↳ assignees json Array of assignee references ({ id, summary, html_url })