PluginsNotificationsTasksZulip

ZulipIncomingWebhook​Zulip​Incoming​Webhook

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

Send a Zulip message using an Incoming Webhook

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

Examples

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

url

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min length: 1

Zulip incoming webhook URL

options

Options

The options to set to customize the HTTP client

payload

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Zulip message payload

Definitions

java.nio.charset.Charset

io.kestra.plugin.notifications.AbstractHttpOptionsTask-RequestOptions

  • connectTimeout
    • Type:
      • string
      • string
    • Dynamic: ✔️
    • Required: ❌
  • connectionPoolIdleTimeout
    • Type:
      • string
      • string
    • Dynamic: ✔️
    • Required: ❌
  • defaultCharset
    • Type:
      • string
    • Dynamic: ✔️
    • Required: ❌
  • maxContentLength
    • Type:
      • integer
      • string
    • Dynamic: ✔️
    • Required: ❌
  • readIdleTimeout
    • Type:
      • string
      • string
    • Dynamic: ✔️
    • Required: ❌
  • readTimeout
    • Type:
      • string
      • string
    • Dynamic: ✔️
    • Required: ❌