Skip to main content
Version: 预览版

使用 Webhook 发送通知

在一些情况下,当我们使用工作流部署应用前后,希望能够得到部署的通知。KubeVela 提供了与 Webhook 集成的能力,支持用户在工作流中向邮件、钉钉、Slack 或者飞书发送通知。

本节将介绍如何在工作流中通过 notification 发送 Webhook 通知。

如何使用#

部署如下应用部署计划,在部署组件前后,都有一个 notification 步骤发送通知:

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: first-vela-workflow
namespace: default
spec:
components:
- name: express-server
type: webservice
properties:
image: oamdev/hello-world
port: 8000
traits:
- type: ingress
properties:
domain: testsvc.example.com
http:
/: 8000
workflow:
steps:
- name: dingtalk-message
# 指定步骤类型
type: notification
properties:
dingding:
# 钉钉 Webhook 地址,请查看:https://developers.dingtalk.com/document/robots/custom-robot-access
url:
value: <your dingding url>
# 具体要发送的信息详情
message:
msgtype: text
text:
content: 开始运行工作流
- name: application
type: apply-component
properties:
component: express-server
outputs:
- name: app-status
valueFrom: output.status.conditions[0].message + "工作流运行完成"
- name: slack-message
type: webhook-notification
inputs:
- from: app-status
parameterKey: slack.message.text
properties:
slack:
# Slack Webhook 地址,请查看:https://api.slack.com/messaging/webhooks
url:
secretRef:
name: <the secret name that stores your slack url>
key: <the secret key that stores your slack url>
# 具体要发送的信息详情,会被 input 中的值覆盖
# message:
# text: condition message + 工作流运行完成

期望结果#

通过与 Webhook 的对接,可以看到,在工作流中的组件部署前后,都能在对应的群聊中看到相应的信息。

通过 notification ,可以使用户方便的与 Webhook 对接消息通知。

参数说明#

请参考 Notification 内置步骤

Last updated on by Jianbo Sun