ZulipExecution

yaml
type: "io.kestra.plugin.notifications.zulip.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, and (if failed) the task that led to a failure.

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.

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.ExecutionStatusCondition
        in:
          - FAILED
          - WARNING
      - type: io.kestra.plugin.core.condition.ExecutionNamespaceCondition
        namespace: prod
        prefix: true

Properties

url

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

Zulip incoming webhook URL

Check the Incoming Webhook Integrations documentation for more details..

channel

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

Zulip channel to send the message to

customFields

  • Type: object
  • Dynamic: ✔️
  • Required:

Custom fields to be added on notification

customMessage

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

Custom message to be added on notification

executionId

  • Type: string
  • Dynamic: ✔️
  • Required:
  • Default: {{ execution.id }}

The execution id to use

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

iconEmoji

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

Emoji icon to use

iconUrl

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

Url of the icon to use

payload

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

Zulip message payload

templateRenderMap

  • Type: object
  • Dynamic: ✔️
  • Required:

Map of variables to use for the message template

username

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

Author of the zulip message

Outputs

Definitions

Was this page helpful?