PagerDuty Tables and Scopes

The PagerDuty integration uses the following tables and permissions

Tables

PagerDutyAddOns

NameTypeDescription
ConfigIDintegerThe ID of the configuration within Compyl.
IDstringUnique identifier for the Addon.
TypestringA string that determines the schema of the object. This must be the standard name for the entity, suffixed by _reference if the object is a reference. Allowed values: full_page_addon_reference, incident_show_addon_reference
SummarystringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to name, though it is not intended to be an identifier.
HTMLURLstringA URL at which the entity is uniquely displayed in the Web app
NamestringThe user entered name of the Addon.
SRCstringThe URL source of the Addon.
BatchDatedatetimeThe date and time data was synced to our database.

PagerDutyBusinessServices

NameTypeDescription
ConfigIDintegerThe ID of the configuration within Compyl.
IDstringUnique identifier of the business service.
DescriptionstringThe user-provided description of the business service.
HTMLURLstringA URL at which the entity is uniquely displayed in the Web app.
NamestringThe name of the business service.
PointOfContactstringThe point of contact assigned to this service.
SummarystringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to name, though it is not intended to be an identifier.
TeamIDstringReference to the team that owns the business service.
TypestringA string that determines the schema of the object. This must be the standard name for the entity, suffixed by _reference if the object is a reference.
BatchDatedatetimeThe date and time data was synced to our database.

PagerDutyChangeEvents

NameTypeDescription
ConfigIDintegerThe ID of the configuration within Compyl.
IDstringA unique identifier for the change event.
SummarystringA brief text summary describing the change event.
TimestampdatetimeThe date and time when the event was detected or generated by the emitting tool.
TypestringThe type of event being recorded.
SourcestringThe system or tool that triggered the change event. This represents the origin of the change (e.g. CI/CD pipeline, monitoring system).
IntegrationIDstringThe unique identifier of the integration that sent this change event.
BatchDatedatetimeThe date and time data was synced to our database.

PagerDutyEscalationPolicies

NameTypeDescription
ConfigIDintegerThe ID of the configuration within Compyl.
IDstringThe unique identifier of the escalation policy in PagerDuty.
TypestringThe type of the object.
SummarystringA short-form summary of the escalation policy, typically used for labeling in the UI.
OnCallHandoffNotificationsstringDetermines how on-call handoff notifications will be sent.
HTMLURLstringThe URL for viewing the escalation policy in the PagerDuty web interface.
NamestringThe name of the escalation policy.
NumLoopsintegerThe number of times the escalation policy will repeat after reaching the end of its escalation.
TeamIDstringThe ID of the team associated with this escalation policy.
BatchDatedatetimeThe date and time data was synced to our database.

PagerDutyEscalationPolicyRules

NameTypeDescription
ConfigIDintegerThe ID of the configuration within Compyl.
RuleIDstringA unique identifier for the escalation rule.
TargetIDstringThe identifier of the target (user or schedule) to which incidents are assigned when the rule is triggered.
EscalationDelayInMinutesintegerThe number of minutes before an unacknowledged incident escalates to the next rule in the policy.
TargetSummarystringA short-form description of the escalation target (e.g., user or schedule name).
TargetTypestringThe type of the escalation target, which can be one of the following: user, schedule, user_reference, or schedule_reference.
TargetHTMLURLstringThe URL of the escalation target in the PagerDuty web app.
EscalationPolicyIDstringThe identifier of the escalation policy to which this rule belongs.
BatchDatedatetimeThe date and time data was synced to our database.

PagerDutyIncidentAlerts

NameTypeDescription
ConfigIDintegerThe ID of the configuration within Compyl.
IDstringThe unique identifier of the alert.
TypestringThe type of object being stored.
SummarystringA short-form description of the alert, summarizing the key details.
HTMLURLstringA URL where the alert can be viewed in the PagerDuty web application.
CreatedAtdatetimeThe date and time when the alert was first triggered.
StatusstringThe current status of the alert. Possible values: triggered, resolved.
AlertKeystringThe unique de-duplication key for the alert, used to group related alerts together.
ServiceIDstringThe unique identifier of the service associated with the alert.
IncidentIDstringThe unique identifier of the incident to which this alert is linked.
SuppressedbooleanIndicates whether the alert is suppressed. Suppressed alerts do not create a parent incident.
SeveritystringThe severity level of the alert as reported by the monitoring tool. Possible values: info, warning, error, critical.
IntegrationIDstringThe unique identifier of the integration that triggered the alert.
BatchDatedatetimeThe date and time data was synced to our database.

