网络钩子（Webhook）让您的应用程序无需主动轮询即可获知新的电子邮件或日历变更。与其不断询问“是否有新内容？”，不如注册一个统一资源定位符（URL），奈拉斯（Nylas）会在事件发生时将事件推送到该地址。但是，正确设置网络钩子不仅仅是发布一个 URL：您的端点在激活网络钩子之前必须响应一个挑战，您只会收到一次签名密钥，并且您应该验证每次交付的签名，以免处理伪造的事件。如果这三步出错，网络钩子将永远无法启动，或者您的处理程序会信任伪造的数据。本文将介绍如何使用应用程序编程接口（API）和命令行界面（CLI）正确设置网络钩子。
这是一个实际用例演练，而非单纯的端点浏览，从两个角度涵盖网络钩子：后端调用的超文本传输协议（HTTP）应用程序编程接口（API），以及用于创建、测试和接收网络钩子的nylas 命令行界面（CLI）。我负责命令行界面的开发工作，因此下面的命令是我在配置通知时常用的命令。
创建网络钩子
您通过POST /v3/webhooks请求注册网络钩子，两个必填字段是webhook_url（奈拉斯发送通知的地址）和trigger_types（您希望接收的事件数组）。可选的description用于标记，而notification_email_addresses用于接收有关网络钩子健康状况的警报，例如当它出现故障时。
curl --request POST \
--url "https://api.us.nylas.com/v3/webhooks" \
--header "Authorization: Bearer <NYLAS_API_KEY>" \
--header "Content-Type: application/json" \
--data '{
"webhook_url": "https://yourapp.com/webhooks/nylas",
"trigger_types": ["message.created", "event.created"],
"description": "Production message and event hook"
}'
网络钩子管理需要您的应用程序编程接口（API）密钥，而不是授权令牌，因为网络钩子归属于应用程序，而非某个连接的账户。trigger_types数组让您精确选择要接收的事件，从message.created到event.updated再到grant.expired，因此单个网络钩子可以承载多种事件类型，或者您可以按关注点将它们拆分到不同的网络钩子中。仅选择您将采取行动的触发器，因为每个订阅的事件都会向您的端点发起请求。
从命令行界面创建和探索
命令行界面使用nylas webhook create创建相同的网络钩子，接受--url和--triggers作为必填输入，以及--description和--notify作为可选字段。在创建之前，nylas webhook triggers会列出所有可用的触发器类型，从而避免猜测确切的事件名称。
# 查看可用的触发器，然后创建网络钩子
nylas webhook triggers
nylas webhook create --url https://yourapp.com/webhooks/nylas \
--triggers message.created,event.created \
--notify ops@example.com
网络钩
免责声明：本文内容来自互联网，该文观点不代表本站观点。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容，请到页面底部单击反馈，一经查实，本站将立刻删除。
