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 ·
· Changelog ↓

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​

key: pagerduty-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​

key: pagerduty-oauth

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

The Incidents Trigger receives webhook notifications from PagerDuty when incident events occur. This trigger automatically manages webhook subscriptions — the entire lifecycle is handled without manual configuration in the PagerDuty dashboard.

How It Works​

When this trigger is used in a flow:

  • On Instance Deploy: The trigger automatically creates a V3 webhook subscription in PagerDuty pointing to the instance's unique webhook URL. The subscription is configured with the selected incident events, a filter (by account, service, or team), and a description.
  • On Instance Deletion: The trigger automatically removes all webhook subscriptions associated with the instance's webhook URLs from PagerDuty.

Configuration​

Configure the following inputs:

  • Incident Events: Select which incident events the webhook subscription should monitor. Multiple events can be selected.
  • Webhook Description: A description for the webhook subscription created in PagerDuty.
  • Filter ID: The ID of the PagerDuty object (account, service, or team) used to scope the webhook subscription.
  • Filter Type: The type of object used as the filter — Account, Service, or Team.

Event Types​

Available Incident Events (17)
EventDescription
incident.acknowledgedAn incident is acknowledged
incident.annotatedA note is added to an incident
incident.conference_bridge.updatedAn incident's conference bridge is updated
incident.delegatedAn incident is delegated
incident.escalatedAn incident is escalated
incident.priority_updatedAn incident's priority is updated
incident.reassignedAn incident is reassigned
incident.reopenedAn incident is reopened
incident.resolvedAn incident is resolved
incident.responder.addedA responder is added to an incident
incident.responder.repliedA responder replies to an incident
incident.service_updatedAn incident's service is updated
incident.status_update_publishedA status update is published for an incident
incident.triggeredAn incident is triggered
incident.unacknowledgedAn incident is unacknowledged
incident.workflow.startedAn incident workflow is started
incident.workflow.completedAn incident workflow is completed

Refer to the PagerDuty webhooks documentation for the complete and up-to-date list of event types.

Returned Data​

Example Payload
{
  "event": {
    "id": "01DEN0M0L0OCDNR0CDEVP4SRGH",
    "event_type": "incident.triggered",
    "resource_type": "incident",
    "occurred_at": "2024-01-15T10:30:00.000Z",
    "data": {
      "id": "Q1P5SQEISWZ3K4",
      "type": "incident",
      "title": "Server is on fire",
      "status": "triggered",
      "urgency": "high",
      "service": {
        "id": "PF9KMXH",
        "type": "service_reference",
        "summary": "Production API"
      }
    }
  }
}

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

The Service Trigger receives webhook notifications from PagerDuty when service events occur. This trigger works identically to the Incidents Trigger, automatically managing webhook subscriptions throughout the instance lifecycle.

See Incidents Trigger for complete documentation on how lifecycle management, configuration, and webhook subscriptions work.

Configuration​

Configure the following inputs:

  • Service Events: Select which service events the webhook subscription should monitor.
  • Webhook Description: A description for the webhook subscription created in PagerDuty.
  • Filter ID: The ID of the PagerDuty object (account, service, or team) used to scope the webhook subscription.
  • Filter Type: The type of object used as the filter — Account, Service, or Team.

Event Types​

Available Service Events (3)
EventDescription
service.createdA service is created
service.deletedA service is deleted
service.updatedA service is updated

Refer to the PagerDuty webhooks documentation for the complete and up-to-date list of event types.

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
Incident

JSON object body of the incident to be created

{"incident":{"type":"incident","title":"The server is on fire.","service":{"id":"PWIXJZS","type":"service_reference"},"priority":{"id":"P53ZZH5","type":"priority_reference"},"urgency":"high","incident_key":"baf7cf21b1da41b4b0221008339ff357","body":{"type":"incident_body","details":"A disk is getting full on this machine. You should investigate what is causing the disk to fill, and ensure that there is an automated process in place for ensuring data is rotated (eg. logs should have logrotate around them). If data is expected to stay on this disk forever, you should start planning to scale up to a larger disk."},"escalation_policy":{"id":"PT20YPA","type":"escalation_policy_reference"}}}
Example Payload for Create Incident⤓
Loading…

Create Incident Note​

Create a note on an incident | key: createIncidentNote

InputNotesExample
Connection
Incident ID

