文档 API参考

入站人

ZIS入站webhook摄取包含事件数据的HTTP请求。ZIS集成中的作业规范可以使用事件触发ZIS流。

webhook的作用域为ZIS集成及其相关帐户。

邮差跑进来

如果你使用Postman，你可以将ZIS Inbound Webhooks API端点作为一个集合导入到你的Postman应用程序中，然后尝试不同的请求来了解API是如何工作的。点击以下按钮开始:

邮差跑进来”></a></p> <p data-garden-id=如果你不使用邮差，你可以注册一个免费帐户邮递员的网站并下载应用程序。有关使用Postman与Zendesk api的更多信息，请参阅亚博探索Zendesk 亚博api与邮差．

JSON格式

入站webhook被表示为具有以下属性的JSON对象:

名字 类型 只读 强制性的 描述
event_type 字符串 假 真正的 将触发webhook的事件类型的描述符，它将被ZIS作业规范用于识别传入事件，并与source_system
id 字符串 真正的 真正的 webhook的唯一标识符
集成 字符串 真正的 真正的 webhook所属的集成的名称
密码 字符串 真正的 真正的 与用户名一起使用的凭据，用于向创建的webhook路径URL发出请求
路径 字符串 真正的 真正的 创建的webhook的URL，用于接收HTTP请求。包含唯一标识此网络钩子的令牌。
source_system 字符串 假 真正的 将触发webhook的系统描述符。这可以被ZIS作业规范用于识别传入事件，并与event_type
用户名 字符串 真正的 真正的 凭据与密码一起使用，用于向创建的webhook路径URL发出请求
uuid 字符串 真正的 真正的 webhook的唯一标识符(已弃用)
亚博zendesk_account_id 整数 真正的 真正的 Zend亚博esk帐户id

摄取传入的Webhook请求

  • POST / api /服务/子/ inbound_webhooks /一般/吸收/{牌}

方法返回该端点路径a的性质创建入站Webhook响应。将传入的webhook请求作为事件摄取。摄取的事件可以触发ZIS流。建议最大请求有效负载大小为200KB。

方法使用基本身份验证来对请求进行授权用户名和密码从创建入站Webhook端点的响应。

参数

名字 类型 在 要求 描述
令牌 字符串 路径 真正的 标识网络钩子的唯一令牌

例子的身体

             

              
{“身体”：“烟的颜色很鲜艳。”，“主题”：“我的打印机着火了!”}

代码示例

