Skip to main content

PagerDuty Component

PagerDuty is a platform for managing on-call operations. This component supports PagerDuty REST API V2.

Component key: pagerduty

Description​

PagerDuty is an industry leading incident management tool.

Use the component to create and manage Incidents, events, and more.

API Documentation:​

The component was built using the PagerDuty REST API

Connections​

Api Key​

Steps to generate and use an API Key for PagerDuty:

  1. Log in to PagerDuty and navigate to Integrations | API Access Keys.
  2. Click the "Create New API Key" button.
  3. Enter a description for the API key. Check "Read-only API Key" if read-only behavior is desired.
  4. Click Create Key.
  5. Copy the provided API Key into the connection's configuration.
InputNotesExample
Token

OAuth 2.0​

Steps to generate app credentials for OAuth 2.0 for PagerDuty:

  1. Log in to PagerDuty and navigate to Integrations | App Registration.
  2. From the top menu, select Integrations.
  3. Select App Registration from the menu to navigate to the My Apps page.
  4. On the My Apps page, select New App. Enter a name for your app and a brief description.
  5. Check the box next to OAuth2.0 and/or Events Integration.
  6. For Authorization select one of the following:
    1. Scoped OAuth - New OAuth client that allows granular read or write access to PagerDuty resources like incidents, services, users, with other benefits.
      1. Use the table below to select Read or Write access to each Resource your integration will need access to.
    2. Classic User OAuth - Existing OAuth client that allows apps to act on behalf of users, with read or write to all PagerDuty resources.
      1. Assign a permission scope of Read or Read and Write
  7. In the Redirect URL field enter https://oauth2.prismatic.io/callback
  8. Select Register App
  9. Copy and save the Client ID and Client Secret into your integration.
InputNotesExample
Authorize URL

The OAuth 2.0 Authorization URL for PagerDuty Code Grant

https://identity.pagerduty.com/oauth/authorize
Client ID

Client ID of your PagerDuty app

Client Secret

Client Secret of your PagerDuty app

Scopes

Classic User OAuth scope allowing read or read/write access to all resources.

write
Token URL

The OAuth 2.0 Token URL for PagerDuty Code Grant

https://identity.pagerduty.com/oauth/token

Triggers​

Incidents Trigger​

Handle Incident webhook notifications from PagerDuty. | key: incidentsTrigger

InputNotesExample
Connection
Incident Events

The events that trigger the webhook.

Filter ID

The ID of the object being used as the filter.

sampleFilterId
Filter Type

The type of object being used as the filter.

Webhook Description

The description of the webhook.

This Is An Example Description

Service Trigger​

Handle Service webhook notifications from PagerDuty. | key: serviceTrigger

InputNotesExample
Connection
Service Events.

The events that trigger the webhook.

Filter ID

The ID of the object being used as the filter.

sampleFilterId
Filter Type

The type of object being used as the filter.

Webhook Description

The description of the webhook.

This Is An Example Description

Data Sources​

Select Incident​

Retrieve and select an incident. | key: selectIncident | type: picklist

InputNotesExample
Connection

Select Service​

Retrieve and select a service. | key: selectService | type: picklist

InputNotesExample
Connection

Select Template​

Retrieve and select a template. | key: selectTemplate | type: picklist

InputNotesExample
Connection

Select User​

Retrieve and select a user. | key: selectUser | type: picklist

InputNotesExample
Connection

Actions​

Create Incident​

Create an Incident | key: createIncident

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Incident

JSON object body of the incident to be created

{
  "data": {
    "incident": {
      "id": "PT4KHLK",
      "type": "incident",
      "title": "The server is on fire.",
      "summary": "[#1234] The server is on fire.",
      "self": "https://api.pagerduty.com/incidents/PT4KHLK",
      "html_url": "https://subdomain.pagerduty.com/incidents/PT4KHLK",
      "incident_number": 1234,
      "created_at": "2015-10-06T21:30:42Z",
      "updated_at": "2015-10-06T21:40:23Z",
      "status": "triggered",
      "incident_key": "baf7cf21b1da41b4b0221008339ff357",
      "service": {
        "id": "PWIXJZS",
        "type": "service_reference",
        "summary": "My Mail Service",
        "self": "https://api.pagerduty.com/services/PWIXJZS",
        "html_url": "https://subdomain.pagerduty.com/service-directory/PWIXJZS"
      },
      "priority": {
        "id": "P53ZZH5",
        "type": "priority_reference",
        "summary": "P2",
        "self": "https://api.pagerduty.com/priorities/P53ZZH5"
      },
      "assigned_via": "escalation_policy",
      "assignments": [
        {
          "at": "2015-11-10T00:31:52Z",
          "assignee": {
            "id": "PXPGF42",
            "type": "user_reference",
            "summary": "Earline Greenholt",
            "self": "https://api.pagerduty.com/users/PXPGF42",
            "html_url": "https://subdomain.pagerduty.com/users/PXPGF42"
          }
        }
      ],
      "resolved_at": null,
      "last_status_change_at": "2015-10-06T21:38:23Z",
      "last_status_change_by": {
        "id": "PXPGF42",
        "type": "user_reference",
        "summary": "Earline Greenholt",
        "self": "https://api.pagerduty.com/users/PXPGF42",
        "html_url": "https://subdomain.pagerduty.com/users/PXPGF42"
      },
      "first_trigger_log_entry": {
        "id": "Q02JTSNZWHSEKV",
        "type": "trigger_log_entry_reference",
        "summary": "Triggered through the API",
        "self": "https://api.pagerduty.com/log_entries/Q02JTSNZWHSEKV?incident_id=PT4KHLK",
        "html_url": "https://subdomain.pagerduty.com/incidents/PT4KHLK/log_entries/Q02JTSNZWHSEKV"
      },
      "incident_type": {
        "name": "major_incident"
      },
      "escalation_policy": {
        "id": "PT20YPA",
        "type": "escalation_policy_reference",
        "summary": "Another Escalation Policy",
        "self": "https://api.pagerduty.com/escalation_policies/PT20YPA",
        "html_url": "https://subdomain.pagerduty.com/escalation_policies/PT20YPA"
      },
      "teams": [
        {
          "id": "PQ9K7I8",
          "type": "team_reference",
          "summary": "Engineering",
          "self": "https://api.pagerduty.com/teams/PQ9K7I8",
          "html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8"
        }
      ],
      "urgency": "high"
    }
  }
}

Create Incident Note​

Create a note on an incident | key: createIncidentNote

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Incident ID

The ID of the Incident

PT4KHLK
Note

Note to create.

{
  "data": {
    "note": {
      "id": "PWL7QXS",
      "user": {
        "id": "PXPGF42",
        "type": "user_reference",
        "summary": "Earline Greenholt",
        "self": "https://api.pagerduty.com/users/PXPGF42",
        "html_url": "https://subdomain.pagerduty.com/users/PXPGF42"
      },
      "channel": {
        "summary": "The PagerDuty website or APIs"
      },
      "content": "Firefighters are on the scene.",
      "created_at": "2013-03-06T15:28:51-05:00"
    }
  }
}

Create Service​

Create a service | key: createService

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Service

JSON object body of the Service to create

{
  "data": {
    "service": {
      "id": "PIJ90N7",
      "summary": "My Application Service",
      "type": "service",
      "self": "https://api.pagerduty.com/services/PIJ90N7",
      "html_url": "https://subdomain.pagerduty.com/service-directory/PIJ90N7",
      "name": "My Application Service",
      "auto_resolve_timeout": 14400,
      "acknowledgement_timeout": 600,
      "created_at": "2015-11-06T11:12:51-05:00",
      "status": "active",
      "alert_creation": "create_alerts_and_incidents",
      "integrations": [
        {
          "id": "PQ12345",
          "type": "generic_email_inbound_integration_reference",
          "summary": "Email Integration",
          "self": "https://api.pagerduty.com/services/PIJ90N7/integrations/PQ12345",
          "html_url": "https://subdomain.pagerduty.com/services/PIJ90N7/integrations/PQ12345"
        }
      ],
      "escalation_policy": {
        "id": "PT20YPA",
        "type": "escalation_policy_reference",
        "summary": "Another Escalation Policy",
        "self": "https://api.pagerduty.com/escalation_policies/PT20YPA",
        "html_url": "https://subdomain.pagerduty.com/escalation_policies/PT20YPA"
      },
      "teams": [
        {
          "id": "PQ9K7I8",
          "type": "team_reference",
          "summary": "Engineering",
          "self": "https://api.pagerduty.com/teams/PQ9K7I8",
          "html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8"
        }
      ],
      "incident_urgency_rule": {
        "type": "use_support_hours",
        "during_support_hours": {
          "type": "constant",
          "urgency": "high"
        },
        "outside_support_hours": {
          "type": "constant",
          "urgency": "low"
        }
      },
      "support_hours": {
        "type": "fixed_time_per_day",
        "time_zone": "America/Lima",
        "start_time": "09:00:00",
        "end_time": "17:00:00",
        "days_of_week": [
          1,
          2,
          3,
          4,
          5
        ]
      },
      "scheduled_actions": [
        {
          "type": "urgency_change",
          "at": {
            "type": "named_time",
            "name": "support_hours_start"
          },
          "to_urgency": "high"
        }
      ],
      "auto_pause_notifications_parameters": {
        "enabled": true,
        "timeout": 300
      }
    }
  }
}

