SquadcastExecution
Send a Squadcast message with the execution information.

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.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.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 length1

Squadcast incoming webhook URL

Check the Squadcast Webhook documentation for more details.

customFieldsobject

Custom fields to be added on notification

customMessagestring

Custom message to be added on notification

eventIdstring

Unique event identifier associated with an incident

executionIdstring

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

Options

The options to set to customize the HTTP client

Definitions

io.kestra.plugin.squadcast.AbstractSquadcastConnection-RequestOptions

connectTimeoutstring

Formatduration

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

connectionPoolIdleTimeoutstring

DefaultPT0S

Formatduration

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

defaultCharsetstring

DefaultUTF-8

The default charset for the request.

java.nio.charset.Charset

headersobject

SubTypestring

HTTP headers

HTTP headers to include in the request

maxContentLengthintegerstring

Default10485760

The maximum content length of the response.

readIdleTimeoutstring

DefaultPT5M

Formatduration

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

readTimeoutstring

DefaultPT10S

Formatduration

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

payloadstring

Squadcast message payload

prioritystring

Incident priority

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

statusstring

Incident status

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

tagsobject

SubTypestring

templateRenderMapobject

Map of variables to use for the message template

Zulip

Tasks that send messages to Zulip streams or users.

Alerting

Zenduty

Tasks that create incidents in Zenduty.

Alerting

Splunk

Enterprise

This sub-group of plugins contains tasks for interacting with Splunk. Splunk is a platform for searching, monitoring, and analyzing machine-generated data such as logs and metrics.

AlertingCloud