旋度 
              

               
旋度https://{子域名}.亚博zendesk.com/api/services/zis/inbound_webhooks/generic/ingest/{令牌}＼- u{用户名}：{密码}＼- x的帖子＼- h“application / json内容类型:＼- d“主题”:“我的打印机着火了!”，“身体”:“烟雾很鲜艳。”} '
去 
              

               
进口（“fmt”“输入输出”“net/http”“弦”）函数主要（）{url：=“https://support.亚博zendesk.com/api/services/zis/inbound_webhooks/generic/ingest/OPwn17vlTjI_c8_IfmRBAcAyx_X4Hx2r5Iy95Pje64-s”方法：=“职位”有效载荷：=字符串．NewReader（”{“身体”:“烟很鲜艳。”“主题”:“我的打印机着火了!”} '）要求的事情，犯错：=http．NewRequest（方法，url，有效载荷）如果犯错! =零{fmt．Println（犯错）返回}要求的事情．头．添加（“内容类型”，“application / json”）要求的事情．头．添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端：=&http．客户端{}res，犯错：=客户端．做（要求的事情）如果犯错! =零{fmt．Println（犯错）返回}推迟res．身体．关闭（）身体，犯错：=io．ReadAll（res．身体）如果犯错! =零{fmt．Println（犯错）返回}fmt．Println（字符串（身体））}
Java 
              

               
进口com．squareup．okhttp．*；OkHttpClient客户端=新OkHttpClient（）；HttpUrl．构建器urlBuilder=HttpUrl．解析（“https://support.亚博zendesk.com/api/services/zis/inbound_webhooks/generic/ingest/OPwn17vlTjI_c8_IfmRBAcAyx_X4Hx2r5Iy95Pje64-s”）．newBuilder（）；RequestBody身体=RequestBody．创建（MediaType．解析（“application / json”），”“”{\“\”：\”的烟是非常丰富多彩．\”，\“主题\”：\”我的打印机是着火了！\”}”“”）；请求请求=新请求．构建器（）．url（urlBuilder．构建（））．方法（“职位”，身体）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应=客户端．newCall（请求）．执行（）；
Nodejs 
              

               
varaxios=需要（“axios”）；var数据=JSON．stringify（{“身体”：“烟的颜色很鲜艳。”，“主题”：“我的打印机着火了!”}）；var配置={方法：“职位”，url：“https://support.亚博zendesk.com/api/services/zis/inbound_webhooks/generic/ingest/OPwn17vlTjI_c8_IfmRBAcAyx_X4Hx2r5Iy95Pje64-s”，头：{“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，数据：数据，}；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；}）．抓（函数（错误）{控制台．日志（错误）；}）；
Python 
              

               
进口请求进口jsonurl=“https://support.亚博zendesk.com/api/services/zis/inbound_webhooks/generic/ingest/OPwn17vlTjI_c8_IfmRBAcAyx_X4Hx2r5Iy95Pje64-s”有效载荷=json．加载（”““{“身体”:“烟很鲜艳。”“主题”:“我的打印机着火了!”}”“”）头={“内容类型”：“application / json”，}响应=请求．请求（“职位”，url，身份验证=（“<用户名>”，' <密码> '），头=头，json=有效载荷）打印（响应．文本）
鲁比（人名） 
              

               
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/services/zis/inbound_webhooks/generic/ingest/OPwn17vlTjI_c8_IfmRBAcAyx_X4Hx2r5Iy95Pje64-s”）请求=网：：HTTP：：帖子．新（uri，“内容类型”：“application / json”）请求．身体=％问（{“身体”：“烟的颜色很鲜艳。”，“主题”：“我的打印机着火了!”}）请求．basic_auth“用户名”，“密码”响应=网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了 
              

               
//状态200 OK零
401年未经授权 
              

               
//状态401未授权“验证失败”

创建入站Webhook

  • POST / api /服务/子/ inbound_webhooks /一般/{集成}

创建一个入站webhook，用于接收HTTP请求。

参数

名字 类型 在 要求 描述
集成 字符串 路径 真正的 webhook所属的集成的名称

例子的身体

             

              
{“event_type”：”票。NewReply”，“source_system”：“松弛”}

代码示例

旋度 
              

               
旋度https://{子域名}.亚博zendesk.com/api/services/zis/inbound_webhooks/generic/{集成}＼- h"授权:Bearer {access_token}"＼- x的帖子＼- h“application / json内容类型:＼- d”{source_system”:“萧条”,“event_type”:“票。NewReply "}
去 
              

               
进口（“fmt”“输入输出”“net/http”“弦”）函数主要（）{url：=“https://support.亚博zendesk.com/api/services/zis/inbound_webhooks/generic/my_integration”方法：=“职位”有效载荷：=字符串．NewReader（”{:“event_type票。NewReply”,“source_system”:“松弛”} '）要求的事情，犯错：=http．NewRequest（方法，url，有效载荷）如果犯错! =零{fmt．Println（犯错）返回}要求的事情．头．添加（“内容类型”，“application / json”）要求的事情．头．添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端：=&http．客户端{}res，犯错：=客户端．做（要求的事情）如果犯错! =零{fmt．Println（犯错）返回}推迟res．身体．关闭（）身体，犯错：=io．ReadAll（res．身体）如果犯错! =零{fmt．Println（犯错）返回}fmt．Println（字符串（身体））}
Java 
              

               
进口com．squareup．okhttp．*；OkHttpClient客户端=新OkHttpClient（）；HttpUrl．构建器urlBuilder=HttpUrl．解析（“https://support.亚博zendesk.com/api/services/zis/inbound_webhooks/generic/my_integration”）．newBuilder（）；RequestBody身体=RequestBody．创建（MediaType．解析（“application / json”），”“”{event_type \“\”：\“票．NewReply\”，source_system \“\”：\“松弛\”}”“”）；请求请求=新请求．构建器（）．url（urlBuilder．构建（））．方法（“职位”，身体）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应=客户端．newCall（请求）．执行（）；
Nodejs 
              

               
varaxios=需要（“axios”）；var数据=JSON．stringify（{“event_type”：”票。NewReply”，“source_system”：“松弛”}）；var配置={方法：“职位”，url：“https://support.亚博zendesk.com/api/services/zis/inbound_webhooks/generic/my_integration”，头：{“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，数据：数据，}；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；}）．抓（函数（错误）{控制台．日志（错误）；}）；
Python 
              

               
进口请求进口jsonurl=“https://support.亚博zendesk.com/api/services/zis/inbound_webhooks/generic/my_integration”有效载荷=json．加载（”““{:“event_type票。NewReply”,“source_system”:“松弛”}”“”）头={“内容类型”：“application / json”，}响应=请求．请求（“职位”，url，身份验证=（“<用户名>”，' <密码> '），头=头，json=有效载荷）打印（响应．文本）
鲁比（人名） 
              

               
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/services/zis/inbound_webhooks/generic/my_integration”）请求=网：：HTTP：：帖子．新（uri，“内容类型”：“application / json”）请求．身体=％问（{“event_type”：”票。NewReply”，“source_system”：“松弛”}）请求．basic_auth“用户名”，“密码”响应=网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

201年创建 
              

               
//状态201创建{“event_type”：”票。NewReply”，“id”：“01 fdxqxbgqrz3xn28wkx559pr2”，“集成”：“integrationName”，“密码”：“$ 2 $ 10美元vP2yN5pXK.8hbIwJGcXYAefQ3SXOT / xxjERPX4bhMjMsKIUG3LjVi”，“路径”：“/ api /服务/子/ inbound_webhooks /一般/摄取/ OPwn17vlTjI_c8_IfmRBAcAyx_X4Hx2r5Iy95Pje64-s”，“source_system”：“松弛”，“用户名”：“SkkCyESWf8ASuzKW”，“uuid”：“d339ba7f-4a42-40fc-ae75-0e93315d3d0f”，“亚博zendesk_account_id”：1}
401年未经授权 
              

               
//状态401未授权“验证失败”

按UUID显示入站Webhook

  • GET / api /服务/子/ inbound_webhooks /一般/{集成}/ {uuid}

按UUID返回webhook详细信息

参数

名字 类型 在 要求 描述
集成 字符串 路径 真正的 webhook所属的集成的名称
uuid 字符串 路径 真正的 网络钩子的标识符

代码示例

旋度 
              

               
旋度https://{子域名}.亚博zendesk.com/api/services/zis/inbound_webhooks/generic/{集成}/{uuid}＼- h"授权:Bearer {access_token}"
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）{url：=“https://support.亚博zendesk.com/api/services/zis/inbound_webhooks/generic/my_integration/d339ba7f-4a42-40fc-ae75-0e93315d3d0f”方法：=“获得”要求的事情，犯错：=http．NewRequest（方法，url，零）如果犯错! =零{fmt．Println（犯错）返回}要求的事情．头．添加（“内容类型”，“application / json”）要求的事情．头．添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端：=&http．客户端{}res，犯错：=客户端．做（要求的事情）如果犯错! =零{fmt．Println（犯错）返回}推迟res．身体．关闭（）身体，犯错：=io．ReadAll（res．身体）如果犯错! =零{fmt．Println（犯错）返回}fmt．Println（字符串（身体））}
Java 
              

               
进口com．squareup．okhttp．*；OkHttpClient客户端=新OkHttpClient（）；HttpUrl．构建器urlBuilder=HttpUrl．解析（“https://support.亚博zendesk.com/api/services/zis/inbound_webhooks/generic/my_integration/d339ba7f-4a42-40fc-ae75-0e93315d3d0f”）．newBuilder（）；请求请求=新请求．构建器（）．url（urlBuilder．构建（））．方法（“获得”，零）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应=客户端．newCall（请求）．执行（）；
Nodejs 
              

               
varaxios=需要（“axios”）；var配置={方法：“得到”，url：“https://support.亚博zendesk.com/api/services/zis/inbound_webhooks/generic/my_integration/d339ba7f-4a42-40fc-ae75-0e93315d3d0f”，头：{“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；}）．抓（函数（错误）{控制台．日志（错误）；}）；
Python 
              

               
进口请求url=“https://support.亚博zendesk.com/api/services/zis/inbound_webhooks/generic/my_integration/d339ba7f-4a42-40fc-ae75-0e93315d3d0f”头={“内容类型”：“application / json”，}响应=请求．请求（“获得”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应．文本）
鲁比（人名） 
              

               
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/services/zis/inbound_webhooks/generic/my_integration/d339ba7f-4a42-40fc-ae75-0e93315d3d0f”）请求=网：：HTTP：：得到．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应=网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了 
              

               
//状态200 OK{“event_type”：”票。NewReply”，“id”：“01 fdxqxbgqrz3xn28wkx559pr2”，“集成”：“integrationName”，“密码”：“$ 2 $ 10美元vP2yN5pXK.8hbIwJGcXYAefQ3SXOT / xxjERPX4bhMjMsKIUG3LjVi”，“路径”：“/ api /服务/子/ inbound_webhooks /一般/摄取/ OPwn17vlTjI_c8_IfmRBAcAyx_X4Hx2r5Iy95Pje64-s”，“source_system”：“松弛”，“用户名”：“SkkCyESWf8ASuzKW”，“uuid”：“d339ba7f-4a42-40fc-ae75-0e93315d3d0f”，“亚博zendesk_account_id”：1}
404未找到 
              

               
//状态404未找到{“错误”：［{“代码”：“1110”，“细节”：“没有找到”，“状态”：“404”}］}