Create Template​

Create a template in PagerDuty's API | key: createTemplate

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Template Object

JSON object body of the new Template to be created

{
  "data": {
    "template": {
      "created_at": "2022-08-19T13:46:22Z",
      "created_by": {
        "id": "PF9KMXH",
        "self": "https://api.pagerduty.com/users/PF9KMXH",
        "type": "user_reference"
      },
      "description": "Sample template description",
      "templated_fields": {
        "email_body": "<div> sample </div>",
        "email_subject": "Sample email Subject",
        "message": "Sample SMS message"
      },
      "id": "PCCR863",
      "name": "Sample Template",
      "self": "https://api.pagerduty.com/templates/PCCR863",
      "template_type": "status_update",
      "type": "template",
      "updated_at": "2022-08-19T13:46:22Z",
      "updated_by": {
        "id": "PF9KMXH",
        "self": "https://api.pagerduty.com/users/PF9KMXH",
        "type": "user_reference"
      }
    }
  }
}

Create User​

Create a user | key: createUser

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
User

JSON object body of the User to create.

{
  "data": {
    "user": {
      "id": "PXPGF42",
      "type": "user",
      "summary": "Earline Greenholt",
      "self": "https://api.pagerduty.com/users/PXPGF42",
      "html_url": "https://subdomain.pagerduty.com/users/PXPGF42",
      "name": "Earline Greenholt",
      "email": "125.greenholt.earline@graham.name",
      "time_zone": "America/Lima",
      "color": "green",
      "role": "admin",
      "avatar_url": "https://secure.gravatar.com/avatar/a8b714a39626f2444ee05990b078995f.png?d=mm&r=PG",
      "description": "I'm the boss",
      "invitation_sent": false,
      "contact_methods": [
        {
          "id": "PTDVERC",
          "type": "email_contact_method_reference",
          "summary": "Default",
          "self": "https://api.pagerduty.com/users/PXPGF42/contact_methods/PTDVERC"
        }
      ],
      "notification_rules": [
        {
          "id": "P8GRWKK",
          "type": "assignment_notification_rule_reference",
          "summary": "Default",
          "self": "https://api.pagerduty.com/users/PXPGF42/notification_rules/P8GRWKK",
          "html_url": null
        }
      ],
      "job_title": "Director of Engineering",
      "teams": [
        {
          "id": "PQ9K7I8",
          "type": "team_reference",
          "summary": "Engineering",
          "self": "https://api.pagerduty.com/teams/PQ9K7I8",
          "html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8"
        }
      ]
    }
  }
}

Create Webhook Subscription​

Create a webhook subscription | key: createWebhookSubscription

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Webhook Subscription

{
  "data": {
    "webhook_subscription": {
      "delivery_method": {
        "id": "PF9KMXH",
        "secret": null,
        "temporarily_disabled": false,
        "type": "http_delivery_method",
        "url": "https://example.com/receive_a_pagerduty_webhook",
        "custom_headers": [
          {
            "name": "your-header-name",
            "value": "-- redacted --"
          }
        ]
      },
      "description": "Sends PagerDuty v3 webhook events somewhere interesting.",
      "events": [
        "incident.acknowledged",
        "incident.annotated",
        "incident.delegated",
        "incident.escalated",
        "incident.priority_updated",
        "incident.reassigned",
        "incident.reopened",
        "incident.resolved",
        "incident.responder.added",
        "incident.responder.replied",
        "incident.triggered",
        "incident.unacknowledged"
      ],
      "filter": {
        "id": "P393ZNQ",
        "type": "service_reference"
      },
      "id": "PY1OL64",
      "type": "webhook_subscription",
      "active": true
    }
  }
}

Delete All Instance Webhooks​

Delete all webhooks associated with this instance | key: deleteAllInstanceWebhooks

InputNotesExample
Connection

Delete Service​

Delete a service | key: deleteService

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Service ID

The ID of the Service.

{
  "data": "Action successfully completed."
}

Delete Template​

Delete a template | key: deleteTemplate

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Id

The ID of the Template.

PBZUP2B

{
  "data": {
    "data": "Action successfully completed."
  }
}

Delete User​

Delete a user | key: deleteUser

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Id

The ID of the User to update.

{
  "data": "Action successfully completed."
}

Delete Webhook Subscription​

Delete a webhook subscription | key: deleteWebhookSubscription

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Webhook ID.

The ID of the webhook.

sampleWebhookId

{
  "data": "Action successfully completed."
}

Enable Webhook Subscription​

Enable a webhook subscription | key: enableWebhookSubscription

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Webhook ID.

The ID of the webhook.

sampleWebhookId

{
  "data": {
    "webhook_subscription": {
      "delivery_method": {
        "id": "PF9KMXH",
        "secret": null,
        "temporarily_disabled": false,
        "type": "http_delivery_method",
        "url": "https://example.com/receive_a_pagerduty_webhook",
        "custom_headers": [
          {
            "name": "your-header-name",
            "value": "-- redacted --"
          }
        ]
      },
      "description": "Sends PagerDuty v3 webhook events somewhere interesting.",
      "events": [
        "incident.acknowledged",
        "incident.annotated",
        "incident.delegated",
        "incident.escalated",
        "incident.priority_updated",
        "incident.reassigned",
        "incident.reopened",
        "incident.resolved",
        "incident.responder.added",
        "incident.responder.replied",
        "incident.triggered",
        "incident.unacknowledged"
      ],
      "filter": {
        "id": "P393ZNQ",
        "type": "service_reference"
      },
      "id": "PY1OL64",
      "type": "webhook_subscription",
      "active": true
    }
  }
}

Get Change Event​

Get a Change Event | key: getChangeEvent

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Event Id

The ID of the Change Event.

12

{
  "data": {
    "change_event": {
      "summary": "Build Success - Increase snapshot create timeout to 30 seconds",
      "timestamp": "2020-07-17T08:42:58Z",
      "type": "change_event",
      "source": "acme-build-pipeline-tool-default-i-9999",
      "integration": {
        "id": "PEYSGVF",
        "type": "inbound_integration_reference"
      },
      "services": [
        {
          "id": "PEYSGRV",
          "type": "service_reference"
        }
      ],
      "custom_details": {
        "build_state": "passed",
        "build_number": "2",
        "run_time": "1236s"
      },
      "links": [
        {
          "href": "https://acme.pagerduty.dev/build/2",
          "text": "View more details in Acme!"
        }
      ]
    }
  }
}

Get Incident​

Get an incident | key: getIncident

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Incident ID

The ID of the Incident

PT4KHLK
Include

Array of additional details to include

