大纲:
Webhook 是应用程序相互通信的一种方式。本质上,它们是在预定事件发生时从一个应用程序发送到另一个应用程序的通知:
- 当一个选定的事件发生时,一个应用程序触发webhook
- 然后另一个应用程序接收有关事件的实时信息
例如,当收件人回复了营销邮件时,会向指定的 URL 端点发送一个 webhook。然后,端点能够根据从 webhook 接收到的信息采取行动。 这为设置自动化集成创造了可能性。
使用 Snov.io Webhooks,您可以:
- 将您自己的应用程序与 Snov.io 集成
- 收到有关您 Snov.io账户中发生的事件或活动的通知
- 将实时数据从 Snov.io 发送到您的应用程序
目前 Snov.io 中有三个 webhook 可用(未来更新中还会有更多):
Snov.io 将在发送您的邮件营销时发送一个 webhook。您可以选择何时获取它:仅在第一封邮件发送给收件人时或在每封邮件发送后。
Snov.io 将在您收到对营销邮件的回复时发送一个 webhook。您可以选择何时获取它:仅在收件人第一次回复后或每次回复后。
当收件人查看您的自动化营销邮件时,Snov.io 将发送一个 webhook。
Webhook 信息将包括:
- 收件人的邮件
- 事件的时间轴:事件发生的时间
- 营销名称:事件发生的自动化邮件营销的名称
- 邮件标题:发送给收件人的邮件标题
- 邮件正文:发送给收件人的邮件内容
Webhook 参数
Webhook 参数包括以下内容:
- 对象:执行操作的对象。换句话说,这是一个链接到 webhook 的 Snov.io 组件(电子邮件、回复、潜在客户或交易)。
- 动作:对对象执行的动作。简单地说,这是激活 webhook 的事件。
- 端点:发送 webhook 的 URL 地址。
以下是当前可用对象和操作的列表:
对象 |
行为 |
什么时候触发? |
campaign_email |
sent |
当邮件发给自动化营销中的任何收件人的时候 |
first_sent | 当邮件首次被发送给任何自动化营销中的收件人的时候 | |
opened | 当收件人打开了自动化营销里的任何一封邮件的时候 | |
campaign_reply
|
received | 当收件人回复了任何自动化营销中的任何邮件的时候 |
first_received | 当收件人首次回复了任何营销中的任何邮件的时候 |
如何通过 Snov.io API 订阅 webhook
要实时查看 webhook,让我们使用 Postman 和任何在线端点生成器。
1) 准备 API 测试环境并获取 API 访问令牌
- 注册 Postman
- 获取 API 访问令牌
- 准备 API 调用并使用访问令牌对其进行身份验证
以下是有关验证 Snov.io API 调用和使用 Postman 进行 API 调用的详细指南。
2) 获取端点 URL 地址
例如,我们将使用 Beeceptor 生成一个免费的端点。在他们的网站上,输入任何端点名称,然后单击创建端点按钮。
您将获得一个端点 URL 地址,与 Snov.io 中的事件相关的 Webhook 和数据将被发送到该地址。 保存或复制此 URL 以在下一步中使用它。
3) 通过 API 调用订阅 webhook
使用以下设置在 Postman 或您选择的任何其他 API 测试环境中进行 API 调用:
- 类型:POST
- 请求网址:https://api.snov.io/v2/webhooks
- 输入参数(另请参阅上面的 Webhook 参数章节):
输入参数 |
||
event_object |
campaign_email |
campaign_reply |
event_action |
sentfirst_sent
opened |
received
first_received |
endpoint_url | https://snovio.free.beeceptor.com |
输入所有参数后,单击发送按钮。 您将看到以下响应:
状态:活跃表示您已成功订阅 webhook。
4) 在端点 URL 检查 webhook 通知
如果在 3 秒内返回 200 OK 成功状态响应码,我们认为端点成功接收到 webhook。
如果没有返还,那么我们会多次尝试重新发送 webhook:
第 1次:事件发生后立即发生
第 2 次:最后一次尝试后 20 分钟(活动后 20 分钟)
第 3 次:最后一次尝试后 40 分钟(活动后 1 小时)
第 4 次:最后一次尝试后 60 分钟(活动后 2 小时)
第 5 次:最后一次尝试后 4 小时(活动后 6 小时)
第 6 次:最后一次尝试后 8 小时(活动后 14 小时)
第 7 次:最后一次尝试后24小时(活动后38小时)
如果所有七次尝试均未成功,则 webhook 将被停用。
返回 Beeceptor 并找到一条包含 Snov.io webhook 数据的 POST 记录。 这是它的外观示例:
在您订阅 webhook 后,每当您的 Snov.io 帐户中发生所选事件时,与事件相关的数据将立即传递到 URL 端点。
如何通过 Snov.io API 管理 webhook
- 类型:GET
- 请求网址:https://api.snov.io/v2/webhooks
- 输入参数:此方法没有输入参数。
删除 webhook 订阅
删除一个选定的 webhook。
在请求的 URL 地址的末尾添加所选 webhook 的特定“id”值。
使用“查看 webhook 列表”的方法来获得您的 webhook 的 id 值。
- 类型:删除
- 请求网址:https://api.snov.io/v2/webhooks/webhook_id
- 输入参数:这个方法不需要输入参数。
- 请求网址示例:https://api.snov.io/v2/webhooks/8
更改 webhook 状态
改变一个选定的 webhook 订阅的状态。
在请求的 URL 地址的末尾添加所选 webhook 的特定“id”值。
使用“查看 webhook 列表”的方法来获得您的 webhook 的 id 值。
- 类型:PUT
- 请求网址:https://api.snov.io/v2/webhooks/webhook_id
- 输入参数:
状态 | 已启用或已停用 |
- 请求网址示例:https://api.snov.io/v2/webhooks/14
注意:您最多可以创建 50 个 Webhook。它们仅适用于高级帐户。
立即升级您的套餐,扩展您的 Snov.io 账户的功能,并订阅 webhook!