This page contains the workflow actions available for the
PagerDuty Connector.
The Send event action requires a PagerDuty Events connection with a routing key; all other actions require a PagerDuty connection with an API key.
Trigger, acknowledge, or resolve an alert in PagerDuty using the Events API v2. The action's input fields accept dynamic values through workflow expressions, so you can populate event fields such as summary, severity, and source directly from a triggering event, a previous workflow task, or workflow input. Use the Deduplication key to link trigger, acknowledge, and resolve events to the same PagerDuty alert.
| Field | Description | Required |
|---|---|---|
Connection | The preconfigured Events connection to your PagerDuty service or orchestration. | Required |
Summary | A brief text summary of the event, used as the incident title in PagerDuty. Maximum 1024 characters. For workflows with a problem trigger you could use: | Required |
Timestamp | ISO 8601 timestamp of when the event occurred, for example | Optional |
Severity | The perceived severity of the event. One of | Required |
Source | The unique location of the affected system, for example, a hostname or fully qualified domain name. | Required |
Component | Component of the source machine that is responsible for the event. | Optional |
Group | Logical grouping of components of a service. | Optional |
Class | Class or type of the event, for example, the problem category. | Optional |
Deduplication key | Deduplicates alerts for the same problem. Use the same key for trigger, acknowledge, and resolve events to affect the same PagerDuty alert. Required for For workflows with a problem trigger you could use: | Optional |
Event action | Determines whether the event opens, acknowledges, or resolves an alert in PagerDuty.
| Required |
Client | The name of the monitoring client that sends the event, for example, | Optional |
Client URL | The URL of the monitoring client that sends the event, for example, a link to the Dynatrace environment. | Optional |
Custom details | A JSON object of additional details displayed on the alert in PagerDuty. Invalid JSON and non-object values are ignored. | Optional |
Links | Links to attach to the alert. Each link requires a URL and an optional Text label. | Optional |
Images | Images to attach to the alert. Each image requires a Source URL and optionally a Link URL and Alt text. | Optional |
The Send event action provides the following result:
| Property | Description |
|---|---|
| The outcome of the request, for example, |
| A human-readable description of the result, for example |
| The deduplication key used by PagerDuty to correlate this event with others. Use it in downstream workflow tasks to acknowledge or resolve the same alert. |
This result can be used as input for other workflow actions via workflow expressions.
The following example triggers a PagerDuty alert based on Davis problem data, using Jinja expressions to populate dynamic fields, assuming a problem trigger.
| Field | Value |
|---|---|
Summary |
|
Severity |
|
Source |
|
Event action |
|
Class |
|
Deduplication key |
|
Client |
|
Links |
|
Using the same Deduplication key for all events related to the same problem ensures that acknowledged and resolved events affect the same PagerDuty alert instead of creating new ones.
Creates an incident in your PagerDuty environment for a service. An incident represents a problem or an issue that needs to be addressed and resolved.
Use other actions to obtain the necessary input.
| Field | Description | Required |
|---|---|---|
Connection | The preconfigured connection to your PagerDuty environment. | Required |
From | The email address of a valid PagerDuty user associated with the account making the request. | Required |
Title | A description of the nature, symptoms, cause, or effect of the incident. | Required |
Service ID | The ID of the service in your PagerDuty environment. | Required |
Priority ID | The ID of the priority to associate with the incident. | Optional |
Urgency | The urgency of the incident, | Optional |
Additional incident details | A description of the incident. | Optional |
Assignee user ID | The user to assign the incident to. It can't be specified if an escalation policy ID is given. | Optional |
Escalation policy ID | The escalation policy to use for assigning the incident. Mutually exclusive with Assignee user ID. | Optional |
Conference number | The phone number of the conference call for the conference bridge. | Optional |
Conference URL | The URL for the conference bridge, such as a link to a web conference or Slack channel. | Optional |
Incident key | A unique identifier for this incident. For most use cases, this is the Dynatrace event ID. | Optional |
The Create an incident action returns the response of the Create an incident PagerDuty API endpoint.
The result contains a single incident object that describes the created incident.
| Property | Description |
|---|---|
| The created incident, including its |
This result can be used as inputs for other workflow actions via workflow expressions.
Retrieves a list of users who are on call.
| Field | Description | Required |
|---|---|---|
Connection | The preconfigured connection to your PagerDuty environment. | Required |
Limit | Pagination - number of results per page. | Optional |
Offset | Pagination - offset to start results. | Optional |
Total | Pagination - set to true to populate the total field in the response. | Optional |
Earliest | Set to true to return only the earliest on-call for each combination of escalation policy, escalation level, and user. | Optional |
Since | The start of the time range as an ISO8601 date-time. | Optional |
Until | The end of the time range as an ISO8601 date-time. | Optional |
Time zone | The time zone used in results. By default, the time zone of the account. | Optional |
Escalation policy IDs | A comma-separated list of escalation policy IDs to filter the on-calls by. | Optional |
Schedule IDs | A comma-separated list of schedule IDs to filter the on-calls by. | Optional |
User IDs | A comma-separated list of user IDs to filter the on-calls by. | Optional |
Include | A comma-separated list of additional details to include. Supported values: | Optional |
The List on-calls action returns the response of the List all of the on-calls PagerDuty API endpoint.
| Property | Description |
|---|---|
| An array of on-call entries. Each entry references the |
| The pagination fields that describe the returned page of results. |
This result can be used as inputs for other workflow actions via workflow expressions.
Retrieves a list of escalation policies that determine what user or schedule will be notified and in what order when an incident is triggered.
| Field | Description | Required |
|---|---|---|
Connection | The preconfigured connection to your PagerDuty environment. | Required |
Limit | Pagination - number of results per page. | Optional |
Offset | Pagination - offset to start results. | Optional |
Query | Filters results to include only escalation policies with names matching the query. | Optional |
Total | Pagination: set to true to populate the total field in the response. | Optional |
Include | A comma-separated list of additional details to include. Supported values: | Optional |
Sort by | Specifies which field is used to sort results. Supported values: | Optional |
Team IDs | A comma-separated list of team IDs. Only results related to these teams will be returned. | Optional |
User IDs | A comma-separated list of user IDs. Only escalation policies targeting these users will be returned. | Optional |
The List escalation policies action returns the response of the List escalation policies PagerDuty API endpoint.
| Property | Description |
|---|---|
| An array of escalation policies. Each entry includes its |
| The pagination fields that describe the returned page of results. |
This result can be used as inputs for other workflow actions via workflow expressions.
Retrieves an ordered list of priorities, representing the importance of an incident (ordered from most severe to least severe).
| Field | Description | Required |
|---|---|---|
Connection | The preconfigured connection to your PagerDuty environment. | Required |
Limit | Pagination - number of results per page. | Optional |
Offset | Pagination - offset to start results. | Optional |
Total | Pagination: set to true to populate the total field in the response. | Optional |
The List priorities action returns the response of the List priorities PagerDuty API endpoint.
| Property | Description |
|---|---|
| An array of priorities, ordered from the most to the least severe. Each entry includes its |
| The pagination fields that describe the returned page of results. |
This result can be used as inputs for other workflow actions via workflow expressions.
Lists PagerDuty services. A service represents an application, component, or team to which you want to map the incident.
| Field | Description | Required |
|---|---|---|
Connection | The preconfigured connection to your PagerDuty environment. | Required |
Limit | Pagination - number of results per page. | Optional |
Offset | Pagination - offset to start results. | Optional |
Total | Pagination - set to true to populate the total field in the response. | Optional |
Query | Filters results to include only services with names matching the query. | Optional |
Include | A comma-separated list of additional details to include. Supported values: | Optional |
Sort by | Specifies which field is used to sort results. Supported values: | Optional |
Team IDs | A comma-separated list of team IDs. Only results related to these teams will be returned. | Optional |
Time zone | The time zone used in results. By default, the time zone of the account. | Optional |
The List services action returns the response of the List services PagerDuty API endpoint.
| Property | Description |
|---|---|
| An array of services. Each entry includes its |
| The pagination fields that describe the returned page of results. |
This result can be used as inputs for other workflow actions via workflow expressions.
List all users of your PagerDuty environment.
| Field | Description | Required |
|---|---|---|
Connection | The preconfigured connection to your PagerDuty environment. | Required |
Limit | Pagination - number of results per page. | Optional |
Offset | Pagination - offset to start results. | Optional |
Total | Pagination - set to true to populate the total field in the response. | Optional |
Query | Filters results to include only users with names matching the query. | Optional |
Include | A comma-separated list of additional details to include. Supported values: | Optional |
Team IDs | A comma-separated list of team IDs. Only results related to these teams will be returned. | Optional |
The List users action returns the response of the List users PagerDuty API endpoint.
| Property | Description |
|---|---|
| An array of users. Each entry includes its |
| The pagination fields that describe the returned page of results. |
This result can be used as inputs for other workflow actions via workflow expressions.