{
  "data": {
    "incident": {
      "id": "PT4KHLK",
      "type": "incident",
      "summary": "[#1234] The server is on fire.",
      "self": "https://api.pagerduty.com/incidents/PT4KHLK",
      "html_url": "https://subdomain.pagerduty.com/incidents/PT4KHLK",
      "incident_number": 1234,
      "title": "The server is on fire.",
      "created_at": "2015-10-06T21:30:42Z",
      "updated_at": "2015-10-06T21:40:23Z",
      "status": "acknowledged",
      "incident_key": "baf7cf21b1da41b4b0221008339ff357",
      "service": {
        "id": "PIJ90N7",
        "type": "service_reference",
        "summary": "My Mail Service",
        "self": "https://api.pagerduty.com/services/PIJ90N7",
        "html_url": "https://subdomain.pagerduty.com/service-directory/PIJ90N7"
      },
      "assignments": [
        {
          "at": "2015-11-10T00:31:52Z",
          "assignee": {
            "id": "PXPGF42",
            "type": "user_reference",
            "summary": "Earline Greenholt",
            "self": "https://api.pagerduty.com/users/PXPGF42",
            "html_url": "https://subdomain.pagerduty.com/users/PXPGF42"
          }
        }
      ],
      "assigned_via": "escalation_policy",
      "last_status_change_at": "2015-10-06T21:38:23Z",
      "resolved_at": null,
      "first_trigger_log_entry": {
        "id": "Q02JTSNZWHSEKV",
        "type": "trigger_log_entry_reference",
        "summary": "Triggered through the API",
        "self": "https://api.pagerduty.com/log_entries/Q02JTSNZWHSEKV?incident_id=PT4KHLK",
        "html_url": "https://subdomain.pagerduty.com/incidents/PT4KHLK/log_entries/Q02JTSNZWHSEKV"
      },
      "alert_counts": {
        "all": 2,
        "triggered": 1,
        "resolved": 1
      },
      "is_mergeable": true,
      "incident_type": {
        "name": "incident_default"
      },
      "escalation_policy": {
        "id": "PT20YPA",
        "type": "escalation_policy_reference",
        "summary": "Another Escalation Policy",
        "self": "https://api.pagerduty.com/escalation_policies/PT20YPA",
        "html_url": "https://subdomain.pagerduty.com/escalation_policies/PT20YPA"
      },
      "teams": [
        {
          "id": "PQ9K7I8",
          "type": "team_reference",
          "summary": "Engineering",
          "self": "https://api.pagerduty.com/teams/PQ9K7I8",
          "html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8"
        }
      ],
      "pending_actions": [
        {
          "type": "unacknowledge",
          "at": "2015-11-10T01:02:52Z"
        },
        {
          "type": "resolve",
          "at": "2015-11-10T04:31:52Z"
        }
      ],
      "acknowledgements": [
        {
          "at": "2015-11-10T00:32:52Z",
          "acknowledger": {
            "id": "PXPGF42",
            "type": "user_reference",
            "summary": "Earline Greenholt",
            "self": "https://api.pagerduty.com/users/PXPGF42",
            "html_url": "https://subdomain.pagerduty.com/users/PXPGF42"
          }
        }
      ],
      "alert_grouping": {
        "grouping_type": "advanced",
        "started_at": "2015-10-06T21:30:42Z",
        "ended_at": null,
        "alert_grouping_active": true
      },
      "last_status_change_by": {
        "id": "PXPGF42",
        "type": "user_reference",
        "summary": "Earline Greenholt",
        "self": "https://api.pagerduty.com/users/PXPGF42",
        "html_url": "https://subdomain.pagerduty.com/users/PXPGF42"
      },
      "priority": {
        "id": "P53ZZH5",
        "type": "priority_reference",
        "summary": "P2",
        "self": "https://api.pagerduty.com/priorities/P53ZZH5"
      },
      "resolve_reason": null,
      "conference_bridge": {
        "conference_number": "+1-415-555-1212,,,,1234#",
        "conference_url": "https://example.com/acb-123"
      },
      "incidents_responders": [
        {
          "state": "pending",
          "user": {
            "id": "PL7A2O4",
            "type": "user_reference",
            "summary": "Lee Turner",
            "self": "https://api.pagerduty.com/users/PL7A2O4",
            "html_url": "https://subdomain.pagerduty.com/users/PL7A2O4",
            "avatar_url": "https://secure.gravatar.com/avatar/51c673f51f6b483b24c889bbafbd2a67.png?d=mm&r=PG"
          },
          "incident": {
            "id": "PXP12GZ",
            "type": "incident_reference",
            "summary": "Ongoing Incident in Mailroom",
            "self": "https://api.pagerduty.com/incidents/PXP12GZ",
            "html_url": "https://subdomain.pagerduty.com/incidents/PXP12GZ"
          },
          "updated_at": "2018-08-09T14:40:48-07:00",
          "message": "Please help with issue - join bridge at +1(234)-567-8910",
          "requester": {
            "id": "P09TT3C",
            "type": "user_reference",
            "summary": "Jane Doe",
            "self": "https://api.pagerduty.com/users/P09TT3C",
            "html_url": "https://subdomain.pagerduty.com/users/P09TT3C",
            "avatar_url": "https://secure.gravatar.com/avatar/1c747247b75acc1f724e2784c838b3f8.png?d=mm&r=PG"
          },
          "requested_at": "2018-08-09T21:40:49Z"
        }
      ],
      "responder_requests": [
        {
          "incident": {
            "id": "PXP12GZ",
            "type": "incident_reference",
            "summary": "Ongoing Incident in Mailroom",
            "self": "https://api.pagerduty.com/incidents/PXP12GZ",
            "html_url": "https://subdomain.pagerduty.com/incidents/PXP12GZ"
          },
          "requester": {
            "id": "P09TT3C",
            "type": "user_reference",
            "summary": "Jane Doe",
            "self": "https://api.pagerduty.com/users/P09TT3C",
            "html_url": "https://subdomain.pagerduty.com/users/P09TT3C"
          },
          "requested_at": "2018-08-16T14:55:17-07:00",
          "message": "Please help with issue - join bridge at +1(234)-567-8910",
          "responder_request_targets": [
            {
              "responder_request_target": {
                "type": "user",
                "id": "PL7A2O4",
                "incidents_responders": [
                  {
                    "state": "pending",
                    "user": {
                      "id": "PL7A2O4",
                      "type": "user_reference",
                      "summary": "Lee Turner",
                      "self": "https://api.pagerduty.com/users/PL7A2O4",
                      "html_url": "https://subdomain.pagerduty.com/users/PL7A2O4",
                      "avatar_url": "https://secure.gravatar.com/avatar/51c673f51f6b483b24c889bbafbd2a67.png?d=mm&r=PG"
                    },
                    "incident": {
                      "id": "PXP12GZ",
                      "type": "incident_reference",
                      "summary": "Ongoing Incident in Mailroom",
                      "self": "https://api.pagerduty.com/incidents/PXP12GZ",
                      "html_url": "https://subdomain.pagerduty.com/incidents/PXP12GZ"
                    },
                    "updated_at": "2018-08-09T14:40:48-07:00",
                    "message": "Please help with issue - join bridge at +1(234)-567-8910",
                    "requester": {
                      "id": "P09TT3C",
                      "type": "user_reference",
                      "summary": "Jane Doe",
                      "self": "https://api.pagerduty.com/users/P09TT3C",
                      "html_url": "https://subdomain.pagerduty.com/users/P09TT3C",
                      "avatar_url": "https://secure.gravatar.com/avatar/1c747247b75acc1f724e2784c838b3f8.png?d=mm&r=PG"
                    },
                    "requested_at": "2018-08-09T21:40:49Z"
                  }
                ]
              }
            }
          ]
        }
      ],
      "urgency": "high",
      "custom_fields": [
        {
          "id": "PT4KHEE",
          "type": "field_value",
          "name": "environment",
          "display_name": "Runtime Environment",
          "description": "environment where incident occurred",
          "data_type": "string",
          "field_type": "single_value_fixed",
          "value": "production"
        }
      ]
    }
  }
}

Get Incident Alert​

Get an alert | key: getIncidentAlert

InputNotesExample
Incident Alert ID

The ID of the Incident Alert

PT4KHLK
Connection
Debug Request

Enabling this flag will log out the current request.

false
Incident ID

The ID of the Incident

PT4KHLK

{
  "data": {
    "alert": {
      "id": "PT4KHLK",
      "type": "alert",
      "summary": "The server is on fire.",
      "self": "https://api.pagerduty.com/incident/PT4KHLX/alerts/PT4KHLK",
      "html_url": "https://subdomain.pagerduty.com/alerts/PT4KHLK",
      "created_at": "2015-10-06T21:30:42Z",
      "status": "resolved",
      "alert_key": "baf7cf21b1da41b4b0221008339ff357",
      "service": {
        "id": "PIJ90N7",
        "type": "service_reference",
        "summary": "My Mail Service",
        "self": "https://api.pagerduty.com/services/PIJ90N7",
        "html_url": "https://subdomain.pagerduty.com/service-directory/PIJ90N7"
      },
      "incident": {
        "id": "PT4KHLX",
        "type": "incident_reference",
        "summary": "[#1234] The server is on fire.",
        "self": "https://api.pagerduty.com/incidents/PT4KHLX",
        "html_url": "https://subdomain.pagerduty.com/incidents/PT4KHLX"
      },
      "suppressed": false,
      "severity": "critical",
      "integration": {
        "id": "PQ12345",
        "type": "generic_email_inbound_integration_reference",
        "summary": "Email Integration",
        "self": "https://api.pagerduty.com/services/PIJ90N7/integrations/PQ12345",
        "html_url": "https://subdomain.pagerduty.com/services/PIJ90N7/integrations/PQ12345"
      }
    }
  }
}

Get Service​

Get a service | key: getService

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Service ID

The ID of the Service.

Include

Array of additional details to include.

{
  "data": {
    "service": {
      "id": "PIJ90N7",
      "type": "service",
      "summary": "My Application Service",
      "self": "https://api.pagerduty.com/services/PIJ90N7",
      "html_url": "https://subdomain.pagerduty.com/service-directory/PIJ90N7",
      "name": "My Application Service",
      "auto_resolve_timeout": 14400,
      "acknowledgement_timeout": 600,
      "created_at": "2015-11-06T11:12:51-05:00",
      "status": "active",
      "alert_creation": "create_alerts_and_incidents",
      "integrations": [
        {
          "id": "PQ12345",
          "type": "generic_email_inbound_integration_reference",
          "summary": "Email Integration",
          "self": "https://api.pagerduty.com/services/PIJ90N7/integrations/PQ12345",
          "html_url": "https://subdomain.pagerduty.com/services/PIJ90N7/integrations/PQ12345"
        }
      ],
      "escalation_policy": {
        "id": "PT20YPA",
        "type": "escalation_policy_reference",
        "summary": "Another Escalation Policy",
        "self": "https://api.pagerduty.com/escalation_policies/PT20YPA",
        "html_url": "https://subdomain.pagerduty.com/escalation_policies/PT20YPA"
      },
      "teams": [
        {
          "id": "PQ9K7I8",
          "type": "team_reference",
          "summary": "Engineering",
          "self": "https://api.pagerduty.com/teams/PQ9K7I8",
          "html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8"
        }
      ],
      "incident_urgency_rule": {
        "type": "use_support_hours",
        "during_support_hours": {
          "type": "constant",
          "urgency": "high"
        },
        "outside_support_hours": {
          "type": "constant",
          "urgency": "low"
        }
      },
      "support_hours": {
        "type": "fixed_time_per_day",
        "time_zone": "America/Lima",
        "start_time": "09:00:00",
        "end_time": "17:00:00",
        "days_of_week": [
          1,
          2,
          3,
          4,
          5
        ]
      },
      "scheduled_actions": [
        {
          "type": "urgency_change",
          "at": {
            "type": "named_time",
            "name": "support_hours_start"
          },
          "to_urgency": "high"
        }
      ],
      "auto_pause_notifications_parameters": {
        "enabled": true,
        "timeout": 300
      }
    }
  }
}