The ID of the Incident

PT4KHLK
Note

Note to create.

{"note":"Firefighters are on the scene."}
Example Payload for Create Incident Note⤓
Loading…

Create Service​

Create a service | key: createService

InputNotesExample
Connection
Service

JSON object body of the Service to create

Example Payload for Create Service⤓
Loading…

Create Template​

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

InputNotesExample
Connection
Template Object

JSON object body of the new Template to be created

{
  "description": "Sample template description",
  "templated_fields": {
    "email_body": "<div> sample </div>",
    "email_subject": "Sample email Subject",
    "message": "Sample SMS message"
  },
  "name": "Sample Template",
  "template_type": "status_update"
}
Example Payload for Create Template⤓
Loading…

Create User​

Create a user | key: createUser

InputNotesExample
Connection
User

JSON object body of the User to create.

{
  "user": {
    "type": "user",
    "name": "Earline Greenholt",
    "email": "125.greenholt.earline@graham.name",
    "time_zone": "America/Lima",
    "color": "green",
    "role": "admin",
    "job_title": "Director of Engineering",
    "avatar_url": "https://secure.gravatar.com/avatar/1d1a39d4635208d5664082a6c654a73f.png?d=mm&r=PG",
    "description": "I'm the boss",
    "license": {
      "id": "PTDVERC",
      "type": "license_reference"
    }
  }
}
Example Payload for Create User⤓
Loading…

Create Webhook Subscription​

Create a webhook subscription | key: createWebhookSubscription

InputNotesExample
Connection
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
}
Example Payload for Create Webhook Subscription⤓
Loading…

Delete All Instance Webhooks​

Delete all webhooks associated with this instance | key: deleteAllInstanceWebhooks

InputNotesExample
Connection

Delete Service​

Delete a service | key: deleteService

InputNotesExample
Connection
Service ID

The ID of the Service.

Example Payload for Delete Service⤓
Loading…

Delete Template​

Delete a template | key: deleteTemplate

InputNotesExample
Connection
Id

The ID of the Template.

PBZUP2B
Example Payload for Delete Template⤓
Loading…

Delete User​

Delete a user | key: deleteUser

InputNotesExample
Connection
Id

The ID of the User to update.

Example Payload for Delete User⤓
Loading…

Delete Webhook Subscription​

Delete a webhook subscription | key: deleteWebhookSubscription

InputNotesExample
Connection
Webhook ID.

The ID of the webhook.

sampleWebhookId
Example Payload for Delete Webhook Subscription⤓
Loading…

Enable Webhook Subscription​

Enable a webhook subscription | key: enableWebhookSubscription

InputNotesExample
Connection
Webhook ID.

The ID of the webhook.

sampleWebhookId
Example Payload for Enable Webhook Subscription⤓
Loading…

Get Change Event​

Get a Change Event | key: getChangeEvent

InputNotesExample
Connection
Event Id

The ID of the Change Event.

12
Example Payload for Get Change Event⤓
Loading…

Get Incident​

Get an incident | key: getIncident

InputNotesExample
Connection
Incident ID

The ID of the Incident

PT4KHLK
Include

Array of additional details to include

Example Payload for Get Incident⤓
Loading…

Get Incident Alert​

Get an alert | key: getIncidentAlert

InputNotesExample
Incident Alert ID

The ID of the Incident Alert

PT4KHLK
Connection
Incident ID

The ID of the Incident

PT4KHLK
Example Payload for Get Incident Alert⤓
Loading…

Get Service​

Get a service | key: getService

InputNotesExample
Connection
Service ID

The ID of the Service.

Include

Array of additional details to include.

Example Payload for Get Service⤓
Loading…

Get Template​

Get a template | key: getTemplate

InputNotesExample
Connection
Id

The ID of the Template.

PBZUP2B
Example Payload for Get Template⤓
Loading…

Get User​

Get a user | key: getUser

InputNotesExample
Connection
Id

The ID of the User to update.

Include

Array of additional Models to include in response.

Example Payload for Get User⤓
Loading…

Get Webhook Subscription​

Get a webhook subscription | key: getWebhookSubscription

InputNotesExample
Connection
Webhook ID.

The ID of the webhook.

sampleWebhookId
Example Payload for Get Webhook Subscription⤓
Loading…

List Change Events​

List Change Events | key: listChangeEvents

