Skip to Content
HomeCustomizing AuthPagerDuty

PagerDuty

The PagerDuty enables tools and to call PagerDuty APIs  on behalf of a using OAuth 2.0 authentication.

Want to quickly get started with PagerDuty in your or AI app? The pre-built Arcade PagerDuty MCP Server is what you want!

What’s documented here

This page describes how to use and configure PagerDuty auth with Arcade.

This is used by:

Configuring PagerDuty auth

When using your own app credentials, make sure you configure your to use a custom user verifier. Without this, your end-users will not be able to use your app or in production.

In a production environment, you will most likely want to use your own PagerDuty app credentials. This way, your will see your application’s name requesting permission.

Before showing how to configure your PagerDuty app credentials, let’s go through the steps to create a PagerDuty app.

Create a PagerDuty app

To integrate with PagerDuty’s API using OAuth 2.0, you’ll need to register an app in your PagerDuty :

Access PagerDuty App Registration

  1. Log in to your PagerDuty
  2. Navigate to Integrations → App Registration
  3. This is where you’ll create and manage your OAuth applications

Create a new app

  1. Click on New App or Register New App
  2. Fill in the required details:
    • Application Name: Choose a descriptive name for your application
    • Description: Provide a brief description of your app’s purpose
    • Functionality: Select both OAuth 2.0 and Events Integration (if needed)

Configure OAuth settings

  1. Choose Scoped OAuth as the authorization method
  2. Select the required permission scopes based on your application’s needs:
    • Common scopes include: read, write, analytics.read, users.read, teams.read, etc.
  3. Add the Redirect URL generated by Arcade (see configuration section below) to your app’s redirect URLs

Save your credentials

  1. After creating your app, you’ll receive your Client ID and Client Secret
  2. Important: Copy and save these credentials immediately, as the Client Secret won’t be accessible again

For detailed instructions, refer to PagerDuty’s OAuth 2.0 guide  and OAuth documentation .

Next, add the PagerDuty app to Arcade.

Configuring your own PagerDuty Auth Provider in Arcade

Configure PagerDuty Auth Using the Arcade Dashboard GUI

Access the Arcade Dashboard

To access the Arcade Cloud dashboard, go to api.arcade.dev/dashboard . If you are self-hosting, by default the dashboard will be available at http://localhost:9099/dashboard . Adjust the host and port number to match your environment.

Navigate to the OAuth Providers page

  • Under the OAuth section of the Arcade Dashboard left-side menu, click Providers.
  • Click Add OAuth Provider in the top right corner.
  • Select the OAuth 2.0 tab at the top.

Enter the provider details

  • Choose a unique ID for your provider (e.g. “arcade-pagerduty”).
  • Optionally enter a Description.
  • Enter the Client ID and Client Secret from your PagerDuty app.
  • Configure the OAuth 2.0 endpoints:
    • Authorization URL: https://app.pagerduty.com/oauth/authorize
    • Token URL: https://app.pagerduty.com/oauth/token
  • Note the Redirect URL generated by Arcade. This must be set as one of your PagerDuty app’s Redirect URLs.

Create the provider

Hit the Create button and the provider will be ready to be used.

When you use tools that require PagerDuty auth using your Arcade credentials, Arcade will automatically use this PagerDuty OAuth provider. If you have multiple PagerDuty providers, see using multiple auth providers of the same type for more information.

Using PagerDuty auth in app code

Use the PagerDuty in your own and AI apps to get a token for the PagerDuty API. See authorizing agents with Arcade to understand how this works.

Use client.auth.start() to get a token for the PagerDuty API:

Python
from arcadepy import Arcade
 
client = Arcade()  # Automatically finds the `ARCADE_API_KEY` env variable
 
user_id = "{arcade_user_id}"
 
# Start the authorization process
auth_response = client.auth.start(
    user_id=user_id,
    provider="arcade-pagerduty",
    scopes=["read", "write"]
)
 
if auth_response.status != "completed":
    print("Please complete the authorization challenge in your browser:")
    print(auth_response.url)
 
# Wait for the authorization to complete
auth_response = client.auth.wait_for_completion(auth_response)
 
token = auth_response.context.token
# Do something interesting with the token...

Using PagerDuty auth in custom tools

You can use the pre-built Arcade PagerDuty MCP Server to quickly build and AI apps that interact with PagerDuty.

If the pre-built tools in the PagerDuty Server don’t meet your needs, you can author your own custom tools that interact with the PagerDuty API.

Use the OAuth2() auth class to specify that a requires authorization with PagerDuty. The context.authorization.token field will be automatically populated with the ’s PagerDuty token:

Python
from typing import Annotated
 
import httpx
from arcade_tdk import ToolContext, tool
from arcade_tdk.auth import OAuth2
 
 
@tool(
    requires_auth=OAuth2(
        provider_id="arcade-pagerduty",
        scopes=["read"]
    )
)
async def get_current_user(
    context: ToolContext,
) -> Annotated[dict, "The current user information."]:
    """
    Retrieve information about the authenticated user from PagerDuty.
    """
    url = "https://api.pagerduty.com/users/me"
    headers = {
        "Authorization": context.authorization.token,
        "Accept": "application/vnd.pagerduty+json;version=2",
    }
 
    async with httpx.AsyncClient() as client:
        response = await client.get(url, headers=headers)
        response.raise_for_status()
        return dict(response.json())

Available Scopes

PagerDuty uses a simplified scope system with the following scopes:

  • read - Read-only access to PagerDuty resources
  • write - Full read and write access to PagerDuty resources

For more details about PagerDuty’s OAuth scopes and permissions, refer to the PagerDuty OAuth Scopes documentation .

Last updated on
OAuth 2.0Reddit