PagerDutyIncidentNotes

NameTypeDescription
ConfigIDintegerThe ID of the configuration within Compyl.
IDstringA unique identifier for the note.
IncidentIDstringThe unique identifier of the incident this note belongs to.
UserIDstringThe identifier of the user who created the note. If the note was created by a service, the user type will be bot_user_reference, and the summary will reflect the service name instead of a user.
ChannelIDstringAn identifier representing the source of the note (e.g. API, web portal, automation rule).
ChannelTypestringThe type of channel through which the note was created. Possible values include: user_reference, bot_user_reference, or event_rule_reference.
ChannelSummarystringA human-readable description of the note's source, such as "The PagerDuty website or APIs" or "A Global Event Rule."
ChannelHTMLURLstringA URL to the web interface where the channel can be viewed.
ContentstringThe actual text content of the note.
CreatedAtdatetimeThe timestamp when the note was created.
BatchDatedatetimeThe date and time data was synced to our database.

PagerDutyIncidents

NameTypeDescription
ConfigIDintegerThe ID of the configuration within Compyl.
IDstringThe unique identifier for the incident.
TypestringThe type of object.
SummarystringA brief, auto-generated description of the incident, suitable for labeling in UI components.
HTMLURLstringA direct URL to view the incident in the PagerDuty web application.
IncidentNumberintegerA unique number assigned to the incident across the PagerDuty account.
TitlestringA succinct description of the nature or cause of the incident.
CreatedAtdatetimeThe timestamp indicating when the incident was first triggered.
UpdatedAtdatetimeThe timestamp indicating when the incident was last updated.
StatusstringThe current status of the incident. Possible values: triggered, acknowledged, resolved.
IncidentKeystringA de-duplication key used to identify and group related incidents.
ServiceIDstringThe ID of the PagerDuty service associated with the incident.
AssignedViastringIndicates how the incident was assigned. Possible values: escalation_policy, direct_assignment.
LastStatusChangeAtdatetimeThe timestamp when the incident’s status last changed (e.g., when it was acknowledged or resolved).
ResolvedAtdatetimeThe timestamp when the incident was resolved. Null if unresolved.
FirstTriggerLogEntryIDstringThe ID of the first log entry that triggered the incident.
FirstTriggerLogEntryTypestringThe type of log entry that initially triggered the incident. Possible values include: trigger_log_entry_reference, resolve_log_entry_reference
FirstTriggerLogEntrySummarystringA brief description of the first log entry that triggered the incident.
FirstTriggerLogEntryHTMLURLstringA direct URL to view the first log entry in the PagerDuty web application.
AllAlertsCountintegerThe total count of alerts grouped into this incident.
TriggeredAlertsCountintegerThe count of alerts currently in a triggered state.
ResolvedAlertsCountintegerThe count of alerts that have been resolved.
IsMergeablebooleanIndicates whether the incident can be merged with other incidents. Only incidents with alerts or manually created incidents can be merged.
IncidentTypestringThe type of incident, such as incident_default.
EscalationPolicyIDstringThe ID of the escalation policy associated with the incident.
TeamIDstringThe ID of the team responsible for the incident.
AlertGroupingTypestringThe method used for alert grouping. Possible values: basic, advanced, rules.
AlertGroupingStartedAtdatetimeThe timestamp when alert grouping started for the incident.
AlertGroupingEndedAtdatetimeThe timestamp when alert grouping ended for the incident. Null if still active.
AlertGroupingActivebooleanIndicates whether alert grouping is currently active for the incident.
LastStatusChangeByIDstringThe ID of the user, service, or integration that last changed the incident’s status.
LastStatusChangeByTypestringThe type of entity that last changed the incident’s status. Possible values: user_reference, service_reference, integration_reference.
PriorityIDstringThe ID of the priority level assigned to the incident.
UrgencystringThe urgency level of the incident. Possible values: high, low.
BatchDatedatetimeThe date and time data was synced to our database.

PagerDutyIncidentTypes