Get Template​

Get a template | key: getTemplate

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Id

The ID of the Template.

PBZUP2B

{
  "data": {
    "template": {
      "created_at": "2022-12-30T16:00:00Z",
      "created_by": {
        "id": "PDZR4CN",
        "self": "https://api.pagerduty.com/users/PDZR4CN",
        "type": "user_reference"
      },
      "description": "Sample template description",
      "templated_fields": {
        "email_body": "<div> sample </div>",
        "email_subject": "Sample email Subject",
        "message": "Sample template message"
      },
      "id": "PBZUP2B",
      "name": "Sample Template 160",
      "self": "https://api.pagerduty.com/templates/PBZUP2B",
      "template_type": "status_update",
      "type": "template",
      "updated_at": "2022-12-30T16:00:00Z",
      "updated_by": {
        "id": "PGY287N",
        "self": "https://api.pagerduty.com/users/PGY287N",
        "type": "user_reference"
      }
    }
  }
}

Get User​

Get a user | key: getUser

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Id

The ID of the User to update.

Include

Array of additional Models to include in response.

{
  "data": {
    "user": {
      "id": "PXPGF42",
      "type": "user",
      "summary": "Earline Greenholt",
      "self": "https://api.pagerduty.com/users/PXPGF42",
      "html_url": "https://subdomain.pagerduty.com/users/PXPGF42",
      "name": "Earline Greenholt",
      "email": "125.greenholt.earline@graham.name",
      "time_zone": "America/Lima",
      "color": "green",
      "role": "admin",
      "avatar_url": "https://secure.gravatar.com/avatar/a8b714a39626f2444ee05990b078995f.png?d=mm&r=PG",
      "description": "I'm the boss",
      "invitation_sent": false,
      "contact_methods": [
        {
          "id": "PTDVERC",
          "type": "email_contact_method_reference",
          "summary": "Default",
          "self": "https://api.pagerduty.com/users/PXPGF42/contact_methods/PTDVERC"
        }
      ],
      "notification_rules": [
        {
          "id": "P8GRWKK",
          "type": "assignment_notification_rule_reference",
          "summary": "Default",
          "self": "https://api.pagerduty.com/users/PXPGF42/notification_rules/P8GRWKK",
          "html_url": null
        }
      ],
      "job_title": "Director of Engineering",
      "teams": [
        {
          "id": "PQ9K7I8",
          "type": "team_reference",
          "summary": "Engineering",
          "self": "https://api.pagerduty.com/teams/PQ9K7I8",
          "html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8"
        }
      ]
    }
  }
}

Get Webhook Subscription​

Get a webhook subscription | key: getWebhookSubscription

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Webhook ID.

The ID of the webhook.

sampleWebhookId

{
  "data": {
    "webhook_subscription": {
      "delivery_method": {
        "id": "PF9KMXH",
        "secret": null,
        "temporarily_disabled": false,
        "type": "http_delivery_method",
        "url": "https://example.com/receive_a_pagerduty_webhook",
        "custom_headers": [
          {
            "name": "your-header-name",
            "value": "-- redacted --"
          }
        ]
      },
      "description": "Sends PagerDuty v3 webhook events somewhere interesting.",
      "events": [
        "incident.acknowledged",
        "incident.annotated",
        "incident.delegated",
        "incident.escalated",
        "incident.priority_updated",
        "incident.reassigned",
        "incident.reopened",
        "incident.resolved",
        "incident.responder.added",
        "incident.responder.replied",
        "incident.triggered",
        "incident.unacknowledged"
      ],
      "filter": {
        "id": "P393ZNQ",
        "type": "service_reference"
      },
      "id": "PY1OL64",
      "type": "webhook_subscription",
      "active": true
    }
  }
}

List Change Events​

List Change Events | key: listChangeEvents

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Fetch All

Performs pagination on this endpoint.

true
Integration Ids

An array of integration IDs.

PEYSGVF
Limit

The number of results per page.

10
Offset

Offset to start pagination search results.

18
Since

The start of the date range over which you want to search, as a UTC ISO 8601 datetime string.

2020-07-17T07:42:58Z
Team Ids

An array of team IDs.

PEYSGVF
Total

By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for the response to be populated.

false
Until

The end of the date range over which you want to search, as a UTC ISO 8601 datetime string.

2020-07-17T07:42:58Z

{
  "data": {
    "change_events": [
      {
        "summary": "Build Success - Increase snapshot create timeout to 30 seconds",
        "id": "01BBYA6PEVW6A852BUO6QYUE7O",
        "timestamp": "2020-07-17T08:42:58Z",
        "type": "change_event",
        "source": "acme-build-pipeline-tool-default-i-9999",
        "integration": {
          "id": "PEYSGVF",
          "type": "inbound_integration_reference"
        },
        "services": [
          {
            "id": "PEYSGRV",
            "type": "service_reference"
          }
        ],
        "custom_details": {
          "build_state": "passed",
          "build_number": "2",
          "run_time": "1236s"
        },
        "links": [
          {
            "href": "https://acme.pagerduty.dev/build/2",
            "text": "View more details in Acme!"
          }
        ]
      },
      {
        "summary": "Build Success - Increase snapshot create timeout to 15 seconds",
        "id": "01BBYA6PDIXPL8KO1HPIUL9CZN",
        "timestamp": "2020-07-17T07:42:58Z",
        "type": "change_event",
        "source": "acme-build-pipeline-tool-default-i-9999",
        "integration": {
          "id": "PEYSGVF",
          "type": "inbound_integration_reference"
        },
        "services": [
          {
            "id": "PEYSGRV",
            "type": "service_reference"
          }
        ],
        "custom_details": {
          "build_state": "passed",
          "build_number": "1",
          "run_time": "1233s"
        },
        "links": [
          {
            "href": "https://acme.pagerduty.dev/build/1",
            "text": "View more details in Acme!"
          }
        ]
      }
    ],
    "limit": null,
    "offset": null,
    "total": null,
    "more": false
  }
}

List Incident Alerts​

List alerts for an incident | key: listIncidentAlerts

InputNotesExample
Alert Key

Alert de-duplication key

baf7cf21b1da41b4b0221008339ff357
Connection
Debug Request

Enabling this flag will log out the current request.

false
Fetch All

Performs pagination on this endpoint.

true
Incident ID

The ID of the Incident

PT4KHLK
Include

Array of additional details to include

Limit

The number of results per page.

10
Offset

Offset to start pagination search results.

18
Sort By

Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results

Statuses

Return only incidents with the given statuses

Total

By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for the response to be populated.

false

{
  "data": {
    "alerts": [
      {
        "id": "PT4KHLK",
        "type": "alert",
        "summary": "The server is on fire.",
        "self": "https://api.pagerduty.com/incidents/PT4KHLK/alerts/PXPGF42",
        "html_url": "https://subdomain.pagerduty.com/alerts/PXPGF42",
        "created_at": "2015-10-06T21:30:42Z",
        "status": "resolved",
        "alert_key": "baf7cf21b1da41b4b0221008339ff357",
        "service": {
          "id": "PIJ90N7",
          "type": "service_reference",
          "summary": "My Mail Service",
          "self": "https://api.pagerduty.com/services/PIJ90N7",
          "html_url": "https://subdomain.pagerduty.com/service-directory/PIJ90N7"
        },
        "body": {
          "type": "alert_body",
          "contexts": [
            {
              "type": "link"
            }
          ],
          "details": {
            "customKey": "Server is on fire!",
            "customKey2": "Other stuff!"
          }
        },
        "incident": {
          "id": "PT4KHLK",
          "type": "incident_reference"
        },
        "suppressed": false,
        "severity": "critical",
        "integration": {
          "id": "PQ12345",
          "type": "generic_email_inbound_integration_reference",
          "summary": "Email Integration",
          "self": "https://api.pagerduty.com/services/PIJ90N7/integrations/PQ12345",
          "html_url": "https://subdomain.pagerduty.com/services/PIJ90N7/integrations/PQ12345"
        }
      }
    ],
    "limit": 1,
    "offset": 0,
    "more": true
  }
}

List Incident Notes​

List notes for an incident | key: listIncidentNotes

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Incident ID

The ID of the Incident

