Webhook 集成
Webhook 集成功能说明: 该功能是用于指定 Web Scraper API 抓取任务发生特定事件时发送通知。让您可以动态将数据添加到通知负载中。
集成功能名称: 用于定义集成任务的名称,为了方便您的管理,建议您自定义名称。
事件类型: 创建成功 - 成功创建新的抓取任务 创建失败 - 创建抓取任务时失败 运行中 - 抓取任务正常抓取中 任务成功 - 抓取任务的抓取成功返回数据 任务失败 - 抓取任务未返回内容
发送通知:
您可以使用 HTTP 请求操作发送通知,该操作会向指定的 URL 发送包含 JSON 有效负载的 HTTP POST 请求。有效负载使用有效负载模板定义,该模板是一种类似 JSON 的语法,允许您使用包含双花括号括起来的变量{{variable}}
。这使得在触发 Webhook 时能够将数据动态注入到有效负载中。
1.有效载荷: 有效负载模板是一个类似 JSON 格式的字符串,它允许您自定义有效负载结构,并注入仅在 Webhook 调用时已知的动态数据。除了变量之外,该字符串也必须是有效的 JSON 格式。 变量必须用双花括号括起来,并且只能使用“可用变量”部分列出的预定义变量。使用任何其他变量都将导致验证错误。
变量的语法是:{{oneOfAvailableVariables}}
。变量支持使用点符号访问嵌套属性:{{variable.property}}
。
①默认有效载荷:
②可用变量: userId:string,拥有该 webhook 的Thordata用户 ID。 createdAt:string,Webhook 触发事件的时间的 ISO 字符串格式。 eventType:string,触发事件的类型。 eventData:Object,与触发事件相关联的数据。 resource:Object,事件的资源。 globals:Object,全局上下文中可用的数据。包含 dateISO (Webhook 触发事件的日期,ISO 8601 格式)和 dateUnix (触发事件的日期,Unix 时间戳,秒)
可自定义变量,例如:"text": "My user id is {{userId}}"
③示例:
2.标题模板: headers 模板是一个类似 JSON 的字符串,您可以在其中向 webhook 请求的默认 header 添加附加信息。您可以像在有效负载模板中一样传递变量(包括使用字符串插值和可用变量)。生成的 headers 必须是有效的json对象,并且值只能是字符串。 请注意,以下键是硬编码的,并且将始终被重写:
可用变量:
Host:请求 URL
Content-Type:application/json
Webhook: Tasks 值
Webhook-Dispatch-Id: Tasks id
Request-Origin
如果您需要更多帮助,请通过邮箱support@thordata.com联系我们。
Last updated
Was this helpful?