ZulipExecution

Send a Zulip message with the execution information.

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. If failed, then the task that led to the failure is specified.

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

yaml
type: "io.kestra.plugin.notifications.zulip.ZulipExecution"

Examples

Send a Zulip notification on a failed flow execution.

yaml
id: failure_alert
namespace: company.team

tasks:
  - id: send_alert
    type: io.kestra.plugin.notifications.zulip.ZulipExecution
    url: "{{ secret('ZULIP_WEBHOOK') }}" # format: https://yourZulipDomain.zulipchat.com/api/v1/external/INTEGRATION_NAME?api_key=API_KEY
    channel: "#general"
    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

url *string

Min length 1

Zulip incoming webhook URL

Check the Incoming Webhook Integrations documentation for more details.

channel string

Zulip channel to send the message to

customFields object

Custom fields to be added on notification

customMessage string

Custom message to be added on notification

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.

iconEmoji string

Emoji icon to use

iconUrl string

Url of the icon to use

options AbstractHttpOptionsTask-RequestOptions

Options

The options to set to customize the HTTP client

payload string

Zulip message payload

templateRenderMap object

Map of variables to use for the message template

username string

Author of the zulip message

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.

​Zulip​Execution

ZulipExecution