配置人

在Integration Builder中,为特使分配一个端点URL,以便将数据发送到您的服务。

在Integration Builder中,当您指定插件端点URL(作为工作器或路由)时,Envoy将在适当的时间向这些URL发出POST请求。

本指南专门用于使用集成构建器配置webhook。使用webhook集成来设置webhook,请参见此指南

模型

每项要求都有以下特点:

  • HTTP方法总是POST
  • 总是会出现X-Envoy-Signature HTTP头。
  • 请求总是包含一个JSON主体。
  • JSON主体总是包含一个元对象。
  • 如果请求是发送给一个worker或一个“Validation URL”路由,JSON主体也将包含一个有效负载对象。

当Envoy向你插件的端点发出请求时,我们会在请求体中发送一些元数据。元对象可以在Envoy向你的插件发出的每个请求的正文中找到。它包含的数据通常对正确处理请求至关重要。

Webhook设置步骤(验证url)

为webhook注册设置步骤在集成构建器中。

的名字 类型 描述
路线 字符串 路由的名称
plugin_id 数量 插件ID
install_id 数量 插件安装ID
配置 对象 此安装的配置数据
参数个数 对象 在请求中发送的可选URL查询参数
位置 EnvoyObject 事件发生的位置(仅安装位置)
公司 EnvoyObject 安装插件的公司
身份验证 对象 包含安装程序的access_token

Webhook事件

为webhook注册事件在集成构建器中。

的名字 类型 描述
事件 字符串 事件的名称
plugin_id 数量 插件ID
install_id 数量 插件安装ID
配置 对象 此安装的配置数据
工作 EnvoyObject 工作分配给这个插件+事件
位置 EnvoyObject 事件发生的位置(仅安装位置)
公司 EnvoyObject 安装插件的公司
身份验证 对象 包含安装程序的access_token

共性

路由和工人都返回一些常见的对象,如位置公司都是典型的EnvoyObject,表示一个资源。

的名字 类型 描述
id 字符串|数量|uuid 对象的ID
属性 对象 对象的属性,用破折号表示。

有效载荷

当Envoy发送一个请求到你插件的端点或一个“Validation URL”路由时,该请求包含一个描述请求主题的有效载荷。有效负载对象可以在Envoy向你的插件worker发出的每个请求的正文中找到。它包含表示事件主题的数据。

例如,在“entry sign in”事件上,有效载荷将表示特使entry对象。它也可以在“Validation URL”路由中找到,其中负载表示要验证的数据:

  • 如果步长类型为形式,则数据具有表示表单中每个字段的键和值。键是在Integration Builder中定义的。
  • 如果步长类型为OAuth2,则数据就是从授权流返回的数据。通常,您会在这里找到经过认证的服务的访问令牌。
  • 如果步长类型为弹出,那么数据就是从弹出窗口转发的任何数据。

事件

查看我们的参考文档查找可用的事件和样本有效载荷。

签名验证

为了验证请求是否来自Envoy,我们还在X-Envoy-Signature报头中发送了一个签名。这个签名是一个base64编码的字符串,表示请求体的SHA-256 HMAC,使用你的插件客户端secret作为密钥。

然后,您可以通过构建您自己的签名来验证签名,该签名是用您的客户端秘密签名的请求体,并比较两个签名。Node.js SDK中间件会自动对每个请求进行验证,并阻止对请求元和事件有效负载的访问,除非请求被验证。


这个页面对你有帮助吗?
Baidu