OpsgenieAlert OpsgenieAlert

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

Send an alert to Opsgenie

Add this task to a list of errors tasks to implement custom flow-level failure notifications. Check the Opsgenie documentation for more details..

Examples

Send a failed flow alert to Opsgenie

yaml
id: unreliable_flow
namespace: company.team

tasks:
  - id: fail
    type: io.kestra.plugin.scripts.shell.Commands
    runner: PROCESS
    commands:
      - exit 1

errors:
  - id: alert_on_failure
    type: io.kestra.plugin.notifications.opsgenie.OpsgenieAlert
    url: "{{ secret('OPSGENIE_REQUEST') }}" # https://api.opsgenie.com/v2/alerts/requests/xxx000xxxxx
    payload: |
      {
        "message":"Kestra Opsgenie alert",
        "alias":"ExecutionError",
        "responders":[
            {"id":"4513b7ea-3b91-438f-b7e4-e3e54af9147c","type":"team"},
            {"id":"bb4d9938-c3c2-455d-aaab-727aa701c0d8","type":"user"},
            {"id":"aee8a0de-c80f-4515-a232-501c0bc9d715","type":"escalation"},
            {"id":"80564037-1984-4f38-b98e-8a1f662df552","type":"schedule"}
         ],
        "visibleTo":[
            {"id":"4513b7ea-3b91-438f-b7e4-e3e54af9147c","type":"team"},
            {"id":"bb4d9938-c3c2-455d-aaab-727aa701c0d8","type":"user"}
         ],
        "tags":["ExecutionFail","Error","Execution"],
        "priority":"P1"
      }
    authorizationToken: sampleAuthorizationToken

Send a Opsgenie alert

yaml
id: opsgenie_incoming_webhook
namespace: company.team

tasks:
  - id: send_opsgenie_message
    type: io.kestra.plugin.notifications.opsgenie.OpsgenieAlert
    url: "{{ secret('OPSGENIE_REQUEST') }}"
    payload: |
      {
        "message":"Kestra Opsgenie alert",
        "alias":"Some Execution",
        "responders":[
            {"id":"4513b7ea-3b91-438f-b7e4-e3e54af9147c","type":"team"},
            {"id":"bb4d9938-c3c2-455d-aaab-727aa701c0d8","type":"user"}
         ],
        "visibleTo":[
            {"id":"4513b7ea-3b91-438f-b7e4-e3e54af9147c","type":"team"},
            {"id":"bb4d9938-c3c2-455d-aaab-727aa701c0d8","type":"user"}
         ],
        "tags":["Execution"],
        "priority":"P2"
      }
    authorizationToken: sampleAuthorizationToken

Properties

url

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

Alert creation URL

authorizationToken

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

GenieKey. Authorization token from Opsgenie

options

Options

The options to set to customize the HTTP client

payload

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

Opsgenie alert payload

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?