PluginsNotificationsTasksOpsgenieOpsgenieExecution

OpsgenieExecution​Opsgenie​Execution

OpsgenieExecution OpsgenieExecution

yaml
type: "io.kestra.plugin.notifications.opsgenie.OpsgenieExecution"

Send a notification with the execution information via Opsgenie

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 OpsgenieAlert task.

Examples

Send notification on a failed flow execution via Opsgenie

yaml
id: failure_alert
namespace: company.team

tasks:
  - id: send_alert
    type: io.kestra.plugin.notifications.opsgenie.OpsgenieExecution
    url: "{{ secret('OPSGENIE_REQUEST') }}" # format: 'https://api.opsgenie.com/v2/alerts/requests/xxxxxxyx-yyyx-xyxx-yyxx-yyxyyyyyxxxx'
    message: "Kestra Opsgenie alert"
    alias: ExecutionError
    responders:
      4513b7ea-3b91-438f-b7e4-e3e54af9147c: team
      bb4d9938-c3c2-455d-aaab-727aa701c0d8: user
      aee8a0de-c80f-4515-a232-501c0bc9d715: escalation
      80564037-1984-4f38-b98e-8a1f662df552: schedule
    visibleTo:
      4513b7ea-3b91-438f-b7e4-e3e54af9147c: team
      bb4d9938-c3c2-455d-aaab-727aa701c0d8: user
    priority: P1
    tags:
      - ExecutionError
      - Error
      - Fail
      - Execution
    authorizationToken: sampleAuthorizationToken
    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

Alert creation URL

alias

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

Map of variables to use for the message template

authorizationToken

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

GenieKey. Authorization token from Opsgenie

customFields

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

Custom fields to be added on notification

customMessage

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

Custom message to be added on notification

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.

message

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

Map of variables to use for the message template

options

Options

The options to set to customize the HTTP client

payload

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

Opsgenie alert payload

priority

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

Map of variables to use for the message template

responders

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

Map of variables to use for the message template

tags

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

Map of variables to use for the message template

templateRenderMap

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

Map of variables to use for the message template

visibleTo

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

Map of variables to use for the message template

Outputs

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?