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.

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

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 *string

Min length 1

Alert creation URL

authorizationToken string

GenieKey. Authorization token from Opsgenie

options AbstractHttpOptionsTask-RequestOptions

Options

The options to set to customize the HTTP client

payload string

Opsgenie alert payload

Definitions

java.nio.charset.Charset

io.kestra.plugin.notifications.AbstractHttpOptionsTask-RequestOptions

connectTimeout string

Format duration

The time allowed to establish a connection to the server before failing.

connectionPoolIdleTimeout string

Default PT0S

Format duration

The time an idle connection can remain in the client's connection pool before being closed.

defaultCharset Charsetstring

Default UTF-8

The default charset for the request.

headers object

SubType string

HTTP headers

HTTP headers to include in the request

maxContentLength integerstring

Default 10485760

The maximum content length of the response.

readIdleTimeout string

Default PT5M

Format duration

The time allowed for a read connection to remain idle before closing it.

readTimeout string

Default PT10S

Format duration

The maximum time allowed for reading data from the server before failing.

​Opsgenie​Alert

OpsgenieAlert