PT4KHLK

{
  "data": {
    "notes": [
      {
        "id": "PWL7QXS",
        "user": {
          "id": "PXPGF42",
          "type": "user_reference",
          "summary": "Earline Greenholt",
          "self": "https://api.pagerduty.com/users/PXPGF42",
          "html_url": "https://subdomain.pagerduty.com/users/PXPGF42"
        },
        "channel": {
          "summary": "The PagerDuty website or APIs"
        },
        "content": "Firefighters are on the scene.",
        "created_at": "2013-03-06T15:28:51-05:00"
      },
      {
        "id": "PCQC25",
        "user": {
          "id": "PXPGF42",
          "type": "bot_user_reference",
          "summary": "A Global Event Rule",
          "self": "https://api.pagerduty.com/users/PXPGF42",
          "html_url": "https://subdomain.pagerduty.com/event-rules/global/0e84de00-9511-4380-9f4f-a7b568bb49a0/rules/14e56445-ebab-4dd0-ba9d-fc28a41b7e7b"
        },
        "channel": {
          "id": "14e56445-ebab-4dd0-ba9d-fc28a41b7e7b",
          "type": "event_rule_reference",
          "summary": "A Global Event Rule",
          "self": "https://api.pagerduty.com/rulesets/0e84de00-9511-4380-9f4f-a7b568bb49a0/rules/14e56445-ebab-4dd0-ba9d-fc28a41b7e7b",
          "html_url": "https://subdomain.pagerduty.com/event-rules/global/0e84de00-9511-4380-9f4f-a7b568bb49a0/rules/14e56445-ebab-4dd0-ba9d-fc28a41b7e7b"
        },
        "content": "Initial alert information indicates a 1-alarm fire",
        "created_at": "2013-03-06T15:28:42-05:00"
      }
    ]
  }
}

List Incidents​

List incidents | key: listIncidents

InputNotesExample
Connection
Date Range

When set to all, the since and until parameters and defaults are ignored

Debug Request

Enabling this flag will log out the current request.

false
Fetch All

Performs pagination on this endpoint.

true
Incident Key

Incident de-duplication key

baf7cf21b1da41b4b0221008339ff357
Include

Array of additional details to include

Limit

The number of results per page.

10
Offset

Offset to start pagination search results.

18
Service Ids

Returns only the incidents associated with the passed service(s)

PIJ90N7
Since

The start of the date range over which you want to search, as a UTC ISO 8601 datetime string.

2020-07-17T07:42:58Z
Sort By

Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results

Statuses

Return only incidents with the given statuses

Team Ids

An array of team IDs.

PEYSGVF
Time Zone

TZInfo-formatted time zone in which results will be rendered

Total

By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for the response to be populated.

false
Until

The end of the date range over which you want to search, as a UTC ISO 8601 datetime string.

2020-07-17T07:42:58Z
Urgencies

Return only incidents with this urgency

User Ids

Returns only the incidents currently assigned to the passed user(s)

PXPGF42

{
  "data": {
    "incidents": [
      {
        "id": "PT4KHLK",
        "type": "incident",
        "summary": "[#1234] The server is on fire.",
        "self": "https://api.pagerduty.com/incidents/PT4KHLK",
        "html_url": "https://subdomain.pagerduty.com/incidents/PT4KHLK",
        "incident_number": 1234,
        "title": "The server is on fire.",
        "created_at": "2015-10-06T21:30:42Z",
        "updated_at": "2015-10-06T21:40:23Z",
        "status": "resolved",
        "incident_key": "baf7cf21b1da41b4b0221008339ff357",
        "service": {
          "id": "PIJ90N7",
          "type": "service_reference",
          "summary": "My Mail Service",
          "self": "https://api.pagerduty.com/services/PIJ90N7",
          "html_url": "https://subdomain.pagerduty.com/service-directory/PIJ90N7"
        },
        "assignments": [],
        "assigned_via": "escalation_policy",
        "last_status_change_at": "2015-10-06T21:38:23Z",
        "resolved_at": "2015-10-06T21:38:23Z",
        "first_trigger_log_entry": {
          "id": "Q02JTSNZWHSEKV",
          "type": "trigger_log_entry_reference",
          "summary": "Triggered through the API",
          "self": "https://api.pagerduty.com/log_entries/Q02JTSNZWHSEKV?incident_id=PT4KHLK",
          "html_url": "https://subdomain.pagerduty.com/incidents/PT4KHLK/log_entries/Q02JTSNZWHSEKV"
        },
        "alert_counts": {
          "all": 2,
          "triggered": 0,
          "resolved": 2
        },
        "is_mergeable": true,
        "incident_type": {
          "name": "incident_default"
        },
        "escalation_policy": {
          "id": "PT20YPA",
          "type": "escalation_policy_reference",
          "summary": "Another Escalation Policy",
          "self": "https://api.pagerduty.com/escalation_policies/PT20YPA",
          "html_url": "https://subdomain.pagerduty.com/escalation_policies/PT20YPA"
        },
        "teams": [
          {
            "id": "PQ9K7I8",
            "type": "team_reference",
            "summary": "Engineering",
            "self": "https://api.pagerduty.com/teams/PQ9K7I8",
            "html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8"
          }
        ],
        "pending_actions": [],
        "acknowledgements": [],
        "alert_grouping": {
          "grouping_type": "advanced",
          "started_at": "2015-10-06T21:30:42Z",
          "ended_at": null,
          "alert_grouping_active": true
        },
        "last_status_change_by": {
          "id": "PXPGF42",
          "type": "user_reference",
          "summary": "Earline Greenholt",
          "self": "https://api.pagerduty.com/users/PXPGF42",
          "html_url": "https://subdomain.pagerduty.com/users/PXPGF42"
        },
        "priority": {
          "id": "P53ZZH5",
          "type": "priority_reference",
          "summary": "P2",
          "self": "https://api.pagerduty.com/priorities/P53ZZH5"
        },
        "resolve_reason": null,
        "conference_bridge": {
          "conference_number": "+1-415-555-1212,,,,1234#",
          "conference_url": "https://example.com/acb-123"
        },
        "incidents_responders": [],
        "responder_requests": [],
        "urgency": "high"
      }
    ],
    "limit": 1,
    "offset": 0,
    "more": true
  }
}

List Notifications​

List notifications | key: listNotifications

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Fetch All

Performs pagination on this endpoint.

true
Filter

Return notification of this type only

Include

Array of additional details to include

Limit

The number of results per page.

10
Offset

Offset to start pagination search results.

18
Since

The start of the date range over which you want to search, as a UTC ISO 8601 datetime string.

2020-07-17T07:42:58Z
Time Zone

TZInfo-formatted time zone in which results will be rendered

Total

By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for the response to be populated.

false
Until

The end of the date range over which you want to search, as a UTC ISO 8601 datetime string.

2020-07-17T07:42:58Z

{
  "data": {
    "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"
        }
      },
      {
        "id": "PKN7NBH",
        "type": "push_notification",
        "started_at": "2013-03-06T15:28:51-05:00",
        "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
  }
}

List Priorities​

List priorities | key: listPriorities

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Fetch All

Performs pagination on this endpoint.

true
Limit

The number of results per page.

10
Offset

Offset to start pagination search results.

18
Total

By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for the response to be populated.

false

{
  "data": {
    "priorities": [
      {
        "id": "PSLWBL8",
        "type": "priority",
        "summary": "P1",
        "self": "https://api.pagerduty.com/priorities/PSLWBL8",
        "name": "P1",
        "description": "Critical issue that warrants public notification and liaison with executive teams"
      },
      {
        "id": "P53ZZH5",
        "type": "priority",
        "summary": "P2",
        "self": "https://api.pagerduty.com/priorities/P53ZZH5",
        "name": "P2",
        "description": "Critical system issue actively impacting many customers' ability to use the product"
      },
      {
        "id": "PGE9YCZ",
        "type": "priority",
        "summary": "P3",
        "self": "https://api.pagerduty.com/priorities/PGE9YCZ",
        "name": "P3",
        "description": "Stability or minor customer-impacting issues that require immediate attention from service owners"
      },
      {
        "id": "PVJPWYW",
        "type": "priority",
        "summary": "P4",
        "self": "https://api.pagerduty.com/priorities/PVJPWYW",
        "name": "P4",
        "description": "Minor issues requiring action, but not affecting customer ability to use the product"
      },
      {
        "id": "P81SUUT",
        "type": "priority",
        "summary": "P5",
        "self": "https://api.pagerduty.com/priorities/P81SUUT",
        "name": "P5",
        "description": "Cosmetic issues or bugs, not affecting customer ability to use the product"
      }
    ],
    "limit": 25,
    "offset": 0,
    "more": false,
    "total": null
  }
}

List Services​

List services | key: listServices

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Fetch All

Performs pagination on this endpoint.

true
Include

Array of additional details to include.

Limit

The number of results per page.

10
Name

Filters the results, showing only services with the specified name

My Service
Offset

Offset to start pagination search results.

18
Query

Filters the result, showing only the records whose name matches the query.

sampleName
Sort By

