Connect to PagerDuty

You can connect to PagerDuty using Retool's REST API integration and make it available as a resource. Once complete, you can write queries to interact with the PagerDuty API.

Requirements

All users for Retool organizations on Free or Team plans have global Edit permissions and can add, edit, and remove resources. If your organization manages user permissions for resources, you must be a member of a group with Edit all permissions.

To create your PagerDuty resource, you need:

• REST API connection details.
• A valid API key.

PagerDuty uses API token authentication. You must provide an API token for Retool to authorize requests. Refer to the PagerDuty documentation on authenticating requests to learn how to obtain an API token.

If PagerDuty is behind a firewall, you must also allow access from Retool's IP addresses. Add these IP addresses to your firewall's allowlist before you create the resource.

1. Create a new resource

Sign in to your Retool organization and navigate to the Resources tab. Click Create new, then select Resource.

Retool can connect to almost any API or database, and has built-in integrations for popular data sources. Select the REST API integration.

2. Configure the resource

Provide the necessary details to configure the resource so Retool can connect to PagerDuty. Not all settings are required, but refer to the PagerDuty documentation to learn what is needed.

General

These settings configure the name and location of the resource within Retool.

Name

The name to use for the resource (e.g., PagerDuty).

Folder

The folder in which to save the resource.

Description

A brief description of the resource (e.g., Customer data).

Credentials

These settings configure how Retool connects to PagerDuty.

Base URL

The base URL for the PagerDuty API. This must be an absolute URL. Use https://api.pagerduty.com.

URL parameters

Key-value pairs to include as URL parameters with PagerDuty API requests. No additional URL parameters are required.

Headers

Key-value pairs to include as headers with PagerDuty API requests. PagerDuty uses API token authentication, which includes your API key or token as a header value. Include the following key-value pairs:

Body

Key-value pairs to include in the body of PagerDuty API requests. No additional body values are required.

Cookies

Cookies to include with PagerDuty API requests. No cookies are required.

Authentication

The method of authentication to use with PagerDuty. Select None. PagerDuty authenticates requests using the API token you specified as a header value.

Forward all cookies

Whether to forward all cookies. This is useful if you have dynamic cookie names.

3. Save the resource

Click Create resource to complete the setup. You can then click either Create an app to immediately start building a Retool app or Back to resources to return to the list of resources.

Wrap up

Your PagerDuty resource is now ready to use. You write queries to make API requests by specifying the request method and endpoint, additional parameters to include, and the request body.

To verify you can successfully interact with PagerDuty, write a test query to retrieve some data. The following example retrieves a list of incidents.

GET https://api.pagerduty.com/notifications

{
  "notifications": [
    {
      "id": "PWL7QXS",
      "type": "phone_notification",
      "started_at": "2013-03-06T15:28:51-05:00",
      "address": "+15555551234",
      "user": {
        "id": "PT23IWX",
        "type": "user_reference",
        "summary": "Tim Wright",
        "self": "https://api.pagerduty.com/users/PT23IWX",
        "html_url": "https://subdomain.pagerduty.com/users/PT23IWX"
      }
    },
  ],
  "limit": 100,
  "offset": 0,
  "more": false,
  "total": null
}