PagerDuty Tables and Scopes
The PagerDuty integration uses the following tables and permissions
Tables
PagerDutyAddOns
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | The ID of the configuration within Compyl. |
| ID | string | Unique identifier for the Addon. |
| Type | string | A 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 |
| Summary | string | A 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. |
| HTMLURL | string | A URL at which the entity is uniquely displayed in the Web app |
| Name | string | The user entered name of the Addon. |
| SRC | string | The URL source of the Addon. |
| BatchDate | datetime | The date and time data was synced to our database. |
PagerDutyBusinessServices
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | The ID of the configuration within Compyl. |
| ID | string | Unique identifier of the business service. |
| Description | string | The user-provided description of the business service. |
| HTMLURL | string | A URL at which the entity is uniquely displayed in the Web app. |
| Name | string | The name of the business service. |
| PointOfContact | string | The point of contact assigned to this service. |
| Summary | string | A 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. |
| TeamID | string | Reference to the team that owns the business service. |
| Type | string | A 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. |
| BatchDate | datetime | The date and time data was synced to our database. |
PagerDutyChangeEvents
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | The ID of the configuration within Compyl. |
| ID | string | A unique identifier for the change event. |
| Summary | string | A brief text summary describing the change event. |
| Timestamp | datetime | The date and time when the event was detected or generated by the emitting tool. |
| Type | string | The type of event being recorded. |
| Source | string | The system or tool that triggered the change event. This represents the origin of the change (e.g. CI/CD pipeline, monitoring system). |
| IntegrationID | string | The unique identifier of the integration that sent this change event. |
| BatchDate | datetime | The date and time data was synced to our database. |
PagerDutyEscalationPolicies
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | The ID of the configuration within Compyl. |
| ID | string | The unique identifier of the escalation policy in PagerDuty. |
| Type | string | The type of the object. |
| Summary | string | A short-form summary of the escalation policy, typically used for labeling in the UI. |
| OnCallHandoffNotifications | string | Determines how on-call handoff notifications will be sent. |
| HTMLURL | string | The URL for viewing the escalation policy in the PagerDuty web interface. |
| Name | string | The name of the escalation policy. |
| NumLoops | integer | The number of times the escalation policy will repeat after reaching the end of its escalation. |
| TeamID | string | The ID of the team associated with this escalation policy. |
| BatchDate | datetime | The date and time data was synced to our database. |
PagerDutyEscalationPolicyRules
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | The ID of the configuration within Compyl. |
| RuleID | string | A unique identifier for the escalation rule. |
| TargetID | string | The identifier of the target (user or schedule) to which incidents are assigned when the rule is triggered. |
| EscalationDelayInMinutes | integer | The number of minutes before an unacknowledged incident escalates to the next rule in the policy. |
| TargetSummary | string | A short-form description of the escalation target (e.g., user or schedule name). |
| TargetType | string | The type of the escalation target, which can be one of the following: user, schedule, user_reference, or schedule_reference. |
| TargetHTMLURL | string | The URL of the escalation target in the PagerDuty web app. |
| EscalationPolicyID | string | The identifier of the escalation policy to which this rule belongs. |
| BatchDate | datetime | The date and time data was synced to our database. |
PagerDutyIncidentAlerts
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | The ID of the configuration within Compyl. |
| ID | string | The unique identifier of the alert. |
| Type | string | The type of object being stored. |
| Summary | string | A short-form description of the alert, summarizing the key details. |
| HTMLURL | string | A URL where the alert can be viewed in the PagerDuty web application. |
| CreatedAt | datetime | The date and time when the alert was first triggered. |
| Status | string | The current status of the alert. Possible values: triggered, resolved. |
| AlertKey | string | The unique de-duplication key for the alert, used to group related alerts together. |
| ServiceID | string | The unique identifier of the service associated with the alert. |
| IncidentID | string | The unique identifier of the incident to which this alert is linked. |
| Suppressed | boolean | Indicates whether the alert is suppressed. Suppressed alerts do not create a parent incident. |
| Severity | string | The severity level of the alert as reported by the monitoring tool. Possible values: info, warning, error, critical. |
| IntegrationID | string | The unique identifier of the integration that triggered the alert. |
| BatchDate | datetime | The date and time data was synced to our database. |
PagerDutyIncidentNotes
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | The ID of the configuration within Compyl. |
| ID | string | A unique identifier for the note. |
| IncidentID | string | The unique identifier of the incident this note belongs to. |
| UserID | string | The 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. |
| ChannelID | string | An identifier representing the source of the note (e.g. API, web portal, automation rule). |
| ChannelType | string | The type of channel through which the note was created. Possible values include: user_reference, bot_user_reference, or event_rule_reference. |
| ChannelSummary | string | A human-readable description of the note's source, such as "The PagerDuty website or APIs" or "A Global Event Rule." |
| ChannelHTMLURL | string | A URL to the web interface where the channel can be viewed. |
| Content | string | The actual text content of the note. |
| CreatedAt | datetime | The timestamp when the note was created. |
| BatchDate | datetime | The date and time data was synced to our database. |
PagerDutyIncidents
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | The ID of the configuration within Compyl. |
| ID | string | The unique identifier for the incident. |
| Type | string | The type of object. |
| Summary | string | A brief, auto-generated description of the incident, suitable for labeling in UI components. |
| HTMLURL | string | A direct URL to view the incident in the PagerDuty web application. |
| IncidentNumber | integer | A unique number assigned to the incident across the PagerDuty account. |
| Title | string | A succinct description of the nature or cause of the incident. |
| CreatedAt | datetime | The timestamp indicating when the incident was first triggered. |
| UpdatedAt | datetime | The timestamp indicating when the incident was last updated. |
| Status | string | The current status of the incident. Possible values: triggered, acknowledged, resolved. |
| IncidentKey | string | A de-duplication key used to identify and group related incidents. |
| ServiceID | string | The ID of the PagerDuty service associated with the incident. |
| AssignedVia | string | Indicates how the incident was assigned. Possible values: escalation_policy, direct_assignment. |
| LastStatusChangeAt | datetime | The timestamp when the incident’s status last changed (e.g., when it was acknowledged or resolved). |
| ResolvedAt | datetime | The timestamp when the incident was resolved. Null if unresolved. |
| FirstTriggerLogEntryID | string | The ID of the first log entry that triggered the incident. |
| FirstTriggerLogEntryType | string | The type of log entry that initially triggered the incident. Possible values include: trigger_log_entry_reference, resolve_log_entry_reference |
| FirstTriggerLogEntrySummary | string | A brief description of the first log entry that triggered the incident. |
| FirstTriggerLogEntryHTMLURL | string | A direct URL to view the first log entry in the PagerDuty web application. |
| AllAlertsCount | integer | The total count of alerts grouped into this incident. |
| TriggeredAlertsCount | integer | The count of alerts currently in a triggered state. |
| ResolvedAlertsCount | integer | The count of alerts that have been resolved. |
| IsMergeable | boolean | Indicates whether the incident can be merged with other incidents. Only incidents with alerts or manually created incidents can be merged. |
| IncidentType | string | The type of incident, such as incident_default. |
| EscalationPolicyID | string | The ID of the escalation policy associated with the incident. |
| TeamID | string | The ID of the team responsible for the incident. |
| AlertGroupingType | string | The method used for alert grouping. Possible values: basic, advanced, rules. |
| AlertGroupingStartedAt | datetime | The timestamp when alert grouping started for the incident. |
| AlertGroupingEndedAt | datetime | The timestamp when alert grouping ended for the incident. Null if still active. |
| AlertGroupingActive | boolean | Indicates whether alert grouping is currently active for the incident. |
| LastStatusChangeByID | string | The ID of the user, service, or integration that last changed the incident’s status. |
| LastStatusChangeByType | string | The type of entity that last changed the incident’s status. Possible values: user_reference, service_reference, integration_reference. |
| PriorityID | string | The ID of the priority level assigned to the incident. |
| Urgency | string | The urgency level of the incident. Possible values: high, low. |
| BatchDate | datetime | The date and time data was synced to our database. |
PagerDutyIncidentTypes
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | The ID of the configuration within Compyl. |
| ID | string | Unique identifier for the incident type. |
| Type | string | Defines 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. |
| Name | string | The name of the incident type. Example values: incident_default, security. |
| CreatedAt | datetime | The timestamp when the incident type was created. Example: 2019-12-01T20:00:00Z. |
| UpdatedAt | datetime | The timestamp when the incident type was last modified. Example: 2019-12-01T21:02:00Z. |
| Description | string | A succinct description of the incident type. Example: Security related incidents. |
| DisplayName | string | A user-friendly name for the incident type. The first character must be alphanumeric. It must be unique. Example: Base Incident, Security. |
| Enabled | boolean | Indicates whether the incident type is active (true) or disabled (false). |
| ParentID | string | The 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. |
| ParentType | string | Indicates the type of the parent object. Expected value: incident_type_reference when referencing another incident type. |
| BatchDate | datetime | The date and time data was synced to our database. |
PagerDutyLicenseAllocations
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | The ID of the configuration within Compyl. |
| LicenseID | string | The unique identifier for the license. |
| UserID | string | The unique identifier for the user who has been allocated the license. |
| AllocatedAt | datetime | The date and time when the license was allocated to the user. |
| BatchDate | datetime | The date and time data was synced to our database. |
PagerDutyLicenses
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | The ID of the configuration within Compyl. |
| ID | string | Uniquely identifies the license. |
| Name | string | The name of the license, e.g., Business (Full User). |
| Description | string | A description of the license, which may include the names of add-ons if applicable. |
| CurrentValue | integer | The number of these licenses that are currently allocated to users. |
| AllocationsAvailable | integer | The 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. |
| ValidRoles | string | A 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. |
| RoleGroup | string | Indicates whether this license is assignable to full or stakeholder users. Allowed values: FullUser, Stakeholder. |
| Summary | string | A summary of the license, typically matching the name. |
| Type | string | Identifies the object type. |
| HTMLURL | string | The HTML URL for accessing the license in the PagerDuty UI. |
| BatchDate | datetime | The date and time data was synced to our database. |
PagerDutyMaintenanceWindows
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | The ID of the configuration within Compyl. |
| ID | string | A unique identifier for the maintenance window. |
| Type | string | The type of object. |
| Summary | string | A short-form, server-generated string providing key details about the maintenance window. |
| HTMLURL | string | A web URL where the maintenance window can be accessed directly in PagerDuty’s UI. |
| SequenceNumber | integer | The order in which the maintenance window was created. |
| StartTime | datetime | The start time of the maintenance window. |
| EndTime | datetime | The end time of the maintenance window. |
| Description | string | A human-readable description of the maintenance window, often providing details about why it was scheduled. |
| CreatedBy | string | The user who created the maintenance window. |
| BatchDate | datetime | The date and time data was synced to our database. |
PagerDutyOnCalls
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | The ID of the configuration within Compyl. |
| ID | integer | A unique identifier for the on-call record. |
| UserID | string | The unique identifier of the user assigned to the on-call shift. |
| ScheduleID | string | The unique identifier of the schedule that the user is assigned to. |
| EscalationPolicyID | string | The unique identifier of the escalation policy associated with this on-call record. |
| EscalationLevel | integer | The escalation level for this on-call record. |
| Start | datetime | The start time of the on-call period. |
| End | datetime | The end time of the on-call period. |
| BatchDate | datetime | The date and time data was synced to our database. |
PagerDutyPastIncidents
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | The ID of the configuration within Compyl. |
| ID | string | The globally unique identifier of the incident. |
| CreatedAt | datetime | The timestamp when the incident was first triggered. |
| Title | string | A description of the incident, including its nature, symptoms, cause, or effect. |
| Score | float | A computed similarity score indicating how closely this incident relates to a parent incident. |
| IncidentID | string | The unique identifier of the related incident, if available. |
| BatchDate | datetime | The date and time data was synced to our database. |
PagerDutyPriorities
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | The ID of the configuration within Compyl. |
| ID | string | The globally unique identifier for the priority level. |
| Type | string | The type of priority. |
| Summary | string | A brief summary describing the priority. |
| Name | string | The human-readable name of the priority level. |
| Description | string | A longer, more detailed explanation of what this priority represents. |
| BatchDate | datetime | The date and time data was synced to our database. |
PagerDutyRelatedIncidents
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | The ID of the configuration within Compyl. |
| ID | string | The unique identifier for a related incident entry. |
| CreatedAt | datetime | The timestamp when the related incident was first recorded. |
| Title | string | A succinct description of the related incident, detailing its symptoms, cause, or impact. |
| IncidentID | string | The unique identifier of the primary incident that this related incident is associated with. |
| BatchDate | datetime | The date and time data was synced to our database. |
PagerDutySchedules
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | The ID of the configuration within Compyl. |
| ID | string | The unique identifier for the schedule. |
| Type | string | The type of the object. |
| Summary | string | A short, system-generated summary of the schedule. |
| HTMLURL | string | The URL where the schedule can be viewed in the PagerDuty web app. |
| Name | string | The name of the schedule. |
| TimeZone | string | The time zone in which the schedule operates. |
| Description | string | A human-readable description of the schedule, typically explaining its purpose. |
| BatchDate | datetime | The date and time data was synced to our database. |
PagerDutyServices
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | The ID of the configuration within Compyl. |
| ID | string | Unique identifier for the service in PagerDuty. |
| Summary | string | A short-form description of the service, usually auto-generated. Often identical to the service name. |
| Type | string | The type of object, always set to service. |
| HTMLURL | string | A URL to view the service in the PagerDuty web app. |
| Name | string | The user-defined name of the service. |
| AutoResolveTimeout | integer | Time in seconds before an unresolved incident is automatically closed. |
| AcknowledgementTimeout | integer | Time in seconds before an acknowledged incident moves back to triggered state. |
| CreatedAt | datetime | The timestamp when this service was created in PagerDuty. |
| Status | string | The current status of the service. |
| AlertGroupingType | string | Defines how alerts are grouped into incidents. |
| AlertGroupingTimeWindow | integer | The maximum time in seconds between alerts to be grouped together. |
| AlertGroupingRecommendedTimeWindow | integer | System-recommended time window for alert grouping based on previous alert patterns. |
| EscalationPolicyID | string | The ID of the escalation policy associated with this service. |
| IncidentUrgencyRuleType | string | Determines if the incident urgency is constant or dependent on support hours. Allowed values: constant, use_support_hours. Default: constant |
| IncidentUrgency | string | The urgency level for incidents when the rule type is constant. Allowed values: low, high, severity_based. Default: high. |
| SupportHoursType | string | The type of support hours. Allowed value: fixed_time_per_day. Default: fixed_time_per_day. |
| SupportHoursTimeZone | string | The time zone for the support hours, formatted in ActiveSupport time zone format |
| SupportHoursStartTime | time | The start time for support hours. |
| SupportHoursEndTime | time | The end time for support hours. |
| DaysOfWeek | string | Comma-separated list of days (1 = Monday, 7 = Sunday) when support hours apply. |
| AutoPauseNotificationsEnabled | boolean | If true, alerts identified as transient will be delayed before triggering. |
| AutoPauseNotificationsTimeout | integer | Time in seconds to delay transient alerts before triggering. Allowed values: 0, 120, 180, 300, 600, 900. |
| AutoPauseNotificationsRecommendedTimeout | integer | Recommended timeout for delaying transient alerts, based on prior alert patterns. |
| BatchDate | datetime | The date and time data was synced to our database. |
PagerDutyStandards
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | The ID of the configuration within Compyl. |
| ID | string | The unique identifier for the standard. |
| Active | boolean | Indicates whether the standard is currently active (true) or inactive (false). |
| Description | string | A human-readable explanation of the standard's purpose. |
| Exclusions | string | A list of specific exceptions where this standard does not apply. |
| Inclusions | string | A list of services or entities that must comply with this standard. |
| Name | string | The human-readable name of the standard. |
| ResourceType | string | The type of resource the standard applies to. |
| Type | string | A predefined classification of the standard, indicating its purpose. |
| BatchDate | datetime | The date and time data was synced to our database. |
PagerDutyTeams
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | The ID of the configuration within Compyl. |
| ID | string | The unique identifier for the team in PagerDuty. |
| Type | string | The type of object. Allowed value: team. Default: team. |
| Summary | string | A short, server-generated description of the team. |
| HTMLURL | string | The unique URL in the PagerDuty web app where the team can be viewed. |
| Name | string | The name of the team. |
| Description | string | A detailed description of the team, explaining its role or function. |
| BatchDate | datetime | The date and time data was synced to our database. |
PagerDutyUsers
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | The ID of the configuration within Compyl. |
| ID | string | The unique identifier for the user in PagerDuty. |
| Type | string | The type of object being stored. The allowed value is always user. |
| Summary | string | A short, system-generated summary of the user, often identical to the user's name but intended for labeling purposes. |
| HTMLURL | string | A web URL linking to the user’s profile in the PagerDuty web application. |
| Name | string | The full name of the user. |
| string | The email address of the user. | |
| TimeZone | string | The user's preferred time zone. If null, the account’s default time zone is used. |
| Color | string | The user's assigned color in the PagerDuty UI, typically used in scheduling. |
| Role | string | The role assigned to the user in PagerDuty. Possible values: admin, limited_user, observer, owner, read_only_user, restricted_access, read_only_limited_user, user. |
| Description | string | A bio or description of the user. |
| InvitationSent | boolean | Indicates whether an invitation has been sent to the user. true means an outstanding invitation exists. |
| JobTitle | string | The user’s job title. |
| BatchDate | datetime | The date and time data was synced to our database. |
PagerDutyVendors
| Name | Type | Description |
|---|---|---|
| ConfigID | integer | The ID of the configuration within Compyl. |
| ID | string | Unique identifier for the vendor. |
| Type | string | A 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. |
| Summary | string | A 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. |
| Name | string | The short name of the vendor. |
| WebsiteURL | string | URL of the vendor's main website. |
| LogoURL | string | URL of a logo identifying the vendor. |
| ThumbnailURL | string | URL of a small thumbnail image identifying the vendor. |
| Description | string | A short description of this vendor, and common use-cases of integrations for this vendor. |
| IntegrationGuideURL | string | URL of an integration guide for this vendor. |
| BatchDate | datetime | The date and time data was synced to our database. |
Bridge Tables
PagerDutyBusinessServices_PagerDutyIncidents
| Name | Type | Description |
|---|---|---|
| BusinessServiceID | string | Unique identifier of the business service that was impacted by the incident. |
| IncidentID | string | Unique identifier of the incident. |
| ConfigID | integer | The ID of the configuration within Compyl. |
PagerDutyChangeEvents_PagerDutyServices
| Name | Type | Description |
|---|---|---|
| ChangeEventID | string | The ID of the ChangeEvent. |
| ServiceID | string | The ID of the Service. |
| ConfigID | integer | The ID of the configuration within Compyl. |
PagerDutyEscalationPolicies_PagerDutySchedules
| Name | Type | Description |
|---|---|---|
| EscalationPolicyID | string | The ID of the EscalationPolicy. |
| ScheduleID | string | The ID of the Schedule. |
| ConfigID | integer | The ID of the configuration within Compyl. |
PagerDutyMaintenanceWindows_PagerDutyServices
| Name | Type | Description |
|---|---|---|
| MaintenanceWindowID | string | The ID of the Maintenance Window. |
| ServiceID | string | The ID of the Service. |
| ConfigID | integer | The ID of the configuration within Compyl. |
PagerDutySchedules_PagerDutyUsers
| Name | Type | Description |
|---|---|---|
| ScheduleID | string | The ID of the Schedule. |
| UserID | string | The ID of the User. |
| ConfigID | integer | The ID of the configuration within Compyl. |
PagerDutyTeams_PagerDutyUsers
| Name | Type | Description |
|---|---|---|
| TeamID | string | The ID of the Team. |
| UserID | string | The ID of the User. |
| ConfigID | integer | The 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 |
Updated over 1 year ago
Did this page help you?