Concepts

Concepts used in PagerDuty BDK Book.

Pagerduty incident creation payload

Payload for creating an incident

Field Name	Description	Type
title	The title of the incident.	text
service	The service the incident is associated with.	``
type	The type of the incident.	text
priority	The priority of the incident.	optional[priority]
urgency	The urgency of the incident.	optional[text]
body	The body of the incident.	optional[body]
incident_key	The incident key.	optional[text]
assignments	The assignments of the incident.	optional[list of assignments]
escalation_policy	The escalation policy of the incident.	optional[escalation_policy]
conference_bridge	The conference bridge of the incident.	optional[conference_bridge]
incident_type_name	The incident type name.	optional[text]

Priority

A reference to a PagerDuty priority.

Field Name	Description	Type
id	None	text
type	None	text
summary	None	optional[text]
self_url	None	optional[text]
html_url	None	optional[text]

Body

A PagerDuty incident body.

Field Name	Description	Type
type	None	text
details	None	optional[any?]

Assignments

A PagerDuty assignment.

Field Name	Description	Type
at	None	optional[text]
assignee	None	optional[assignee]

Escalation_policy

A reference to a PagerDuty escalation policy.

Field Name	Description	Type
id	None	text
type	None	text
summary	None	optional[text]
self_url	None	optional[text]
html_url	None	optional[text]

Conference_bridge

A PagerDuty conference bridge.

Field Name	Description	Type
conference_number	None	optional[text]
conference_url	None	optional[text]

Pagerduty incident

A PagerDuty incident.

Field Name	Description	Type
id	The ID of the incident.	text
type	The type of the incident.	text
summary	The summary of the incident.	optional[text]
self_url	The self URL of the incident.	optional[text]
html_url	The HTML URL of the incident.	optional[text]
incident_number	The incident number.	optional[number]
title	The title of the incident.	optional[text]
created_at	The creation time of the incident.	optional[text]
updated_at	The last update time of the incident.	optional[text]
status	The status of the incident.	optional[text]
incident_key	The incident key.	optional[text]
service	The service the incident is associated with.	optional[service]
assignments	The assignments of the incident.	list of assignments
assigned_via	The assigned via of the incident.	optional[text]
last_status_change_at	The last status change time of the incident.	optional[text]
resolved_at	The resolution time of the incident.	optional[text]
first_trigger_log_entry	The first trigger log entry of the incident.	optional[first_trigger_log_entry]
alert_counts	The alert counts of the incident.	optional[alert_counts]
is_mergeable	Whether the incident is mergeable.	optional[boolean]
incident_type	The type of the incident.	optional[incident_type]
escalation_policy	The escalation policy of the incident.	optional[escalation_policy]
teams	The teams of the incident.	list of teams
pending_actions	The pending actions of the incident.	list of pending_actions
acknowledgements	The acknowledgements of the incident.	list of acknowledgements
last_status_change_by	The last status change by of the incident.	optional[last_status_change_by]
priority	The priority of the incident.	optional[priority]
conference_bridge	The conference bridge of the incident.	optional[conference_bridge]
urgency	The urgency of the incident.	optional[text]
body	The body of the incident.	optional[body]

Service

A reference to a PagerDuty service.

Field Name	Description	Type
id	None	text
type	None	text
summary	None	optional[text]
self_url	None	optional[text]
html_url	None	optional[text]

First_trigger_log_entry

A reference to a PagerDuty log entry.

Field Name	Description	Type
id	None	text
type	None	text
summary	None	optional[text]
self_url	None	optional[text]
html_url	None	optional[text]

Alert_counts

A PagerDuty alert count.

Field Name	Description	Type
triggered	None	optional[number]
resolved	None	optional[number]
all	None	optional[number]

Incident_type

A PagerDuty incident type detail.

Field Name	Description	Type
name	None	optional[text]

Teams

A reference to a PagerDuty team.

Field Name	Description	Type
id	None	text
type	None	text
summary	None	optional[text]
self_url	None	optional[text]
html_url	None	optional[text]

Pending_actions

A PagerDuty incident action.

Field Name	Description	Type
type	None	text
at	None	text
to	None	optional[text]

Acknowledgements

A PagerDuty acknowledgement.

Field Name	Description	Type
at	None	optional[text]
acknowledger	None	optional[acknowledger]

Last_status_change_by

Base reference for PagerDuty entities.

Field Name	Description	Type
id	None	text
type	None	text
summary	None	optional[text]
self_url	None	optional[text]
html_url	None	optional[text]

Pagerduty incident update payload

Payload for updating an incident (subset of fields)

Field Name	Description	Type
status	The status of the incident.	optional[text]
resolution	The resolution of the incident.	optional[text]
title	The title of the incident.	optional[text]
priority	The priority of the incident.	optional[priority]
escalation_level	The escalation level of the incident.	optional[number]
assignments	The assignments of the incident.	optional[list of assignments]
incident_type_name	The incident type name.	optional[text]
escalation_policy	The escalation policy of the incident.	optional[escalation_policy]
urgency	The urgency of the incident.	optional[text]
conference_bridge	The conference bridge of the incident.	optional[conference_bridge]