NameTypeDescription
ConfigIDintegerThe ID of the configuration within Compyl.
IDstringUnique identifier for the incident type.
TypestringDefines the schema of the incident type object. The expected value is incident_type, or incident_type_reference if it is a reference to another type.
NamestringThe name of the incident type. Example values: incident_default, security.
CreatedAtdatetimeThe timestamp when the incident type was created. Example: 2019-12-01T20:00:00Z.
UpdatedAtdatetimeThe timestamp when the incident type was last modified. Example: 2019-12-01T21:02:00Z.
DescriptionstringA succinct description of the incident type. Example: Security related incidents.
DisplayNamestringA user-friendly name for the incident type. The first character must be alphanumeric. It must be unique. Example: Base Incident, Security.
EnabledbooleanIndicates whether the incident type is active (true) or disabled (false).
ParentIDstringThe ID of the parent incident type. If null, the type is a top-level incident type. Example: P1234 if this type belongs to a parent.
ParentTypestringIndicates the type of the parent object. Expected value: incident_type_reference when referencing another incident type.
BatchDatedatetimeThe date and time data was synced to our database.

PagerDutyLicenseAllocations

NameTypeDescription
ConfigIDintegerThe ID of the configuration within Compyl.
LicenseIDstringThe unique identifier for the license.
UserIDstringThe unique identifier for the user who has been allocated the license.
AllocatedAtdatetimeThe date and time when the license was allocated to the user.
BatchDatedatetimeThe date and time data was synced to our database.

PagerDutyLicenses

NameTypeDescription
ConfigIDintegerThe ID of the configuration within Compyl.
IDstringUniquely identifies the license.
NamestringThe name of the license, e.g., Business (Full User).
DescriptionstringA description of the license, which may include the names of add-ons if applicable.
CurrentValueintegerThe number of these licenses that are currently allocated to users.
AllocationsAvailableintegerThe number of these licenses that are available to be allocated to users. If this value is null, then there is no limit on the number of allocations allowed.
ValidRolesstringA comma-separated list of roles that a user with this license can have. Possible values include: owner, admin, user, limited_user, observer, restricted_access, read_only_user, and read_only_limited_user.
RoleGroupstringIndicates whether this license is assignable to full or stakeholder users. Allowed values: FullUser, Stakeholder.
SummarystringA summary of the license, typically matching the name.
TypestringIdentifies the object type.
HTMLURLstringThe HTML URL for accessing the license in the PagerDuty UI.
BatchDatedatetimeThe date and time data was synced to our database.

PagerDutyMaintenanceWindows

NameTypeDescription
ConfigIDintegerThe ID of the configuration within Compyl.
IDstringA unique identifier for the maintenance window.
TypestringThe type of object.
SummarystringA short-form, server-generated string providing key details about the maintenance window.
HTMLURLstringA web URL where the maintenance window can be accessed directly in PagerDuty’s UI.
SequenceNumberintegerThe order in which the maintenance window was created.
StartTimedatetimeThe start time of the maintenance window.
EndTimedatetimeThe end time of the maintenance window.
DescriptionstringA human-readable description of the maintenance window, often providing details about why it was scheduled.
CreatedBystringThe user who created the maintenance window.
BatchDatedatetimeThe date and time data was synced to our database.

PagerDutyOnCalls

NameTypeDescription
ConfigIDintegerThe ID of the configuration within Compyl.
IDintegerA unique identifier for the on-call record.
UserIDstringThe unique identifier of the user assigned to the on-call shift.
ScheduleIDstringThe unique identifier of the schedule that the user is assigned to.
EscalationPolicyIDstringThe unique identifier of the escalation policy associated with this on-call record.
EscalationLevelintegerThe escalation level for this on-call record.
StartdatetimeThe start time of the on-call period.
EnddatetimeThe end time of the on-call period.
BatchDatedatetimeThe date and time data was synced to our database.

PagerDutyPastIncidents

NameTypeDescription
ConfigIDintegerThe ID of the configuration within Compyl.
IDstringThe globally unique identifier of the incident.
CreatedAtdatetimeThe timestamp when the incident was first triggered.
TitlestringA description of the incident, including its nature, symptoms, cause, or effect.
ScorefloatA computed similarity score indicating how closely this incident relates to a parent incident.
IncidentIDstringThe unique identifier of the related incident, if available.
BatchDatedatetimeThe date and time data was synced to our database.

