PluginsNotificationsTasksPagerdutyPagerDutyExecution

PagerDutyExecution​Pager​Duty​Execution

PagerDutyExecution PagerDutyExecution

yaml
type: "io.kestra.plugin.notifications.pagerduty.PagerDutyExecution"

Send a PagerDuty message with the execution information

The message will include a link to the execution page in the UI along with the execution ID, namespace, flow name, the start date, duration and the final status of the execution, and (if failed) the task that led to a failure.

Use this notification task only in a flow that has a Flow trigger. Don't use this notification task in errors tasks. Instead, for errors tasks, use the PagerDutyAlert task.

Examples

Send a PagerDuty notification on a failed flow execution

yaml
id: failure_alert
namespace: company.team

tasks:
  - id: send_alert
    type: io.kestra.plugin.notifications.pagerduty.PagerDutyExecution
    url: "{{ secret('PAGERDUTY_EVENT') }}" # format: https://events.pagerduty.com/v2/enqueue
    payloadSummary: "PagerDuty Alert"
    deduplicationKey: "dedupkey"
    routingKey: "routingkey"
    eventAction: "acknowledge"
    executionId: "{{trigger.executionId}}"

triggers:
  - id: failed_prod_workflows
    type: io.kestra.plugin.core.trigger.Flow
    conditions:
      - type: io.kestra.plugin.core.condition.ExecutionStatusCondition
        in:
          - FAILED
          - WARNING
      - type: io.kestra.plugin.core.condition.ExecutionNamespaceCondition
        namespace: prod
        prefix: true

Properties

url

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min length: 1

PagerDuty event URL

customFields

  • Type: object
  • Dynamic: ✔️
  • Required: ❌

Custom fields to be added on notification

customMessage

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Custom message to be added on notification

deduplicationKey

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Deduplication key for correlating triggers and resolves

eventAction

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The type of event. Can be trigger, acknowledge or resolve.

executionId

  • Type: string
  • Dynamic: ✔️
  • Required: ❌
  • Default: {{ execution.id }}

The execution id to use

Default is the current execution, change it to {{ trigger.executionId }} if you use this task with a Flow trigger to use the original execution.

options

Options

The options to set to customize the HTTP client

payload

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

PagerDuty message payload

payloadSummary

  • Type: string
  • Dynamic: ✔️
  • Required: ❌
  • Max length: 1024

Brief text summary of the event, used to generate the summaries/titles of any associated alerts

routingKey

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Integration Key for an integration on a PagerDuty service

templateRenderMap

  • Type: object
  • Dynamic: ✔️
  • Required: ❌

Map of variables to use for the message template

Definitions

java.nio.charset.Charset

Properties

io.kestra.plugin.notifications.AbstractHttpOptionsTask-RequestOptions

Properties

connectTimeout
  • Type:
    • string
    • string
  • Dynamic: ✔️
  • Required: ❌
connectionPoolIdleTimeout
  • Type:
    • string
    • string
  • Dynamic: ✔️
  • Required: ❌
defaultCharset
  • Type:
  • Dynamic: ✔️
  • Required: ❌
maxContentLength
  • Type:
    • integer
    • string
  • Dynamic: ✔️
  • Required: ❌
readIdleTimeout
  • Type:
    • string
    • string
  • Dynamic: ✔️
  • Required: ❌
readTimeout
  • Type:
    • string
    • string
  • Dynamic: ✔️
  • Required: ❌

Was this page helpful?