触发器

概览

触发器配置卡片

触发器配置
触发器配置

此面板配置一些触发器的基本信息,或者进行查阅触发器触发日志等操作。

触发类型目前有五种:

条件卡片

触发器条件
触发器条件

对应上面的触发类型,设置不同触发类型的参数。

动作卡片

触发器动作
触发器动作

当触发器的条件被满足,将会执行触发器中的动作。

目前有五种动作类型可选,分别如下:

  • 邮件
  • 微信模板消息
  • webhook
  • 数据表操作
  • 云函数

不同的触发类型对应可选的动作类型不同,总结如下:

动作类型 触发类型:数据表 触发类型:微信支付回调 触发类型:定时任务
邮件 Y️ Y Y
微信模板消息 Y️ Y️ Y
webhook Y️ Y️ N
数据表操作 Y️ Y️ N
云函数 Y️ Y Y

触发类型

数据表

触发条件:当指定的数据表发生改变(增、删、改),满足触发器设置的条件时。

使用场景:新用户注册成功,向新用户发送一封欢迎邮件。

下面是一些参数说明:

事件类型 说明
create 数据行被创建时触发
update 数据行被更新时触发
delete 数据行被删除时触发
满足条件 说明
任一 OR 满足任一条件
所有 AND 同时满足所有条件

目前触发条件支持的数据类型及其对应的操作符如下:

数据类型 操作符
array contains, isempty
boolean =, !=, isempty
date =, !=, >, >=, <, <=, isempty, range
integer =, !=, >, >=, <, <=, isempty, range
number =, !=, >, >=, <, <=, isempty, range
string regex, =, !=, isempty

微信支付回调

触发条件:当用户微信支付成功时。

使用场景:用户微信支付成功,微信模板消息提醒用户订单详情。

在动作中可以使用的跟订单相关的模板变量如下:

trade_no, created_by, merchandise_schema_id, merchandise_record_id, merchandise_description, merchandise_snapshot, total_cost, paid_at, created_at, updated_at, transaction_no

定时任务

触发条件:根据 cron 规则周期性的触发。

使用场景:用户设定一个每小时的定时任务,用于检查网站健康状态,网站宕机时会自动调用云函数发送邮件提醒管理员

注:定时任务下的邮件、模板消息动作不支持模板变量

文件操作

触发条件:当用户触发文件相关操作(文件上传、文件删除、图片违规校验),以及符合对应设置的操作结果时触发

使用场景:当有用户上传文件成功,发送模版消息提醒到指定用户。

注:文件操作下的WebHook、云函数动作不支持模板变量

在邮件、微信模版消息、数据表操作动作中可以使用的模板变量如下:

created_by.id, created_by.nickname, created_by.gender, created_by.country, created_by.province, created_by.city, created_by.language, created_by.openid, created_by.unionid, created_by.avatar, created_by.is_authorized, created_by.hello, created_by.type, created_by.test, created_by.has_seen_demand, created_by.latest_seen_time, created_by.created_at, created_by.updated_at

IncomingWebhook

触发条件:用户直接访问特定的 URL,也可以通过 Ajax 方式发起一个请求。

详细说明:支持的 HTTP 方法有 GET, POST, PUT, PATCH, DELETE;请求体只支持 JSON 数据,支持自定义 http header, 但是必须以 X_HYDROGEN_ 开头,全部会被转换为大写,此外如自定义 HTTP 头中包含 - 会被转换为 _

速率限制: 每个小程序 5 QPS。

提交示例:

    POST /oserve/v1/incoming-webhook/7YnQmaClzc/ HTTP/1.1
    Host: cloud.minapp.com
    Content-Type: application/json
    Customize-Header: hello

    {
      "hello": "incoming-webhook"
    }

返回示例:

    HTTP/1.1 200 OK
    Content-Type: application/json;charset:utf-8

    {
      "status": "ok"
    }

对应触发器日志:

    {
      "_id": 0,
      "meta": {
        "headers": {
          "CONTENT_LENGTH": 3,
          "CONTENT_TYPE": "application/json",
          "HOST": "cloud.minapp.com",
          "X_HYDROGEN_CUSTOMIZE_HEADER": "hello"
        },
        "remote_address": "1.1.1.1",
        "request_method": "POST",
      },
      "payload": {
        "hello": "incoming-webhook"
      }
    }

使用场景:当用户访问特定的 URL 时,执行指定的云函数。

注:IncomingWebhook 下的动作不支持模板变量

动作

邮件

执行结果:向指定邮件地址发送一封邮件。

注:收件人和邮件标题也可以输入模板变量

微信模板消息

执行结果:向指定用户发送一条微信模板消息。

使用前要在微信小程序后台添加消息模板。当在微信小程序后台增加、删除模板后,请在微信模板消息动作编辑卡片点击更新模板按钮,用以更新知晓云保存的模板缓存。

微信模板消息需要配合小程序来触发,无法单独在后台触发。具体触发方法为:在小程序页面中添加 form 组件,在提交表单的回调中取得 formId,调用 BaaS.wxReportTicket 保存 formId,保存成功后,当触发器被触发后,这时用户就可以在手机收到通知。 注意这里 form 组件需要添加 report-submit 属性,否则在回调事件对象中无法获取 formId。