Used to specify the field you wish to sort the results on.

Team Ids

An array of team IDs.

PEYSGVF
Time Zone

TZInfo-formatted time zone in which results will be rendered

Total

By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for the response to be populated.

false

{
  "data": {
    "services": [
      {
        "id": "PIJ90N7",
        "summary": "My Application Service",
        "type": "service",
        "self": "https://api.pagerduty.com/services/PIJ90N7",
        "html_url": "https://subdomain.pagerduty.com/service-directory/PIJ90N7",
        "name": "My Application Service",
        "auto_resolve_timeout": 14400,
        "acknowledgement_timeout": 600,
        "created_at": "2015-11-06T11:12:51-05:00",
        "status": "active",
        "alert_creation": "create_alerts_and_incidents",
        "alert_grouping_parameters": {
          "type": "intelligent"
        },
        "integrations": [
          {
            "id": "PQ12345",
            "type": "generic_email_inbound_integration_reference",
            "summary": "Email Integration",
            "self": "https://api.pagerduty.com/services/PIJ90N7/integrations/PQ12345",
            "html_url": "https://subdomain.pagerduty.com/services/PIJ90N7/integrations/PQ12345"
          }
        ],
        "escalation_policy": {
          "id": "PT20YPA",
          "type": "escalation_policy_reference",
          "summary": "Another Escalation Policy",
          "self": "https://api.pagerduty.com/escalation_policies/PT20YPA",
          "html_url": "https://subdomain.pagerduty.com/escalation_policies/PT20YPA"
        },
        "teams": [
          {
            "id": "PQ9K7I8",
            "type": "team_reference",
            "summary": "Engineering",
            "self": "https://api.pagerduty.com/teams/PQ9K7I8",
            "html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8"
          }
        ],
        "incident_urgency_rule": {
          "type": "use_support_hours",
          "during_support_hours": {
            "type": "constant",
            "urgency": "high"
          },
          "outside_support_hours": {
            "type": "constant",
            "urgency": "low"
          }
        },
        "support_hours": {
          "type": "fixed_time_per_day",
          "time_zone": "America/Lima",
          "start_time": "09:00:00",
          "end_time": "17:00:00",
          "days_of_week": [
            1,
            2,
            3,
            4,
            5
          ]
        },
        "scheduled_actions": [
          {
            "type": "urgency_change",
            "at": {
              "type": "named_time",
              "name": "support_hours_start"
            },
            "to_urgency": "high"
          }
        ],
        "auto_pause_notifications_parameters": {
          "enabled": true,
          "timeout": 300
        }
      }
    ],
    "limit": 25,
    "offset": 0,
    "more": false,
    "total": null
  }
}

List Templates​

List all templates | key: getTemplates

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Fetch All

Performs pagination on this endpoint.

true
Limit

The number of results per page.

10
Offset

Offset to start pagination search results.

18
Query

Template name or description to search

Template Name 1
Sort By

Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results

created_at:asc
Template Type

Filters templates by type.

status_update
Total

By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for the response to be populated.

false

{
  "data": {
    "limit": 25,
    "more": false,
    "offset": 0,
    "templates": [
      {
        "created_at": "2022-12-30T16:00:00Z",
        "created_by": {
          "id": "PDZR4CN",
          "self": "https://api.pagerduty.com/users/PDZR4CN",
          "type": "user_reference"
        },
        "description": "Sample template description",
        "id": "PBZUP2B",
        "name": "Sample Template 160",
        "self": "https://api.pagerduty.com/templates/PBZUP2B",
        "template_type": "status_update",
        "type": "template",
        "updated_at": "2022-12-30T16:00:00Z",
        "updated_by": {
          "id": "PGY287N",
          "self": "https://api.pagerduty.com/users/PGY287N",
          "type": "user_reference"
        }
      }
    ],
    "total": null
  }
}

List Users​

List all users | key: listUsers

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Fetch All

Performs pagination on this endpoint.

true
Include

Array of additional Models to include in response.

Limit

The number of results per page.

10
Offset

Offset to start pagination search results.

18
Query

Filters the result, showing only the records whose name matches the query.

sampleName
Team Ids

An array of team IDs.

PEYSGVF
Total

By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for the response to be populated.

false

{
  "data": {
    "users": [
      {
        "id": "PXPGF42",
        "type": "user",
        "summary": "Earline Greenholt",
        "self": "https://api.pagerduty.com/users/PXPGF42",
        "html_url": "https://subdomain.pagerduty.com/users/PXPGF42",
        "name": "Earline Greenholt",
        "email": "125.greenholt.earline@graham.name",
        "time_zone": "America/Lima",
        "color": "green",
        "role": "admin",
        "avatar_url": "https://secure.gravatar.com/avatar/a8b714a39626f2444ee05990b078995f.png?d=mm&r=PG",
        "description": "I'm the boss",
        "invitation_sent": false,
        "contact_methods": [
          {
            "id": "PTDVERC",
            "type": "email_contact_method_reference",
            "summary": "Default",
            "self": "https://api.pagerduty.com/users/PXPGF42/contact_methods/PTDVERC"
          }
        ],
        "notification_rules": [
          {
            "id": "P8GRWKK",
            "type": "assignment_notification_rule_reference",
            "summary": "Default",
            "self": "https://api.pagerduty.com/users/PXPGF42/notification_rules/P8GRWKK",
            "html_url": null
          }
        ],
        "job_title": "Director of Engineering",
        "teams": [
          {
            "id": "PQ9K7I8",
            "type": "team_reference",
            "summary": "Engineering",
            "self": "https://api.pagerduty.com/teams/PQ9K7I8",
            "html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8"
          }
        ]
      },
      {
        "id": "PAM4FGS",
        "type": "user",
        "summary": "Kyler Kuhn",
        "self": "https://api.pagerduty.com/users/PAM4FGS",
        "html_url": "https://subdomain.pagerduty.com/users/PAM4FGS",
        "name": "Kyler Kuhn",
        "email": "126_dvm_kyler_kuhn@beahan.name",
        "time_zone": "Asia/Hong_Kong",
        "color": "red",
        "role": "admin",
        "avatar_url": "https://secure.gravatar.com/avatar/47857d059adacf9a41dc4030c2e14b0a.png?d=mm&r=PG",
        "description": "Actually, I am the boss",
        "invitation_sent": false,
        "contact_methods": [
          {
            "id": "PVMGSML",
            "type": "email_contact_method_reference",
            "summary": "Work",
            "self": "https://api.pagerduty.com/users/PAM4FGS/contact_methods/PVMGSMLL"
          }
        ],
        "notification_rules": [
          {
            "id": "P8GRWKK",
            "type": "assignment_notification_rule_reference",
            "summary": "Default",
            "self": "https://api.pagerduty.com/users/PXPGF42/notification_rules/P8GRWKK",
            "html_url": null
          }
        ],
        "job_title": "Senior Engineer",
        "teams": [
          {
            "id": "PQ9K7I8",
            "type": "team_reference",
            "summary": "Engineering",
            "self": "https://api.pagerduty.com/teams/PQ9K7I8",
            "html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8"
          }
        ]
      }
    ],
    "limit": 25,
    "offset": 0,
    "more": false,
    "total": null
  }
}

List Webhook Subscriptions​

List webhook subscriptions | key: listWebhookSubscriptions

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Fetch All

Performs pagination on this endpoint.

true
Filter Id

The ID of the resource to filter upon.

123
Filter Type

The type of resource to filter upon.

Limit

The number of results per page.

10
Offset

Offset to start pagination search results.

18
Total

By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for the response to be populated.

false

{
  "data": {
    "webhook_subscriptions": [
      {
        "delivery_method": {
          "id": "PF9KMXH",
          "secret": null,
          "type": "http_delivery_method",
          "url": "https://example.com/receive_a_pagerduty_webhook",
          "custom_headers": [
            {
              "name": "your-header-name",
              "value": "-- redacted --"
            }
          ]
        },
        "description": "Sends PagerDuty v3 webhook events somewhere interesting.",
        "events": [
          "incident.acknowledged",
          "incident.annotated",
          "incident.delegated",
          "incident.escalated",
          "incident.priority_updated",
          "incident.reassigned",
          "incident.resolved",
          "incident.responder.added",
          "incident.responder.replied",
          "incident.triggered",
          "incident.unacknowledged"
        ],
        "filter": {
          "id": "P393ZNQ",
          "type": "service_reference"
        },
        "id": "PY1OL64",
        "type": "webhook_subscription",
        "active": true
      }
    ],
    "limit": 25,
    "offset": 0,
    "total": null,
    "more": false
  }
}

Manage Incident Alerts​

Manage alerts | key: updateIncidentAlerts

InputNotesExample
Alerts

An array of alert objects, including the parameters to update for each alert

Connection
Debug Request

Enabling this flag will log out the current request.

false
Incident ID

The ID of the Incident

PT4KHLK
Limit

The number of results per page.

10
Offset

Offset to start pagination search results.

18
Total

By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for the response to be populated.

false

