Concepts

Concepts used in PagerDuty book.

The following documentation is for PagerDuty v1.0.3 (BDK).

Pagerduty incident creation payload

Payload for creating a PagerDuty incident.Payload for creating an incident

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

Pagerduty incident

PagerDuty incident data model.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[json]
assignments	The assignments of the incident.	optional[list of json]
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[json]
alert_counts	The alert counts of the incident.	optional[json]
is_mergeable	Whether the incident is mergeable.	optional[boolean]
incident_type	The type of the incident.	optional[json]
escalation_policy	The escalation policy of the incident.	optional[json]
teams	The teams of the incident.	optional[list of json]
pending_actions	The pending actions of the incident.	optional[list of json]
acknowledgements	The acknowledgements of the incident.	optional[list of json]
last_status_change_by	The last status change by of the incident.	optional[json]
priority	The priority of the incident.	optional[json]
conference_bridge	The conference bridge of the incident.	optional[json]
urgency	The urgency of the incident.	optional[text]
body	The body of the incident.	optional[json]

Pagerduty incident update payload

Payload for updating a PagerDuty incident.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[json]
escalation_level	The escalation level of the incident.	optional[number]
assignments	The assignments of the incident.	optional[list of json]
incident_type_name	The incident type name.	optional[text]
escalation_policy	The escalation policy of the incident.	optional[json]
urgency	The urgency of the incident.	optional[text]
conference_bridge	The conference bridge of the incident.	optional[json]

Concept attribute specifications

priority (pagerduty incident creation payload)

Name	Type
id	text
type	optional[text]
summary	optional[text]
self_url	optional[text]
html_url	optional[text]

body (pagerduty incident creation payload)

Name	Type
type	optional[text]
details	optional[any?]

assignments (pagerduty incident creation payload)

Name	Type
at	optional[text]
assignee	optional[json]

escalation_policy (pagerduty incident creation payload)

Name	Type
id	text
type	optional[text]
summary	optional[text]
self_url	optional[text]
html_url	optional[text]

conference_bridge (pagerduty incident creation payload)

Name	Type
conference_number	optional[text]
conference_url	optional[text]

service (pagerduty incident)

Name	Type
id	text
type	optional[text]
summary	optional[text]
self_url	optional[text]
html_url	optional[text]

assignments (pagerduty incident)

Name	Type
at	optional[text]
assignee	optional[json]

first_trigger_log_entry (pagerduty incident)

Name	Type
id	text
type	optional[text]
summary	optional[text]
self_url	optional[text]
html_url	optional[text]

alert_counts (pagerduty incident)

Name	Type
triggered	optional[number]
resolved	optional[number]
all	optional[number]

incident_type (pagerduty incident)

Name	Type
name	optional[text]

escalation_policy (pagerduty incident)

Name	Type
id	text
type	optional[text]
summary	optional[text]
self_url	optional[text]
html_url	optional[text]

teams (pagerduty incident)

Name	Type
id	text
type	optional[text]
summary	optional[text]
self_url	optional[text]
html_url	optional[text]

pending_actions (pagerduty incident)

Name	Type
type	text
at	text
to	optional[text]

acknowledgements (pagerduty incident)

Name	Type
at	optional[text]
acknowledger	optional[json]

last_status_change_by (pagerduty incident)

Name	Type
id	text
type	text
summary	optional[text]
self_url	optional[text]
html_url	optional[text]

priority (pagerduty incident)

Name	Type
id	text
type	optional[text]
summary	optional[text]
self_url	optional[text]
html_url	optional[text]

conference_bridge (pagerduty incident)

Name	Type
conference_number	optional[text]
conference_url	optional[text]

body (pagerduty incident)

Name	Type
type	optional[text]
details	optional[any?]

priority (pagerduty incident update payload)

Name	Type
id	text
type	optional[text]
summary	optional[text]
self_url	optional[text]
html_url	optional[text]

assignments (pagerduty incident update payload)

Name	Type
at	optional[text]
assignee	optional[json]

escalation_policy (pagerduty incident update payload)

Name	Type
id	text
type	optional[text]
summary	optional[text]
self_url	optional[text]
html_url	optional[text]

conference_bridge (pagerduty incident update payload)

Name	Type
conference_number	optional[text]
conference_url	optional[text]