formId 使用限制说明:

  • 发送前必须已有真机提交 formId (开发者工具无效)或已支付成功
  • formId 仅供其提交者使用,即你无法使用 A 提交的 formId 给 B 发送模板消息
  • formId 自提交日 7 天内有效
  • 表单提交场景的 formId 可使用发送 1 次,支付场景的 formId 可使用发送 3 次
  • 跳转路径请按照“pages/...“格式填写,“/pages/....“可能会导致发送错误

WebHook

执行结果:向指定 URL 发送一个 POST 请求。

执行动作时,服务器发送请求参数如下:

请求 Headers

请求头部 说明
X-Hydrogen-Webhook-Action-Id 本次触发器触发动作的 uuid,webhook 重试时此 id 保持不变
X-Hydrogen-Trigger-Event on_create, on_update, on_delete

请求 Body

请求 Body 为一个 JSON Web Tokens 的文本,需要开发者自己去验证并解码,可以在这里在线调试 jwt

示例:

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiMTIzIn0.FGhYH5IF-PkNV8b4SNh-1WKwV8h-Gj8JYVlXmUdCGs8

若触发类型为数据表,则请求 Body 解码后为数据行内容,示例如下:

{
  _read_perm: [ 'user:*' ],
  name: '1',
  created_at: 1517970094,
  updated_at: 1517970094,
  created_by: 35674431,
  _write_perm: [ 'user:35674431' ],
  id: '5a7a62aefff1d610ab2ddb10'
}

数据行内容根据 event 类型有所差别,具体差异如下

event 类型 请求 Body
on_create 创建后的数据行信息
on_update 更新后的数据行信息
on_delete 被删除的数据行的原信息

若触发类型为微信支付回调,则请求 Body 解码后为微信支付结果。示例如下:

{ trade_no: '5a7a695008443e1a69e1a06a',
  transaction_no: '5a7a695008443e1a69e1a06a',
  merchandise_description: 'test',
  merchandise_snapshot: {},
  merchandise_schema_id: 1,
  merchandise_record_id: '5a7a695008443e1a69e1a06a',
  status: 'success',
  refund_status: null,
  ip_address: '127.0.0.1',
  created_by_id: 123,
  paid_at: 1517970094 }

注:webhook 不支持模板变量

数据表操作

执行结果:批量修改指定的数据表的数据行。 数据表操作动作的一些参数说明如下:

操作 被触发时动作说明
创建 创建一行数据
更新 修改符合条件的数据行
删除 删除符合条件的数据行

当操作为更新或者删除时,需要配置查询条件,筛选出指定的数据行。数据表查询条件相关文档请参考这里

注:此处的查询条件中也可以输入模板变量

若使用类型为 object 的模板变量来进行赋值,则被赋值的字段必须为 string 类型。例如:在动作中将 赋值给 _userprofile 表的 gender 字段是错误的,只能赋值给 nickname 等 string 类型的字段

目前赋值操作支持的数据类型及其对应的操作符如下:

数据类型 操作符
array =, append, append_unique, remove
boolean =
date =
integer =, inc_by
number =, inc_by
string =
geojson =

注:append, append_unique, remove, inc_by 为原子操作符,相关文档请参考这里

云函数

执行结果:执行对应的云函数

不同的触发类型下的云函数动作被触发时,云函数接收到的参数也会有所不同 event.data 参数内容:

  • 若触发类型为定时任务:空
  • 若触发类型为数据表:数据表记录,参考数据表操作小节
  • 若触发类型为微信支付回调:为订单记录,参考微信支付回调小节

定时任务

创建一个触发类型为定时任务的触发器后,该触发器将被周期性的触发。

目前默认提供的触发周期如下:

周期 cron 表达式 说明
每年 0 0 1 1 * 每年的 1 月 1 号 00:00
每月 0 0 1 * * 每个月的 1 号 00:00
每周 0 0 * * 0 每周日的 00:00
每天 0 0 * * * 每天的 00:00
每小时 0 * * * * 每天整点时间,如 18:00、19:00 ...

​Cron 表达式简介

注:触发周期最小时间粒度为 1 分钟

模板变量的使用

部分动作中支持插入变量,您可以点击动作底部的"可选变量"查看该动作中支持添加的所有变量。

如需插入变量,请按照{{变量名}}的形式插入到邮件文本中

例:您购买的产品{{product}}已经发货,请注意查收。

如需插入微信用户信息,请输入{{created_by.***}}

例:尊敬的{{created_by.nickname}},您购买的产品{{product}}已经发货,请注意查收。

对于 date 类型的变量,可以自定义输出的格式,格式为 {{created_at | date:"format"}},其中 format 为输出的格式,例如需要 2017-09-20 16:05:14 这样的输出格式,变量的格式为 {{created_at | date:"Y-m-d H:i:s"}},具体 format 的意义可参考「date 格式参数说明

对于 object 类型,可以输入 {{<OBJECT_FIELD>.<PROP_NAME>[.<PROP_NAME>]}} 格式,例如 {{obj.name}}{{obj.foo.bar}}

实战教程

触发器实战教程请移步这里

results matching ""

    powered by

    No results matching ""