Connectors Reference
PagerDuty is an agile incident management platform that integrates with IT Ops and DevOps monitoring stacks to improve operational reliability and agility for organizations.
|
Status: Preview |
Tier: Standard |
Version: 1.0 |
|
Name |
Summary |
|
List incidents |
|
|
Get incident |
|
|
List active incidents |
|
|
Get all the escalation policies |
|
|
Get all the users |
|
|
Get user by ID |
|
|
Get all the notes for an incident |
|
|
AddNoteToIncident (string incidentId, AddNoteRequest request) |
Add note to incident |
|
AcknowledgeIncident (string incidentId, AcknowledgeRequest request) |
Acknowledge incident |
|
Resolve incident |
|
|
ReassignIncident (string incidentId, ReassignRequest request) |
Reassign incident |
|
Snooze incident |
|
|
EscalateIncident (string incidentId, EscalateRequest request) |
Escalate incident |
|
Get incident |
|
|
Create incident |
|
Name |
Summary |
|
When a note is added |
|
|
When an incident is created |
|
|
When an incident is assigned to a user |
|
|
When an incident is acknowledged |
|
|
When an incident is resolved |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: List incidents
Description: List incidents
Syntax:
PagerDuty.GetIncidents ()
Returns:
Type:IncidentsResponse
Description: Response for a list of incidents
Summary: Get incident
Description: Retrieves incident object by incident key.
Syntax:
PagerDuty.GetIncidentByKey (string incident_key)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
incident_key |
string (Incident) |
Incident key |
True |
Returns:
Type:Incident
Description: An incident
Summary: List active incidents
Description: List active incidents
Syntax:
PagerDuty.GetActiveIncidents ()
Returns:
Type:IncidentsResponse
Description: Response for a list of incidents
Summary: Get all the escalation policies
Description: Get all the escalation policies
Syntax:
PagerDuty.GetEscalationPolicies ()
Returns:
Type:EscalationPoliciesResponse
Description: Escalation policies response object
Summary: Get all the users
Description: Get all the users
Syntax:
PagerDuty.GetUsers ()
Returns:
Type:UsersResponse
Description: Users response object
Summary: Get user by ID
Description: Retrieves the user's information for a given ID.
Syntax:
PagerDuty.GetUser (string userId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
userId |
string (User Id) |
Unique Id of the user. |
True |
Returns:
Type:User
Description: A PagerDuty user
Summary: Get all the notes for an incident
Description: Get all the notes for an incident
Syntax:
PagerDuty.GetIncidentNotes (string incidentId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
incidentId |
string (Incident) |
Incident identifier |
True |
Returns:
Type:NotesResponse
Description: Response object for notes
Summary: Add note to incident
Description: Add note to a given incident.
Syntax:
PagerDuty.AddNoteToIncident (string incidentId, AddNoteRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
incidentId |
string (Incident) |
Select an incident |
True |
|
|
request |
|
Request to add a note to an incident |
True |
Returns:
Type:AddNoteResponse
Description: Response to AddNoteToIncident endpoint
Summary: Acknowledge incident
Description: Acknowledge a given incident.
Syntax:
PagerDuty.AcknowledgeIncident (string incidentId, AcknowledgeRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
incidentId |
string (Incident) |
Select an incident |
True |
|
|
request |
|
Request to acknowledge an incident |
True |
Returns:
Type:SingleIncident
Description: An incident with incident property itself
Summary: Resolve incident
Description: Mark a given incident as resolved.
Syntax:
PagerDuty.ResolveIncident (string incidentId, ResolveRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
incidentId |
string (Incident) |
Select an incident |
True |
|
|
request |
|
Request to resolve an incident |
True |
Returns:
Type:SingleIncident
Description: An incident with incident property itself
Summary: Reassign incident
Description: Reassign a given incident.
Syntax:
PagerDuty.ReassignIncident (string incidentId, ReassignRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
incidentId |
string (Incident) |
Select an incident |
True |
|
|
request |
|
Request object to reassign an incident |
True |
Returns:
Type:SingleIncident
Description: An incident with incident property itself
Summary: Snooze incident
Description: Snooze a given incident by a certain time.
Syntax:
PagerDuty.SnoozeIncident (string incidentId, SnoozeRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
incidentId |
string (Incident) |
Select an incident |
True |
|
|
request |
|
Request to snooze an incident |
True |
Returns:
Type:SingleIncident
Description: An incident with incident property itself
Summary: Escalate incident
Description: Use a given escalation policy on an incident.
Syntax:
PagerDuty.EscalateIncident (string incidentId, EscalateRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
incidentId |
string (Incident) |
Select an incident |
True |
|
|
request |
|
Request object to escalate an incident |
True |
Returns:
Type:SingleIncident
Description: An incident with incident property itself
Summary: Get incident
Description: Retrieves incident object by incident key.
Syntax:
PagerDuty.GetIncidentById (string incidentId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
incidentId |
string
|
|
True |
Returns:
Type:SingleIncident
Description: An incident with incident property itself
Summary: Create incident
Description: Creates a new incident for a given service identifiable by the integration key.
Syntax:
PagerDuty.CreateIncident (CreateRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
Request to create an incident |
True |
Returns:
Type:NewIncident
Description: A new incident
Summary: When a note is added
Description: Triggers when a note is added to the given incident.
Syntax:
PagerDuty.OnNewIncidentNote (string incidentId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
incidentId |
string (Incident) |
Select an incident |
True |
Returns:
Type:NotesResponse
Description: Response object for notes
Summary: When an incident is created
Description: Triggers when a new incident is created.
Syntax:
PagerDuty.OnNewIncidentCreated ()
Returns:
Type:IncidentsResponse
Description: Response for a list of incidents
Summary: When an incident is assigned to a user
Description: Triggers when an incident is assigned to the given user.
Syntax:
PagerDuty.OnIncidentAssigned (string userId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
userId |
string (User) |
Select a user |
True |
Returns:
Type:IncidentsResponse
Description: Response for a list of incidents
Summary: When an incident is acknowledged
Description: Triggers when an existing incident is acknowledged.
Syntax:
PagerDuty.OnIncidentAcknowledged ()
Returns:
Type:IncidentsResponse
Description: Response for a list of incidents
Summary: When an incident is resolved
Description: Triggers when an existing incident is resolved.
Syntax:
PagerDuty.OnIncidentResolved ()
Returns:
Type:IncidentsResponse
Description: Response for a list of incidents
Summary:
Description: Acknowledgement of incident
Properties:
|
Name |
Type |
Summary |
|
at |
string Time acknowledgement was created |
Time acknowledgement was created |
|
acknowledger |
|
Represents the acknowledger of an incident |
Summary:
Description: Represents the acknowledger of an incident
Properties:
|
Name |
Type |
Summary |
|
id |
string Acknowledger Id |
Acknowledger Id |
|
type |
string Acknowledger type |
Acknowledger type |
|
summary |
string A generated string that provides succinct, important information about the acknowledger |
A generated string that provides succinct, important information about the acknowledger |
|
self |
string The API show URL at which the object is accessible |
The API show URL at which the object is accessible |
|
html_url |
string A URL at which the entity is uniquely displayed in the Web app |
A URL at which the entity is uniquely displayed in the Web app |
Summary:
Description: Request to acknowledge an incident
Properties:
|
Name |
Type |
Summary |
|
userId |
string Acknowledged by |
Select a user |
Summary:
Description: Request to add a note to an incident
Properties:
|
Name |
Type |
Summary |
|
userId |
string Added by |
Select a user |
|
note |
string Note |
Text for the note |
Summary:
Description: Response to AddNoteToIncident endpoint
Properties:
|
Name |
Type |
Summary |
|
user |
|
User response |
|
note |
|
Note Response |
Summary:
Description: Represents to whom the incident is assigned
Properties:
|
Name |
Type |
Summary |
|
id |
string Assignee Id |
Assignee Id |
|
type |
string Assignee type |
Assignee type |
|
summary |
string A generated string that provides succinct, important information about the acknowledger |
A generated string that provides succinct, important information about the acknowledger |
|
self |
string The API show URL at which the object is accessible |
The API show URL at which the object is accessible |
|
html_url |
string A URL at which the entity is uniquely displayed in the Web app |
A URL at which the entity is uniquely displayed in the Web app |
Summary:
Description: Represents the assignment of an incident
Properties:
|
Name |
Type |
Summary |
|
at |
string Time assignment was created |
Time assignment was created |
|
assignee |
|
Represents to whom the incident is assigned |
Summary:
Description: The method for contact
Properties:
|
Name |
Type |
Summary |
|
id |
string Contact method Id |
Contact method Id |
|
type |
string Contact method type |
Contact method type |
|
summary |
string A generated string that provides succinct, important information about the contact method |
A generated string that provides succinct, important information about the contact method |
|
self |
string The API show URL at which the object is accessible |
The API show URL at which the object is accessible |
|
html_url |
string HTML URL |
A URL at which the entity is uniquely displayed in the web app |
Summary:
Description: Request to create an incident
Properties:
|
Name |
Type |
Summary |
|
service_key |
string(string) Service key |
Service integration key from PagerDuty |
|
description |
string(string) Description |
Description of the incident |
Summary:
Description: Request object to escalate an incident
Properties:
|
Name |
Type |
Summary |
|
userId |
string Escalated by |
Select a user |
|
policyId |
string Escalation policy |
Select a policy |
Summary:
Description: Escalation policies response object
Properties:
|
Name |
Type |
Summary |
|
escalation_policies |
array of (EscalationPolicy) Escalation policies |
List of escalation policies |
|
limit |
integer(int32) Pagination limit |
Pagination limit |
|
offset |
integer(int32) Pagination offset |
Pagination offset |
|
more |
boolean Indicates if there are additional policies to return |
Indicates if there are additional policies to return |
|
total |
integer(int32) Total |
The total number of records matching the given |
Summary:
Description: The policy in place for escalating an incident
Properties:
|
Name |
Type |
Summary |
|
id |
string Policy Id |
Policy Id |
|
type |
string Policy type |
Policy type |
|
summary |
string A generated string that provides succinct, important information about the policy |
A generated string that provides succinct, important information about the policy |
|
self |
string The API show URL at which the object is accessible |
The API show URL at which the object is accessible |
|
html_url |
string A URL at which the entity is uniquely displayed in the Web app |
A URL at which the entity is uniquely displayed in the Web app |
Summary:
Description: Log entry for when an incident is triggered
Properties:
|
Name |
Type |
Summary |
|
id |
string Log entry Id |
Log entry Id |
|
type |
string Log entry type |
Log entry type |
|
summary |
string A generated string that provides succinct, important information about the log entry |
A generated string that provides succinct, important information about the log entry |
|
self |
string The API show URL at which the object is accessible |
The API show URL at which the object is accessible |
|
html_url |
string A URL at which the entity is uniquely displayed in the Web app |
A URL at which the entity is uniquely displayed in the Web app |
Summary:
Description: An incident
Properties:
|
Name |
Type |
Summary |
|
id |
string Incident Id |
Incident Id |
|
type |
string Incident type |
Incident type |
|
summary |
string Incident title |
Incident title |
|
self |
string The API show URL at which the object is accessible |
The API show URL at which the object is accessible |
|
html_url |
string Incident detail url |
Incident detail url |
|
incident_number |
integer(int32) Incident number |
Incident number |
|
created_at |
string Create date |
Create date |
|
status |
string Current status |
Current status |
|
pending_actions |
array of (PendingAction) List of pending actions |
List of pending actions |
|
incident_key |
string Incident Key |
Incident Key |
|
service |
|
A service |
|
assignments |
array of (Assignment) List of all assignments for this incident |
List of all assignments for this incident |
|
assignedUserId |
string Assigned User ID |
The ID of the user assigned to this incident |
|
acknowledgements |
array of (Acknowledgement) List of all acknowledgements for this incident |
List of all acknowledgements for this incident |
|
last_status_change_at |
string Last status change |
Last status change |
|
last_status_change_by |
|
Represents the user or service that last changed an incident |
|
first_trigger_log_entry |
|
Log entry for when an incident is triggered |
|
escalation_policy |
|
The policy in place for escalating an incident |
|
teams |
array of (Team) Teams involved in the incident lifecycle |
Teams involved in the incident lifecycle |
|
urgency |
string Current urgency |
Current urgency |
Summary:
Description: Response for a list of incidents
Properties:
|
Name |
Type |
Summary |
|
incidents |
array of (Incident) List of incidents |
List of incidents |
Summary:
Description: Represents the user or service that last changed an incident
Properties:
|
Name |
Type |
Summary |
|
id |
string Last status change Id |
Last status change Id |
|
type |
string Last status change type |
Last status change type |
|
summary |
string A generated string that provides succinct, important information about the policy |
A generated string that provides succinct, important information about the last status change |
|
self |
string The API show URL at which the object is accessible |
The API show URL at which the object is accessible |
|
html_url |
string A URL at which the entity is uniquely displayed in the Web app |
A URL at which the entity is uniquely displayed in the Web app |
Summary:
Description: A new incident
Properties:
|
Name |
Type |
Summary |
|
incident_key |
string Key |
Key |
Summary:
Description: A note for an incident
Properties:
|
Name |
Type |
Summary |
|
content |
string Note content |
Note content |
Summary:
Description: Note Response
Properties:
|
Name |
Type |
Summary |
|
id |
string Unique identifier of the user |
Unique identifier of the user |
|
user |
|
User response |
|
content |
string Note content |
Note content |
|
created_at |
string Date and time the note was created |
Date and time the note was created |
Summary:
Description: Response object for notes
Properties:
|
Name |
Type |
Summary |
|
notes |
array of (Note) Notes |
List of notes |
Summary:
Description: Notification rule
Properties:
|
Name |
Type |
Summary |
|
id |
string Notification rule Id |
Notification rule Id |
|
type |
string Rule type |
Rule type |
|
summary |
string A generated string that provides succinct, important information about the rule |
A generated string that provides succinct, important information about the rule |
|
self |
string The API show URL at which the object is accessible |
The API show URL at which the object is accessible |
|
html_url |
string HTML URL |
A URL at which the entity is uniquely displayed in the web app |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: An incident action that is pending
Properties:
|
Name |
Type |
Summary |
|
type |
string Pending action type |
Pending action type |
|
at |
string Create date |
Create date |
Summary:
Description: Request object to reassign an incident
Properties:
|
Name |
Type |
Summary |
|
userId |
string From user |
Select a user |
|
reassignUserId |
string To user |
Select a user |
Summary:
Description: Request to resolve an incident
Properties:
|
Name |
Type |
Summary |
|
userId |
string Resolved by |
Select a user |
Summary:
Description: A service
Properties:
|
Name |
Type |
Summary |
|
id |
string Service Id |
Service Id |
|
type |
string Service type |
Service type |
|
summary |
string A generated string that provides succinct, important information about the service |
A generated string that provides succinct, important information about the service |
|
self |
string The API show URL at which the object is accessible |
The API show URL at which the object is accessible |
|
html_url |
string A URL at which the entity is uniquely displayed in the Web app |
A URL at which the entity is uniquely displayed in the Web app |
Summary:
Description: An incident with incident property itself
Properties:
|
Name |
Type |
Summary |
|
incident |
|
An incident |
Summary:
Description: Request to snooze an incident
Properties:
|
Name |
Type |
Summary |
|
userId |
string Snoozed by |
Select a user |
|
duration |
integer(int32) Snooze |
The amount of time, in seconds, to snooze the incident |
Summary:
Description: A team
Properties:
|
Name |
Type |
Summary |
|
id |
string Team Id |
Team Id |
|
type |
string Team type |
Team type |
|
summary |
string A generated string that provides succinct, important information about the team |
A generated string that provides succinct, important information about the team |
|
self |
string The API show URL at which the object is accessible |
The API show URL at which the object is accessible |
|
html_url |
string A URL at which the entity is uniquely displayed in the Web app |
A URL at which the entity is uniquely displayed in the Web app |
Summary:
Description: A PagerDuty user
Properties:
|
Name |
Type |
Summary |
|
name |
string Name |
Name |
|
|
string E-mail address |
E-mail address |
|
time_zone |
string The preferred time zone name. If null, the account time zone will be used |
The preferred time zone name. If null, the account time zone will be used |
|
color |
string Schedule color |
Schedule color |
|
avatar_url |
string User avatar url |
User avatar url |
|
billed |
boolean User is billed |
User is billed |
|
role |
string The user role |
The user role |
|
description |
string Description |
The user's bio |
|
invitation_sent |
boolean Outstanding invitation for the user |
Outstanding invitation for the user |
|
contact_methods |
array of (ContactMethod) Contact methods for the user |
Contact methods for the user |
|
notification_rules |
array of (NotificationRule) Notification rules for the user |
Notification rules for the user |
|
job_title |
string Job title |
The user's job title |
|
teams |
array of (Object) Teams to which the user belongs |
Teams to which the user belongs |
|
coordinated_incidents |
array of (Object) List of incidents for this user |
List of incidents for this user |
|
id |
string User Id |
User Id |
|
type |
string User type |
User type |
|
summary |
string A generated string that provides succinct, important information about the user |
A generated string that provides succinct, important information about the user |
|
self |
string The API show URL at which the object is accessible |
The API show URL at which the object is accessible |
|
html_url |
string A URL at which the entity is uniquely displayed in the Web app |
A URL at which the entity is uniquely displayed in the Web app |
Summary:
Description: User response
Properties:
|
Name |
Type |
Summary |
|
id |
string User Id |
User Id |
|
type |
string User type |
User type |
|
summary |
string A generated string that provides succinct, important information about the user |
A generated string that provides succinct, important information about the user |
|
self |
string The API show URL at which the object is accessible |
The API show URL at which the object is accessible |
|
html_url |
string A URL at which the entity is uniquely displayed in the Web app |
A URL at which the entity is uniquely displayed in the Web app |
Summary:
Description: Users response object
Properties:
|
Name |
Type |
Summary |
|
users |
array of (User) Users |
List of users |
|
limit |
integer(int32) Pagination limit |
Pagination limit |
|
offset |
integer(int32) Pagination offset |
Pagination offset |
|
total |
integer(int32) Total |
The total number of records matching the given |
|
more |
boolean Indicates if there are additional users to return |
Indicates if there are additional users to return |