{
  "data": {
    "alerts": [
      {
        "id": "PT4KHLK",
        "type": "alert",
        "summary": "The server is on fire.",
        "self": "https://api.pagerduty.com/incidents/PT4KHLK/alerts/PXPGF42",
        "html_url": "https://subdomain.pagerduty.com/alerts/PXPGF42",
        "created_at": "2015-10-06T21:30:42Z",
        "status": "resolved",
        "alert_key": "baf7cf21b1da41b4b0221008339ff357",
        "service": {
          "id": "PIJ90N7",
          "type": "service_reference",
          "summary": "My Mail Service",
          "self": "https://api.pagerduty.com/services/PIJ90N7",
          "html_url": "https://subdomain.pagerduty.com/service-directory/PIJ90N7"
        },
        "body": {
          "type": "alert_body",
          "contexts": [
            {
              "type": "link"
            }
          ],
          "details": {
            "customKey": "Server is on fire!",
            "customKey2": "Other stuff!"
          }
        },
        "incident": {
          "id": "PPVZH9X",
          "type": "incident_reference"
        },
        "suppressed": false,
        "severity": "critical"
      }
    ],
    "limit": 1,
    "offset": 0,
    "more": true
  }
}

Manage Incidents​

Manage Incidents | key: updateIncidents

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Incidents

An array of incidents, including the parameters to update.

Limit

The number of results per page.

10
Offset

Offset to start pagination search results.

18
Total

By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for the response to be populated.

false

{
  "data": {
    "incidents": [
      {
        "id": "PT4KHLK",
        "type": "incident",
        "summary": "[#1234] The server is on fire.",
        "self": "https://api.pagerduty.com/incidents/PT4KHLK",
        "html_url": "https://subdomain.pagerduty.com/incidents/PT4KHLK",
        "incident_number": 1234,
        "created_at": "2015-10-06T21:30:42Z",
        "updated_at": "2015-10-06T21:40:23Z",
        "status": "resolved",
        "title": "The server is on fire.",
        "alert_counts": {
          "all": 2,
          "triggered": 0,
          "resolved": 2
        },
        "pending_actions": [
          {
            "type": "unacknowledge",
            "at": "2015-11-10T01:02:52Z"
          },
          {
            "type": "resolve",
            "at": "2015-11-10T04:31:52Z"
          }
        ],
        "incident_key": "baf7cf21b1da41b4b0221008339ff357",
        "service": {
          "id": "PIJ90N7",
          "type": "service_reference",
          "summary": "My Mail Service",
          "self": "https://api.pagerduty.com/services/PIJ90N7",
          "html_url": "https://subdomain.pagerduty.com/service-directory/PIJ90N7"
        },
        "assigned_via": "escalation_policy",
        "assignments": [
          {
            "at": "2015-11-10T00:31:52Z",
            "assignee": {
              "id": "PXPGF42",
              "type": "user_reference",
              "summary": "Earline Greenholt",
              "self": "https://api.pagerduty.com/users/PXPGF42",
              "html_url": "https://subdomain.pagerduty.com/users/PXPGF42"
            }
          }
        ],
        "acknowledgements": [
          {
            "at": "2015-11-10T00:32:52Z",
            "acknowledger": {
              "id": "PXPGF42",
              "type": "user_reference",
              "summary": "Earline Greenholt",
              "self": "https://api.pagerduty.com/users/PXPGF42",
              "html_url": "https://subdomain.pagerduty.com/users/PXPGF42"
            }
          }
        ],
        "resolved_at": "2015-10-06T21:38:23Z",
        "last_status_change_at": "2015-10-06T21:38:23Z",
        "last_status_change_by": {
          "id": "PXPGF42",
          "type": "user_reference",
          "summary": "Earline Greenholt",
          "self": "https://api.pagerduty.com/users/PXPGF42",
          "html_url": "https://subdomain.pagerduty.com/users/PXPGF42"
        },
        "first_trigger_log_entry": {
          "id": "Q02JTSNZWHSEKV",
          "type": "trigger_log_entry_reference",
          "summary": "Triggered through the API",
          "self": "https://api.pagerduty.com/log_entries/Q02JTSNZWHSEKV?incident_id=PT4KHLK",
          "html_url": "https://subdomain.pagerduty.com/incidents/PT4KHLK/log_entries/Q02JTSNZWHSEKV"
        },
        "incident_type": {
          "name": "major_incident"
        },
        "escalation_policy": {
          "id": "PT20YPA",
          "type": "escalation_policy_reference",
          "summary": "Another Escalation Policy",
          "self": "https://api.pagerduty.com/escalation_policies/PT20YPA",
          "html_url": "https://subdomain.pagerduty.com/escalation_policies/PT20YPA"
        },
        "teams": [
          {
            "id": "PQ9K7I8",
            "type": "team_reference",
            "summary": "Engineering",
            "self": "https://api.pagerduty.com/teams/PQ9K7I8",
            "html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8"
          }
        ],
        "urgency": "high"
      }
    ]
  }
}

Raw Request​

Issue a raw HTTP request | key: rawRequest

InputNotesExample
Connection
Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
Debug Request

Enabling this flag will log out the current request.

false
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

This is the URL to call.

/sobjects/Account
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false

Render Template​

Render a template | key: renderTemplate

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Id

The ID of the Template.

PBZUP2B
Incident ID

The ID of the Incident

PT4KHLK
Update Message

An optional status update message that will be sent to the template.

Status update message

{
  "data": {
    "templated_fields": {
      "email_subject": "Update: Status update message",
      "email_body": "<div class=\"test\">Status update message</div>",
      "message": "Update: Status update message"
    },
    "warnings": [
      {
        "email_body": [
          "{{incident.bad_value}} does not exist."
        ]
      }
    ],
    "errors": []
  }
}

Send Change Event​

Send Change Event to Events API | key: sendChangeEvent

InputNotesExample
Debug Request

Enabling this flag will log out the current request.

false
Change Event To Send

The JSON object body of the event.

{
  "data": {
    "status": "success",
    "message": "Event processed",
    "dedup_key": "srv01/HTTP"
  }
}

Send Event​

Sends PagerDuty a trigger event to report a new event | key: sendEvent

InputNotesExample
Debug Request

Enabling this flag will log out the current request.

false
Event to Send

The JSON object body of the event.

{
  "data": {
    "status": "success",
    "message": "Event processed",
    "dedup_key": "srv01/HTTP"
  }
}

Test Webhook Subscription​

Test a webhook subscription | key: testWebhookSubscription

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Webhook ID.

The ID of the webhook.

sampleWebhookId

{
  "data": "Action successfully completed."
}

Update Change Event​

Update a Change Event | key: updateChangeEvent

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Change Event to Update

The JSON object body of the event.

Event Id

The ID of the Change Event.

12

{
  "data": {
    "summary": "Build Success - Increase snapshot create timeout to 30 seconds",
    "timestamp": "2020-07-17T08:42:58Z",
    "type": "change_event",
    "source": "acme-build-pipeline-tool-default-i-9999",
    "integration": {
      "id": "PEYSGVF",
      "type": "inbound_integration_reference"
    },
    "services": [
      {
        "id": "PEYSGRV",
        "type": "service_reference"
      }
    ],
    "custom_details": {
      "build_state": "passed",
      "build_number": "2",
      "run_time": "1236s"
    },
    "links": [
      {
        "href": "https://acme.pagerduty.dev/build/2",
        "text": "View more details in Acme!"
      }
    ]
  }
}

Update Incident​

Update an incident | key: updateIncident

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Incident ID

The ID of the Incident

PT4KHLK
Incident

The parameters of the incident to update