InputNotesExample
Connection
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
Example Payload for List Change Events⤓
Loading…

List Incident Alerts​

List alerts for an incident | key: listIncidentAlerts

InputNotesExample
Alert Key

Alert de-duplication key

baf7cf21b1da41b4b0221008339ff357
Connection
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
Example Payload for List Incident Alerts⤓
Loading…

List Incident Notes​

List notes for an incident | key: listIncidentNotes

InputNotesExample
Connection
Incident ID

The ID of the Incident

PT4KHLK
Example Payload for List Incident Notes⤓
Loading…

List Incidents​

List incidents | key: listIncidents

InputNotesExample
Connection
Date Range

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

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
Example Payload for List Incidents⤓
Loading…

List Notifications​

List notifications | key: listNotifications

InputNotesExample
Connection
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
Example Payload for List Notifications⤓
Loading…

List Priorities​

List priorities | key: listPriorities

InputNotesExample
Connection
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
Example Payload for List Priorities⤓
Loading…

List Services​

List services | key: listServices

InputNotesExample
Connection
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
Example Payload for List Services⤓
Loading…

List Templates​

List all templates | key: getTemplates

InputNotesExample
Connection
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
Example Payload for List Templates⤓
Loading…

List Users​

List all users | key: listUsers

InputNotesExample
Connection
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
Example Payload for List Users⤓
Loading…

List Webhook Subscriptions​

List webhook subscriptions | key: listWebhookSubscriptions

InputNotesExample
Connection
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
Example Payload for List Webhook Subscriptions⤓
Loading…

Manage Incident Alerts​

Manage alerts | key: updateIncidentAlerts

InputNotesExample
Alerts

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

Connection
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
Example Payload for Manage Incident Alerts⤓
Loading…

Manage Incidents​

Manage Incidents | key: updateIncidents

InputNotesExample
Connection
Incidents

An array of incidents, including the parameters to update.

[
  {
    "id": "PT4KHLK",
    "type": "incident_reference",
    "status": "acknowledged"
  },
  {
    "id": "PQMF62U",
    "type": "incident_reference",
    "priority": {
      "id": "P53ZZH5",
      "type": "priority_reference"
    }
  },
  {
    "id": "PPVZH9X",
    "type": "incident_reference",
    "status": "resolved"
  },
  {
    "id": "P8JOGX7",
    "type": "incident_reference",
    "assignments": [
      {
        "assignee": {
          "id": "PXPGF42",
          "type": "user_reference"
        }
      }
    ]
  },
  {
    "id": "PYJ9K7I",
    "type": "incident_reference",
    "incident_type": {
      "name": "major_incident"
    }
  }
]
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
Example Payload for Manage Incidents⤓
Loading…

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
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
Example Payload for Render Template⤓
Loading…

Send Change Event​

Send Change Event to Events API | key: sendChangeEvent

InputNotesExample
Change Event To Send

The JSON object body of the event.

{
  "routing_key": "testRoutingKey",
  "payload": {
    "summary": "Build Success: Increase snapshot create timeout to 30 seconds",
    "timestamp": "2015-07-17T08:42:58.315+0000",
    "source": "prod-build-agent-i-0b148d1040d565540",
    "custom_details": {
      "build_state": "passed",
      "build_number": "220",
      "run_time": "1236s"
    }
  },
  "links": [
    {
      "href": "https://buildpipeline.com/pagerduty/deployment/builds/220",
      "text": "View in Build Pipeline"
    }
  ],
  "images": [
    {
      "src": "https://chart.googleapis.com/chart?chs=600x400&chd=t:6,2,9,5,2,5,7,4,8,2,1&cht=lc&chds=a&chxt=y&chm=D,0033FF,0,0,5,1",
      "href": "https://google.com",
      "alt": "An example link with an image"
    }
  ]
}
Example Payload for Send Change Event⤓
Loading…

Send Event​

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

InputNotesExample
Event to Send

The JSON object body of the event.