PagerDutyPriorities

NameTypeDescription
ConfigIDintegerThe ID of the configuration within Compyl.
IDstringThe globally unique identifier for the priority level.
TypestringThe type of priority.
SummarystringA brief summary describing the priority.
NamestringThe human-readable name of the priority level.
DescriptionstringA longer, more detailed explanation of what this priority represents.
BatchDatedatetimeThe date and time data was synced to our database.

PagerDutyRelatedIncidents

NameTypeDescription
ConfigIDintegerThe ID of the configuration within Compyl.
IDstringThe unique identifier for a related incident entry.
CreatedAtdatetimeThe timestamp when the related incident was first recorded.
TitlestringA succinct description of the related incident, detailing its symptoms, cause, or impact.
IncidentIDstringThe unique identifier of the primary incident that this related incident is associated with.
BatchDatedatetimeThe date and time data was synced to our database.

PagerDutySchedules

NameTypeDescription
ConfigIDintegerThe ID of the configuration within Compyl.
IDstringThe unique identifier for the schedule.
TypestringThe type of the object.
SummarystringA short, system-generated summary of the schedule.
HTMLURLstringThe URL where the schedule can be viewed in the PagerDuty web app.
NamestringThe name of the schedule.
TimeZonestringThe time zone in which the schedule operates.
DescriptionstringA human-readable description of the schedule, typically explaining its purpose.
BatchDatedatetimeThe date and time data was synced to our database.

PagerDutyServices

NameTypeDescription
ConfigIDintegerThe ID of the configuration within Compyl.
IDstringUnique identifier for the service in PagerDuty.
SummarystringA short-form description of the service, usually auto-generated. Often identical to the service name.
TypestringThe type of object, always set to service.
HTMLURLstringA URL to view the service in the PagerDuty web app.
NamestringThe user-defined name of the service.
AutoResolveTimeoutintegerTime in seconds before an unresolved incident is automatically closed.
AcknowledgementTimeoutintegerTime in seconds before an acknowledged incident moves back to triggered state.
CreatedAtdatetimeThe timestamp when this service was created in PagerDuty.
StatusstringThe current status of the service.
AlertGroupingTypestringDefines how alerts are grouped into incidents.
AlertGroupingTimeWindowintegerThe maximum time in seconds between alerts to be grouped together.
AlertGroupingRecommendedTimeWindowintegerSystem-recommended time window for alert grouping based on previous alert patterns.
EscalationPolicyIDstringThe ID of the escalation policy associated with this service.
IncidentUrgencyRuleTypestringDetermines if the incident urgency is constant or dependent on support hours. Allowed values: constant, use_support_hours. Default: constant
IncidentUrgencystringThe urgency level for incidents when the rule type is constant. Allowed values: low, high, severity_based. Default: high.
SupportHoursTypestringThe type of support hours. Allowed value: fixed_time_per_day. Default: fixed_time_per_day.
SupportHoursTimeZonestringThe time zone for the support hours, formatted in ActiveSupport time zone format
SupportHoursStartTimetimeThe start time for support hours.
SupportHoursEndTimetimeThe end time for support hours.
DaysOfWeekstringComma-separated list of days (1 = Monday, 7 = Sunday) when support hours apply.
AutoPauseNotificationsEnabledbooleanIf true, alerts identified as transient will be delayed before triggering.
AutoPauseNotificationsTimeoutintegerTime in seconds to delay transient alerts before triggering. Allowed values: 0, 120, 180, 300, 600, 900.
AutoPauseNotificationsRecommendedTimeoutintegerRecommended timeout for delaying transient alerts, based on prior alert patterns.
BatchDatedatetimeThe date and time data was synced to our database.

PagerDutyStandards

NameTypeDescription
ConfigIDintegerThe ID of the configuration within Compyl.
IDstringThe unique identifier for the standard.
ActivebooleanIndicates whether the standard is currently active (true) or inactive (false).
DescriptionstringA human-readable explanation of the standard's purpose.
ExclusionsstringA list of specific exceptions where this standard does not apply.
InclusionsstringA list of services or entities that must comply with this standard.
NamestringThe human-readable name of the standard.
ResourceTypestringThe type of resource the standard applies to.
TypestringA predefined classification of the standard, indicating its purpose.
BatchDatedatetimeThe date and time data was synced to our database.

