pluginsplugin-notificationszulip

ZulipIncomingWebhook​Zulip​Incoming​Webhook

Send a Zulip message using an Incoming Webhook.

Add this task to send direct Zulip notifications. Check the Zulip documentation for more details.

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

Send a Zulip notification on a failed flow execution.

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.zulip.ZulipIncomingWebhook
    url: "{{ secret('ZULIP_WEBHOOK') }}" # https://yourZulipDomain.zulipchat.com/api/v1/external/INTEGRATION_NAME?api_key=API_KEY
    payload: |
      {
        "text": "Failure alert for flow {{ flow.namespace }}.{{ flow.id }} with ID {{ execution.id }}"
      }

Send a Zulip message via incoming webhook with a text argument.

yaml
id: zulip_incoming_webhook
namespace: company.team

tasks:
  - id: send_zulip_message
    type: io.kestra.plugin.notifications.zulip.ZulipIncomingWebhook
    url: "{{ secret('ZULIP_WEBHOOK') }}" # https://yourZulipDomain.zulipchat.com/api/v1/external/INTEGRATION_NAME?api_key=API_KEY
    payload: |
      {
        "text": "Hello from the workflow {{ flow.id }}"
      }

Send a Zulip message via incoming webhook with a blocks argument, read more on blocks here.

yaml
id: zulip_incoming_webhook
namespace: company.team

tasks:
  - id: send_zulip_message
    type: io.kestra.plugin.notifications.zulip.ZulipIncomingWebhook
    url: "{{ secret('ZULIP_WEBHOOK') }}" # format: https://yourZulipDomain.zulipchat.com/api/v1/external/INTEGRATION_NAME?api_key=API_KEY
    payload: |
      {
        "blocks": [
            {
                "type": "section",
                "text": {
                    "type": "mrkdwn",
                    "text": "Hello from the workflow *{{ flow.id }}*"
                }
            }
        ]
      }
Properties
Min length 1

Zulip incoming webhook URL

Check the Incoming Webhook Integrations documentation for more details.

Options

The options to set to customize the HTTP client

Zulip message payload

Format duration

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

Default PT0S
Format duration

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

Default UTF-8

The default charset for the request.

SubType string

HTTP headers

HTTP headers to include in the request

Default 10485760

The maximum content length of the response.

Default PT5M
Format duration

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

Default PT10S
Format duration

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