{
  "data": {
    "incident": {
      "id": "PT4KHLK",
      "type": "incident",
      "summary": "[#1234] The server is on fire.",
      "self": "https://api.pagerduty.com/incidents/PT4KHLK",
      "html_url": "https://subdomain.pagerduty.com/incidents/PT4KHLK",
      "incident_number": 1234,
      "created_at": "2015-10-06T21:30:42Z",
      "updated_at": "2015-10-06T21:40:23Z",
      "status": "resolved",
      "title": "The server is on fire.",
      "pending_actions": [
        {
          "type": "unacknowledge",
          "at": "2015-11-10T01:02:52Z"
        },
        {
          "type": "resolve",
          "at": "2015-11-10T04:31:52Z"
        }
      ],
      "incident_key": "baf7cf21b1da41b4b0221008339ff357",
      "service": {
        "id": "PIJ90N7",
        "type": "service_reference",
        "summary": "My Mail Service",
        "self": "https://api.pagerduty.com/services/PIJ90N7",
        "html_url": "https://subdomain.pagerduty.com/service-directory/PIJ90N7"
      },
      "priority": {
        "id": "P53ZZH5",
        "type": "priority_reference",
        "summary": "P2",
        "self": "https://api.pagerduty.com/priorities/P53ZZH5"
      },
      "assigned_via": "escalation_policy",
      "assignments": [
        {
          "at": "2015-11-10T00:31:52Z",
          "assignee": {
            "id": "PXPGF42",
            "type": "user_reference",
            "summary": "Earline Greenholt",
            "self": "https://api.pagerduty.com/users/PXPGF42",
            "html_url": "https://subdomain.pagerduty.com/users/PXPGF42"
          }
        }
      ],
      "acknowledgements": [
        {
          "at": "2015-11-10T00:32:52Z",
          "acknowledger": {
            "id": "PXPGF42",
            "type": "user_reference",
            "summary": "Earline Greenholt",
            "self": "https://api.pagerduty.com/users/PXPGF42",
            "html_url": "https://subdomain.pagerduty.com/users/PXPGF42"
          }
        }
      ],
      "resolved_at": "2015-10-06T21:38:23Z",
      "last_status_change_at": "2015-10-06T21:38:23Z",
      "last_status_change_by": {
        "id": "PXPGF42",
        "type": "user_reference",
        "summary": "Earline Greenholt",
        "self": "https://api.pagerduty.com/users/PXPGF42",
        "html_url": "https://subdomain.pagerduty.com/users/PXPGF42"
      },
      "first_trigger_log_entry": {
        "id": "Q02JTSNZWHSEKV",
        "type": "trigger_log_entry_reference",
        "summary": "Triggered through the API",
        "self": "https://api.pagerduty.com/log_entries/Q02JTSNZWHSEKV?incident_id=PT4KHLK",
        "html_url": "https://subdomain.pagerduty.com/incidents/PT4KHLK/log_entries/Q02JTSNZWHSEKV"
      },
      "incident_type": {
        "name": "major_incident"
      },
      "escalation_policy": {
        "id": "PT20YPA",
        "type": "escalation_policy_reference",
        "summary": "Another Escalation Policy",
        "self": "https://api.pagerduty.com/escalation_policies/PT20YPA",
        "html_url": "https://subdomain.pagerduty.com/escalation_policies/PT20YPA"
      },
      "teams": [
        {
          "id": "PQ9K7I8",
          "type": "team_reference",
          "summary": "Engineering",
          "self": "https://api.pagerduty.com/teams/PQ9K7I8",
          "html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8"
        }
      ],
      "urgency": "high"
    }
  }
}

Update Incident Alert​

Update an incident alert | key: updateIncidentAlert

InputNotesExample
Alerts

An array of alert objects, including the parameters to update for each alert

Incident Alert ID

The ID of the Incident Alert

PT4KHLK
Connection
Debug Request

Enabling this flag will log out the current request.

false
Incident ID

The ID of the Incident

PT4KHLK

{
  "data": {
    "alert": {
      "type": "alert",
      "status": "resolved",
      "incident": {
        "id": "PEYSGVF",
        "type": "incident_reference"
      },
      "body": {
        "type": "alert_body",
        "contexts": [
          {
            "type": "link"
          }
        ],
        "details": {
          "customKey": "Server is on fire!",
          "customKey2": "Other stuff!"
        }
      }
    }
  }
}

Update Service​

Update a service | key: updateService

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Service ID

The ID of the Service.

Service

JSON object body of the Service to update

{
  "data": {
    "service": {
      "id": "PIJ90N7",
      "type": "service",
      "summary": "My Application Service",
      "self": "https://api.pagerduty.com/services/PIJ90N7",
      "html_url": "https://subdomain.pagerduty.com/service-directory/PIJ90N7",
      "name": "My Application Service",
      "auto_resolve_timeout": 14400,
      "acknowledgement_timeout": 600,
      "created_at": "2015-11-06T11:12:51-05:00",
      "status": "active",
      "alert_creation": "create_alerts_and_incidents",
      "alert_grouping_parameters": {
        "type": "time",
        "config": {
          "timeout": 2
        }
      },
      "integrations": [
        {
          "id": "PQ12345",
          "type": "generic_email_inbound_integration_reference",
          "summary": "Email Integration",
          "self": "https://api.pagerduty.com/services/PIJ90N7/integrations/PQ12345",
          "html_url": "https://subdomain.pagerduty.com/services/PIJ90N7/integrations/PQ12345"
        }
      ],
      "escalation_policy": {
        "id": "PT20YPA",
        "type": "escalation_policy_reference",
        "summary": "Another Escalation Policy",
        "self": "https://api.pagerduty.com/escalation_policies/PT20YPA",
        "html_url": "https://subdomain.pagerduty.com/escalation_policies/PT20YPA"
      },
      "teams": [
        {
          "id": "PQ9K7I8",
          "type": "team_reference",
          "summary": "Engineering",
          "self": "https://api.pagerduty.com/teams/PQ9K7I8",
          "html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8"
        }
      ],
      "incident_urgency_rule": {
        "type": "use_support_hours",
        "during_support_hours": {
          "type": "constant",
          "urgency": "high"
        },
        "outside_support_hours": {
          "type": "constant",
          "urgency": "low"
        }
      },
      "support_hours": {
        "type": "fixed_time_per_day",
        "time_zone": "America/Lima",
        "start_time": "09:00:00",
        "end_time": "17:00:00",
        "days_of_week": [
          1,
          2,
          3,
          4,
          5
        ]
      },
      "scheduled_actions": [
        {
          "type": "urgency_change",
          "at": {
            "type": "named_time",
            "name": "support_hours_start"
          },
          "to_urgency": "high"
        }
      ],
      "auto_pause_notifications_parameters": {
        "enabled": true,
        "timeout": 300
      }
    }
  }
}

Update Template​

Update a template | key: updateTemplate

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Id

The ID of the Template.

PBZUP2B
Template

JSON object body of the Template to be updated

{
  "data": {
    "template": {
      "created_at": "2022-08-19T13:46:22Z",
      "created_by": {
        "id": "PF9KMXH",
        "self": "https://api.pagerduty.com/users/PF9KMXH",
        "type": "user_reference"
      },
      "description": "Sample template description",
      "templated_fields": {
        "email_body": "<div> sample </div>",
        "email_subject": "Sample email Subject",
        "message": "Sample SMS message"
      },
      "id": "PCCR863",
      "name": "Sample Template",
      "self": "https://api.pagerduty.com/templates/PCCR863",
      "template_type": "status_update",
      "type": "template",
      "updated_at": "2022-08-19T13:46:22Z",
      "updated_by": {
        "id": "PF9KMXH",
        "self": "https://api.pagerduty.com/users/PF9KMXH",
        "type": "user_reference"
      }
    }
  }
}

Update User​

Update a user | key: updateUser

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Id

The ID of the User to update.

User

JSON object body of the User to create.

{
  "data": {
    "user": {
      "id": "PXPGF42",
      "type": "user",
      "summary": "Earline Greenholt",
      "self": "https://api.pagerduty.com/users/PXPGF42",
      "html_url": "https://subdomain.pagerduty.com/users/PXPGF42",
      "name": "Earline Greenholt",
      "email": "125.greenholt.earline@graham.name",
      "time_zone": "America/Lima",
      "color": "green",
      "role": "admin",
      "avatar_url": "https://secure.gravatar.com/avatar/a8b714a39626f2444ee05990b078995f.png?d=mm&r=PG",
      "description": "I'm the boss",
      "invitation_sent": false,
      "contact_methods": [
        {
          "id": "PTDVERC",
          "type": "email_contact_method_reference",
          "summary": "Default",
          "self": "https://api.pagerduty.com/users/PXPGF42/contact_methods/PTDVERC"
        }
      ],
      "notification_rules": [
        {
          "id": "P8GRWKK",
          "type": "assignment_notification_rule_reference",
          "summary": "Default",
          "self": "https://api.pagerduty.com/users/PXPGF42/notification_rules/P8GRWKK",
          "html_url": null
        }
      ],
      "job_title": "Director of Engineering",
      "teams": [
        {
          "id": "PQ9K7I8",
          "type": "team_reference",
          "summary": "Engineering",
          "self": "https://api.pagerduty.com/teams/PQ9K7I8",
          "html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8"
        }
      ]
    }
  }
}

Update Webhook Subscription​

Update a webhook subscription | key: updateWebhookSubscription

InputNotesExample
Connection
Debug Request

Enabling this flag will log out the current request.

false
Webhook ID.

The ID of the webhook.

sampleWebhookId
Update Webhook Payload

The updated webhook subscription object.

{
  "data": {
    "webhook_subscription": {
      "delivery_method": {
        "id": "PF9KMXH",
        "secret": null,
        "temporarily_disabled": false,
        "type": "http_delivery_method",
        "url": "https://example.com/receive_a_pagerduty_webhook",
        "custom_headers": [
          {
            "name": "your-header-name",
            "value": "-- redacted --"
          }
        ]
      },
      "description": "Sends PagerDuty v3 webhook events somewhere interesting.",
      "events": [
        "incident.acknowledged",
        "incident.annotated",
        "incident.delegated",
        "incident.escalated",
        "incident.priority_updated",
        "incident.reassigned",
        "incident.reopened",
        "incident.resolved",
        "incident.responder.added",
        "incident.responder.replied",
        "incident.triggered",
        "incident.unacknowledged"
      ],
      "filter": {
        "id": "P393ZNQ",
        "type": "service_reference"
      },
      "id": "PY1OL64",
      "type": "webhook_subscription",
      "active": true
    }
  }
}