PagerDutyTeams

NameTypeDescription
ConfigIDintegerThe ID of the configuration within Compyl.
IDstringThe unique identifier for the team in PagerDuty.
TypestringThe type of object. Allowed value: team. Default: team.
SummarystringA short, server-generated description of the team.
HTMLURLstringThe unique URL in the PagerDuty web app where the team can be viewed.
NamestringThe name of the team.
DescriptionstringA detailed description of the team, explaining its role or function.
BatchDatedatetimeThe date and time data was synced to our database.

PagerDutyUsers

NameTypeDescription
ConfigIDintegerThe ID of the configuration within Compyl.
IDstringThe unique identifier for the user in PagerDuty.
TypestringThe type of object being stored. The allowed value is always user.
SummarystringA short, system-generated summary of the user, often identical to the user's name but intended for labeling purposes.
HTMLURLstringA web URL linking to the user’s profile in the PagerDuty web application.
NamestringThe full name of the user.
EmailstringThe email address of the user.
TimeZonestringThe user's preferred time zone. If null, the account’s default time zone is used.
ColorstringThe user's assigned color in the PagerDuty UI, typically used in scheduling.
RolestringThe role assigned to the user in PagerDuty. Possible values: admin, limited_user, observer, owner, read_only_user, restricted_access, read_only_limited_user, user.
DescriptionstringA bio or description of the user.
InvitationSentbooleanIndicates whether an invitation has been sent to the user. true means an outstanding invitation exists.
JobTitlestringThe user’s job title.
BatchDatedatetimeThe date and time data was synced to our database.

PagerDutyVendors

NameTypeDescription
ConfigIDintegerThe ID of the configuration within Compyl.
IDstringUnique identifier for the vendor.
TypestringA string that determines the schema of the object. This must be the standard name for the entity, suffixed by _reference if the object is a reference.
SummarystringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to name, though it is not intended to be an identifier.
NamestringThe short name of the vendor.
WebsiteURLstringURL of the vendor's main website.
LogoURLstringURL of a logo identifying the vendor.
ThumbnailURLstringURL of a small thumbnail image identifying the vendor.
DescriptionstringA short description of this vendor, and common use-cases of integrations for this vendor.
IntegrationGuideURLstringURL of an integration guide for this vendor.
BatchDatedatetimeThe date and time data was synced to our database.

Bridge Tables

PagerDutyBusinessServices_PagerDutyIncidents

NameTypeDescription
BusinessServiceIDstringUnique identifier of the business service that was impacted by the incident.
IncidentIDstringUnique identifier of the incident.
ConfigIDintegerThe ID of the configuration within Compyl.

PagerDutyChangeEvents_PagerDutyServices

NameTypeDescription
ChangeEventIDstringThe ID of the ChangeEvent.
ServiceIDstringThe ID of the Service.
ConfigIDintegerThe ID of the configuration within Compyl.

PagerDutyEscalationPolicies_PagerDutySchedules

NameTypeDescription
EscalationPolicyIDstringThe ID of the EscalationPolicy.
ScheduleIDstringThe ID of the Schedule.
ConfigIDintegerThe ID of the configuration within Compyl.

PagerDutyMaintenanceWindows_PagerDutyServices

NameTypeDescription
MaintenanceWindowIDstringThe ID of the Maintenance Window.
ServiceIDstringThe ID of the Service.
ConfigIDintegerThe ID of the configuration within Compyl.

PagerDutySchedules_PagerDutyUsers

NameTypeDescription
ScheduleIDstringThe ID of the Schedule.
UserIDstringThe ID of the User.
ConfigIDintegerThe ID of the configuration within Compyl.

PagerDutyTeams_PagerDutyUsers

NameTypeDescription
TeamIDstringThe ID of the Team.
UserIDstringThe ID of the User.
ConfigIDintegerThe ID of the configuration within Compyl.

Permission Scopes

Scopes
users.read
teams.read
addons.read
escalation_policies.read
services.read
licenses.read
schedules.read
oncalls.read
incidents.read
incident_types.read
priorities.read
change_events.read

Did this page help you?