{
  "payload": {
    "summary": "DISK at 99% on machine prod-datapipe03.example.com",
    "timestamp": "2015-07-17T08:42:58.315+0000",
    "severity": "critical",
    "source": "prod-datapipe03.example.com",
    "component": "mysql",
    "group": "prod-datapipe",
    "class": "disk",
    "custom_details": {
      "free space": "1%",
      "ping time": "1500ms",
      "load avg": 0.75
    }
  },
  "routing_key": "e93facc04764012d7bfb002500d5d1a6",
  "dedup_key": "srv01/mysql",
  "event_action": "trigger",
  "client": "Sample Monitoring Service",
  "client_url": "https://monitoring.service.com",
  "links": [
    {
      "href": "http://pagerduty.example.com",
      "text": "An example link."
    }
  ],
  "images": [
    {
      "src": "https://chart.googleapis.com/chart?chs=600x400&chd=t:6,2,9,5,2,5,7,4,8,2,1&cht=lc&chds=a&chxt=y&chm=D,0033FF,0,0,5,1",
      "href": "https://google.com",
      "alt": "An example link with an image"
    }
  ]
}
Example Payload for Send Event⤓
Loading…

Test Webhook Subscription​

Test a webhook subscription | key: testWebhookSubscription

InputNotesExample
Connection
Webhook ID.

The ID of the webhook.

sampleWebhookId
Example Payload for Test Webhook Subscription⤓
Loading…

Update Change Event​

Update a Change Event | key: updateChangeEvent

InputNotesExample
Connection
Change Event to Update

The JSON object body of the event.

{
  "change_event": {
    "summary": "Build Success - Increase snapshot create timeout to 30 seconds",
    "type": "change_event",
    "custom_details": {
      "build_state": "passed",
      "build_number": "2",
      "run_time": "1236s"
    }
  }
}
Event Id

The ID of the Change Event.

12
Example Payload for Update Change Event⤓
Loading…

Update Incident​

Update an incident | key: updateIncident

InputNotesExample
Connection
Incident ID

The ID of the Incident

PT4KHLK
Incident

The parameters of the incident to update

Example Payload for Update Incident⤓
Loading…

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
Incident ID

The ID of the Incident

PT4KHLK
Example Payload for Update Incident Alert⤓
Loading…

Update Service​

Update a service | key: updateService

InputNotesExample
Connection
Service ID

The ID of the Service.

Service

JSON object body of the Service to update

{
  "type": "service",
  "name": "My Web App",
  "description": "My cool web application that does things.",
  "auto_resolve_timeout": 14400,
  "acknowledgement_timeout": 600,
  "status": "active",
  "escalation_policy": {
    "id": "PWIP6CQ",
    "type": "escalation_policy_reference"
  },
  "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"
    }
  ],
  "alert_creation": "create_alerts_and_incidents",
  "alert_grouping_parameters": {
    "type": "time",
    "config": {
      "timeout": 2
    }
  },
  "auto_pause_notifications_parameters": {
    "enabled": true,
    "timeout": 300
  }
}
Example Payload for Update Service⤓
Loading…

Update Template​

Update a template | key: updateTemplate

InputNotesExample
Connection
Id

The ID of the Template.

PBZUP2B
Template

JSON object body of the Template to be updated

{
  "description": "Sample template description",
  "templated_fields": {
    "email_body": "<div> sample </div>",
    "email_subject": "Sample email Subject",
    "message": "Sample SMS message"
  },
  "name": "Sample Template",
  "template_type": "status_update"
}
Example Payload for Update Template⤓
Loading…

Update User​

Update a user | key: updateUser

InputNotesExample
Connection
Id

The ID of the User to update.

User

JSON object body of the User to create.

{
  "user": {
    "type": "user",
    "name": "Earline Greenholt",
    "email": "125.greenholt.earline@graham.name",
    "time_zone": "America/Lima",
    "color": "green",
    "role": "admin",
    "job_title": "Director of Engineering",
    "avatar_url": "https://secure.gravatar.com/avatar/1d1a39d4635208d5664082a6c654a73f.png?d=mm&r=PG",
    "description": "I'm the boss",
    "license": {
      "id": "PTDVERC",
      "type": "license_reference"
    }
  }
}
Example Payload for Update User⤓
Loading…

Update Webhook Subscription​

Update a webhook subscription | key: updateWebhookSubscription

InputNotesExample
Connection
Webhook ID.

The ID of the webhook.

sampleWebhookId
Update Webhook Payload

The updated webhook subscription object.

{
  "webhook_subscription": {
    "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"
    ]
  }
}
Example Payload for Update Webhook Subscription⤓
Loading…

Changelog​

2026-04-30​

Updated spectral version

2026-04-07​

Various modernizations and documentation updates