Skip to content

PagerDuty

PagerDuty is an incident management platform that helps IT and DevOps teams quickly monitor and resolve critical issues.

Integrating a PagerDuty connection on your Hawkeye dashboard enhances our incident response capabilities by allowing you to receive and manage alerts in real-time.

To set up a PagerDuty connection, you must create an API key, which you’ll need as a credential. The following steps will guide you in creating one.

Step 1: Create an API Key

Sign in to your PagerDuty dashboard and follow the instructions below:

  1. Navigate to API Access Keys: Locate and click on the Integrations tab on the navigation bar. In the dropdown menu, click on API Access Keys to manage API keys.

    pagerduty

  2. Create a new API Key: On the API Access Keys page, click the button labeled Create New API Key.

    pagerduty-3

  3. Input Description: Provide a description for the API key and select the checkbox if you need a Read-only API Key. This will determine the level of access your API key has. The other option is Full access.

    pagerduty-2

    After that, click on Create Key to create your API Key.

  4. After creating your API key, you’ll have a table containing the following parameters:

    pagerduty-1

    • ID: A unique identifier associated with the API key.
    • API Key: This is the unique alphanumeric string generated by PagerDuty when you create a new API key.
    • Description: This field contains the name or a brief description you gave when creating the key.
    • Created: This parameter shows the exact date, time, and the name of the person or system that generated the API key.
    • API Version: Indicates the version of the PagerDuty API that the key is using.
    • Access Level: Specifies the level of access the API key provides. This could range from read-only permissions to complete control over incidents, users, and other PagerDuty operations.
    • Disabled: This field indicates whether the API key is currently disabled. If a key is disabled, it cannot be used for authentication until it is re-enabled.

Step 2: Add PagerDuty connection to Hawkeye

With your API Key ready, navigate to the Hawkeye dashboard and follow these next steps:

  1. Navigate to the connections tab: On the dashboard, navigate to the Connections section and select the New Coonnection card.

    pagerduty-4

  2. Select PagerDuty connection: Select PagerDuty from the list of available connections.

    pagerduty-5

    After this, click on the Next button in the top right corner.

  3. Enter credentials: Provide the following credentials:

    pagerduty-6

    • Name: This is the name of the connection you’re about to create.
    • Description: This gives an overview of the connection.
    • API Key: This is the PagerDuty API Key you created in Step 1.

    Verify all the credentials are correct and click the Save button at the top right corner.

  4. Confirm that the PagerDuty connection was successfully created. If it did, you’ll see the connection card display like this on the Connections tab:

    pagerduty-7