跳转到主要内容
本页面是示例应用:完整的 OneSignal 集成的一部分,该指南从头到尾跟随一个真实应用。这个应用是 Clean Beans,一款面向合租家庭的打扫值日表应用,使用 Expo(React Native)和 Supabase 后端构建。 被划掉的推送就消失了。Clean Beans 在应用内保留七天的历史记录,并在每个界面的标题栏中显示未读数量。
Clean Beans 通知收件箱

收件箱列出最近的通知。

应用本身不记录通知。那样会漏掉应用关闭期间送达的所有内容。OneSignal 通过 Event Stream 将每条推送告知后端,由后端保存历史记录。
1

OneSignal 为每条推送发送一个事件

Event Stream 会在推送发送时以及被点击时,向后端函数发送 POST 请求。
2

函数存储或更新一行记录

发送事件会创建一条收件箱记录。点击事件会将其标记为已读。
3

应用读取数据表

收件箱界面和标题栏角标会查询用户自己的记录。

配置 Event Stream \

仪表板设置。 在 Data > Event Streams 中创建一个 stream,并设置:
  • URL: 您的函数地址。
  • 请求头: 一个共享密钥,例如 X-Webhook-Secret。
  • 事件: message.push.sent 和 message.push.clicked。
  • 正文: 用于构造请求的 Liquid 模板。
Event Stream body
请像上面这样按名称引用每个 data 键。单独使用 {{ message.data }} 会把整个对象渲染为 Python 风格的 dict({'type': 'kudos'}),这不是有效的 JSON,下面的函数在解析正文时会拒绝该请求。标题和内容使用 .en 读取也是同样的原因。收件箱只需要 type。如果您自己的 Webhook 还使用其他键,请逐行添加。包含双引号的值同样会破坏 JSON。Kudos 推送包含用户输入的文本,因此带有 " 的 kudos 消息会生成函数无法解析的正文,该推送也就不会进入收件箱。
此 stream 会为投递到每台设备的每条推送发送一个事件,每个事件都会计入您套餐的消息事件量。请只选择您需要的事件。

接收事件 \

函数在执行任何其他操作之前先检查密钥。
supabase/functions/inbox-webhook/index.ts
发送事件会成为收件箱中的一行。OneSignal 的事件 ID 是唯一键,因此同一事件即使送达两次也不会创建两行。
supabase/functions/inbox-webhook/index.ts
点击事件会将对应的行标记为已读。
supabase/functions/inbox-webhook/index.ts
用于路由被点击推送的 data.type 字段也会随每一行存储,因此收件箱可以显示正确的图标并打开正确的界面。

存储前先渲染 Liquid \

stream 报告的是消息的原始写法,即 OneSignal 为每位收件人个性化之前的内容。由后端发送的推送已经是最终文本,Journey 推送则不是。Clean Beans 的一条 Journey 消息使用以下标题:
Journey push
手机上显示的是“Kitchen cleaned ✅”。Webhook 收到的却是上面那一行,收件箱的第一个版本就原样显示了它。 现在,函数会在保存之前自行渲染标题和正文,使用一个支持取值和 default 过滤器的小型渲染器。它从两个地方获取值:
  • 标签从数据库中读取。应用根据其存储的值设置每个标签,因此函数读取的是相同的值。在 stream 正文中传入 {{ user.tags.user_name }} 也可行,但如果名字中包含双引号,正文就会变成无效的 JSON。
  • Journey 事件属性在 stream 中不可用。函数会根据触发该自定义事件的打扫会话重新构建它们。
supabase/functions/inbox-webhook/index.ts
如果您基于 Event Streams 构建收件箱或日志,请检查 Journey 和模板消息到达时的样子。其中的 Liquid 仍然是 Liquid。要么像这里一样自行渲染,要么排除这些消息。

显示收件箱 \

行级安全机制确保每位用户只能读取自己的行,因此应用的查询无需按用户筛选。
app/inbox.tsx
src/components/InboxButton.tsx

让邮件偏好保持一致 \

同一个 stream 还能解决第二个问题。当有人点击邮件中的 Unsubscribe 时,OneSignal 会停止向其发送邮件,但应用自己的“Weekly Email Summary”开关仍处于开启状态。设置界面会显示错误的状态,后端也会继续尝试发送。 在 stream 中添加四个邮件事件即可解决这个问题。函数以相同方式处理所有这些事件:OneSignal 不会再给此人发送邮件,因此应用偏好也会相应关闭。
supabase/functions/inbox-webhook/index.ts
无需更改 stream 的正文,因为收件箱已经使用的字段(event_kind、event_id、external_id)就足够了。
这会让应用与 OneSignal 保持一致,而不是反过来。如果有人在应用中重新开启邮件,其 OneSignal 订阅仍处于退订状态。要重新订阅,需要由您的后端调用 OneSignal 的订阅 API。
同样的 Event Stream 模式可以让您自己的系统与 OneSignal 掌握的任何信息保持同步:邮件打开、应用内消息点击、短信送达等。

Event Streams

设置 stream 并选择事件。

Event Stream 数据

正文模板中可用的所有字段。