如需查看源自架构的完整目录,请参阅所有示例。
功能说明
处理contact.created 和 contact.note.created 事件。
准备工作
- 在您的应用程序中创建一个公开的 HTTPS 端点。
- 针对所需事件类型配置 YCloud Webhook 端点。
- 安全存储端点签名密钥。
- 确保事件处理具备幂等性。
工作原理
事件发生时,YCloud 会发送 HTTPPOST 请求。验证签名,持久化记录事件,返回 2xx 响应,并异步处理耗时任务。
请求
以下场景展示了发送至您 Webhook URL 的请求。将事件id 视为投递标识符,并使用 type 来路由有效载荷。
响应
接收事件后返回2xx 状态。
有关端点设置、签名验证和重试机制,请参阅配置 Webhook。
联系人创建示例
请求
响应
在持久化接收事件后确认投递。说明
- 完整联系人信息:
contactCreated对象包含创建时所有可用的联系人信息。 - 自定义属性:
customAttributes字段包含与联系人关联的所有自定义数据。 - 标签:
tags数组包含创建期间分配给联系人的所有标签。
联系人备注已创建
在创建联系人备注时使用contact.note.created。
请求
响应
在持久化接收事件后确认投递。说明
使用contactNote.id 标识备注,使用 contactId 标识其所属联系人。username 和 phoneNumber 用于描述该联系人,可以为 null。有效载荷包含面向客户的备注快照(包括 content),不包含内部操作员标识符。
