PagerDuty

Last updated on Nov 28, 2023

PagerDuty is a SaaS-based platform that gives business leaders, DevOps, developers, and IT operations the tools they need to avoid and handle business-impacting crises and provide excellent customer service. PagerDuty puts the appropriate information in the hands of the right people in real-time, every time, because of native integrations, on-call scheduling and escalations, machine learning, business-wide response orchestration, analytics, and more.

PagerDuty authenticates API requests from Hevo to access your account data with HTTP Basic authentication.


Prerequisites


Obtaining the API Key

You require an API key to authenticate Hevo on your PagerDuty account.

Note: You must log in as an Account Owner or an Admin user to perform these steps.

To create the API key:

  1. Log in to your PagerDuty account.

  2. In the top navigation bar, click Integrations, and then click API Access Keys from the drop-down.

    Integrations

  3. In the API Access Keys page, click + Create New API Key.

    API Access Keys

  4. In the Create API Key dialog, provide a description for this API key to help you identify it, and then click Create Key.

    Create Key

  5. Copy the API key and save it securely like any other password. Use this key while configuring your Hevo Pipeline.

    Copy API Key


Configuring PagerDuty as a Source

Perform the following steps to configure PagerDuty as the Source in your Pipeline:

  1. Click PIPELINES in the Navigation Bar.

  2. Click + CREATE in the Pipelines List View.

  3. In the Select Source Type page, select PagerDuty.

  4. In the Configure your PagerDuty Source page, specify the following:

    Source config

    • Pipeline Name: A unique name for the Pipeline, not exceeding 255 characters.

    • API Key: The API key that you obtained from your PagerDuty account.

  5. Click TEST & CONTINUE.

  6. Proceed to configuring the data ingestion and setting up the Destination.


Data Replication

Default Pipeline Frequency Minimum Pipeline Frequency Maximum Pipeline Frequency Custom Frequency Range (Hrs)
1 Hr 1 Hr 24 Hrs 1-24

Note: You must set the custom frequency in hours as an integer value. For example, 1, 2, 3 but not 1.5 or 1.75.


Source Considerations

  • Pagination: An API response for each PagerDuty object fetches one page with a maximum of 100 records. However, you can configure PagerDuty using the REST API to retrieve up to 10,000 records via pagination, with the sum of limit and offset parameters not exceeding 10,000. Here, the limit is the maximum number of records that can be fetched by the API on each call, and the offset value is from which the API starts fetching in each subsequent run of Pipeline. Read Pagination for more information.

  • Rate Limit: PagerDuty imposes a limit of 900 API calls per minute per organization. If the limit is exceeded, Hevo defers the ingestion till the limits reset. Read API Rate Limits to know more about rate limits, and configure a suitable ingestion frequency for your Pipeline.


Schema and Primary Keys

Hevo uses the following schema to upload the records to the Destination database:


Data Model

The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:

Object Mode Description
Business Services Full Load Contains the details of all the incidents affecting the business.
Change Events Incremental Contains the details of the updates to the product or system. For example, configuration changes.
Escalation Policies Full Load Contains the details of all the guidelines defined for service escalations. An escalation policy automates incident assignment and connects services with individual users.
Extension Schemas Full Load Contains the details of all the extensions used by the employees to communicate inside or outside the organization. For example, Slack, Generic Webhook and more.
Extensions Full Load Contains the details of all the applications attached to a service, to receive incident updates.
Incidents Full Load Contains the details of an issue that has occurred in a system and needs to be resolved.
Log Entries Incremental Contains the details of all the events and changes that happened at the time of the incident.
Maintenance Windows Full Load Contains the details of services temporarily disabled by PagerDuty for a set period of time.
Oncalls Full Load Contains the details of all the users available for responding to any incident, at a given point of time.
Rulesets Full Load Contains the details of the set of rules for creating and routing of events.
Schedules Full Load Contains the details of all the available on-call time slots for the users.
Services Full Load Contains the details of all the entities that you monitor, such as emails and databases.
Tags Full Load Contains the details about the label that is used to organize escalation policies, teams, or users into multiple categories.
Teams Full Load Contains the details of a group of users that represent an organization.
Users Full Load Contains the details of all the users that have access to the PagerDuty account.
Vendors Full Load Contains the details of all the third-party applications that can be integrated into PagerDuty.

Limitations

  • Hevo does not capture information for records deleted in the Source objects.

  • Hevo does not provide you with the option to select the historical sync duration for loading historical data. All the historical data in your Harvest account is loaded.


Revision History

Refer to the following table for the list of key updates made to this page:

Date Release Description of Change
Oct-03-2023 NA Updated the section, Obtaining the API Key as per the latest PagerDuty UI.
Feb-17-2023 NA Updated section, Source Considerations to add information about pagination limit using RestAPI.
Oct-17-2022 1.98 New document.

Tell us what went wrong