ACS::Notify::DingTalkWebhook.json

{
  "FormatVersion": "OOS-2019-06-01",
  "Description": {
    "name-en": "ACS::Notify::DingTalkWebhook",
    "name-zh-cn": "发送通知(DingTalk)",
    "en": "Send notifications to DingTalk via webhook. For details, please see the <a href='https://open.dingtalk.com/document/isvapp/message-type' target='_blank'>documentation</a>",
    "zh-cn": "通过webhook发送通知到DingTalk。详情请查看<a href='https://open.dingtalk.com/document/isvapp/message-type' target='_blank'>文档</a>"
  },
  "Parameters": {
    "webhook": {
      "Label": {
        "en": "DingTalk Webhook",
        "zh-cn": "DingTalk Webhook"
      },
      "Description": {
        "en": "<a href='https://help.aliyun.com/zh/oos/use-cases/use-oos-to-configure-the-approval-process#section-iqc-0ul-vpy' target='_blank' >Get DingTalk Webhook</a>",
        "zh-cn": "<a href='https://help.aliyun.com/zh/oos/use-cases/use-oos-to-configure-the-approval-process#section-iqc-0ul-vpy' target='_blank'>获取钉钉Webhook</a>"
      },
      "Type": "String",
      "Default": "https://oapi.dingtalk.com/robot/send?access_token=12345678900000"
    },
    "msgtype": {
      "Label": {
        "en": "Message types",
        "zh-cn": "消息类型"
      },
      "Description": {
        "en": "Message types",
        "zh-cn": "消息类型"
      },
      "Type": "String",
      "AllowedValues": [
        "text",
        "link",
        "markdown"
      ],
      "Default": "text"
    },
    "text": {
      "Label": {
        "en": "Text param",
        "zh-cn": "文本参数"
      },
      "Description": {
        "en": "Text param. If msgtype is text, this field is needed",
        "zh-cn": "文本参数。如果msgtype为text，则需要输入该字段"
      },
      "Type": "Json",
      "Default": {
        "content": "我就是我, 是不一样的烟火"
      },
      "AssociationPropertyMetadata": {
        "Visible": {
          "Condition": {
            "Fn::Equals": [
              "${msgtype}",
              "text"
            ]
          }
        }
      }
    },
    "link": {
      "Label": {
        "en": "Link param",
        "zh-cn": "链接参数"
      },
      "Description": {
        "en": "Link param. If msgtype is link, this field is needed",
        "zh-cn": "链接参数。如果“msgtype”为“link”，则需要输入该字段"
      },
      "Type": "Json",
      "Default": {
        "text": "这是Link消息",
        "title": "这是一个Link消息",
        "picUrl": "https://img.alicdn.com/tfs/TB1NwmBEL9TBuNjy1zbXXXpepXa-2400-1218.png",
        "messageUrl": "https://open.dingtalk.com/document/"
      },
      "AssociationPropertyMetadata": {
        "Visible": {
          "Condition": {
            "Fn::Equals": [
              "${msgtype}",
              "link"
            ]
          }
        }
      }
    },
    "markdown": {
      "Label": {
        "en": "MarkDown param",
        "zh-cn": "MarkDown参数"
      },
      "Description": {
        "en": "MarkDown param. If msgtype is markdown, this field is needed",
        "zh-cn": "MarkDown参数。如果msgtype为markdown，则需要此字段"
      },
      "Type": "Json",
      "Default": {
        "title": "杭州天气",
        "text": "#### 杭州天气 \n> 9度，西北风1级，空气良89，相对温度73%\n> ![screenshot](https://img.alicdn.com/tfs/TB1NwmBEL9TBuNjy1zbXXXpepXa-2400-1218.png)\n> ###### 10点20分发布 [天气](https://www.dingalk.com)\n"
      },
      "AssociationPropertyMetadata": {
        "Visible": {
          "Condition": {
            "Fn::Equals": [
              "${msgtype}",
              "markdown"
            ]
          }
        }
      }
    },
    "at": {
      "Label": {
        "en": "@ people to read the notification",
        "zh-cn": "@人们阅读通知"
      },
      "Description": {
        "en": "@ people to read the notification",
        "zh-cn": "@人们阅读通知"
      },
      "Type": "Json",
      "Default": {
        "atMobiles": [
          "150XXXXXXXX"
        ],
        "atUserIds": [
          "user123"
        ],
        "isAtAll": false
      },
      "AssociationPropertyMetadata": {
        "Visible": {
          "Condition": {
            "Fn::Or": [
              {
                "Fn::Equals": [
                  "${msgtype}",
                  "text"
                ]
              },
              {
                "Fn::Equals": [
                  "${msgtype}",
                  "markdown"
                ]
              }
            ]
          }
        }
      }
    }
  },
  "Tasks": [
    {
      "Name": "notifyDingTaskWebhook",
      "Action": "ACS::Notify",
      "Description": {
        "en": "Sends notification to DingTalk via webhook",
        "zh-cn": "通过webhook发送通知到DingTalk"
      },
      "Properties": {
        "NotifyType": "WebHook",
        "WebHook": {
          "URI": "{{ webhook }}",
          "Headers": {
            "Content-Type": "application/json"
          },
          "Content": {
            "msgtype": "{{ msgtype }}",
            "text": "{{ text }}",
            "link": "{{ link }}",
            "markdown": "{{ markdown }}",
            "at": "{{ at }}"
          }
        }
      }
    }
  ]
}