SquadcastExecution

Send a Squadcast message with the execution information.

The message will include execution details such as ID, namespace, flow name, start date, duration, and status.

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

yaml
type: "io.kestra.plugin.notifications.squadcast.SquadcastExecution"

Examples

Send a Squadcast alert via incoming webhook

yaml
id: failure_alert
namespace: company.team

tasks:
  - id: send_alert
    type: io.kestra.plugin.notifications.squadcast.SquadcastExecution
    url: "{{ secret('SQUADCAST_WEBHOOK') }}" # format: https://api.squadcast.com/v2/incidents/api/xyzs
    message: "Kestra Squadcast alert"
    priority: P1
    eventId: "6"
    status: trigger
    tags:
      severity: high
      tagName1: tagValue1
    executionId: "{{ trigger.executionId }}"

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

Properties

message *string

Incident message

The main message of the incident.

url *string

Min length 1

Squadcast incoming webhook URL

Check the Squadcast Webhook documentation for more details.

customFields object

Custom fields to be added on notification

customMessage string

Custom message to be added on notification

eventId string

Unique event identifier associated with an incident

executionId string

Default {{ execution.id }}

The execution id to use

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

options AbstractHttpOptionsTask-RequestOptions

Options

The options to set to customize the HTTP client

payload string

Squadcast message payload

priority string

Incident priority

The priority of the incident (P1, P2, P3, P4, P5). Defaults to 'Unset' if invalid.

status string

Incident status

Status of the incident (e.g., 'trigger', 'resolve').

tags object

SubType string

Map of variables to use for the message template

templateRenderMap object

Map of variables to use for the message template

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.

​Squadcast​Execution

SquadcastExecution