查看指定webhook

1.描述:查看用户指定webhook

2.接口地址:

请求路径：/ws-rest/v1/users/{user-id}/webhooks/{webhook-id}?fields=null

请求头：采用HMAC认证

请求体：
{
}

3.请求方式

GET

4.请求参数说明

a.请求示例

curl -X POST \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Date: Wed, 02 Nov 2016 03:25:54 GMT" \
--header "User-Agent: SignIt RestAPI Client v1.0.0" \
--header "Host: api.signit.cn" \
--header "Authorization:HmacSHA512 a1S0H2-U0-v5I-0586-017-z6D-7B5-K0h-1o0-G0-9923G3Xm:53f7ae4a-937b-4ddc-8872-42dd094d56eb:NCMwvHfZS9ZzB2SgVbRzTuS/N5yDRM8Ak6tRvCavHD5T9nKjydc9ha+Rj48e0YIFC5V9IRtFL8Z1d0hvse7Ulg==" 
}" "http://api.signit.cn/ws-rest/v1/users/1834/webhooks/7"

b.请求字段说明

字段	是否必填	类型	位置	说明
user-id	是	long	URL-PATH	用户id
fields	否	String	URL-PATH	字段选择(webhookId,createDatetime,updateDatetime,status,webhookName,webhookUrl,event，metadata),默认(webhookId,createDatetime,updateDatetime,status,webhookName,webhookUrl)
filters	否	String	URL-PATH	过滤条件(webhookId,createDatetime,updateDatetime,status)组合，eg：filters=active=false
offset	否	int	URL-PATH	分页索引偏移量，默认为0
limit	否	int	URL-PATH	分页索引个数，默认为20
sortings	否	String	URL-PATH	排序(webhookId,createDatetime,updateDatetime)

5.响应参数说明

a.响应示例

响应成功：

{
  "resultStatusCode": "100700000",
  "resultCode": 0,
  "resultDesc": "webhook操作成功",
  "resultData": {
      "userId": 1834,
      "createDatetime": 1487325636000,
      "updateDatetime": 1487325637000,
      "status": 1,
      "events": [
          "envelopeStart",
          "envelopeCompleted",
          "envelopeReject",
          "envelopeRevoke",
          "envelopeTimeout",
          "envelopeNotify",
          "recipientConfirm",
          "recipientReject"
      ],
      "notifyUrl": {
          "returnUrl": "https://www.baidu.com"
      },
      "webhookId": 7,
      "webhookName": "赵刚",
      "webhookUrl": "http://env.dl.signit.cn/ws-rest/v1/users/123/webhooks"
  }
}

响应失败：

{
  "resultStatusCode": "100700104",
  "resultCode": 1,
  "resultDesc": "禁止操作当前webhook"
}

b.响应字段说明

字段	是否必填	类型	位置	说明
webhookId	是	long	BODY	webhookid
webhookName	是	String	BODY	webhook名
webhookUrl	是	String	BODY	webhook调用url地址
event	是	array	BODY	webhook定义的事件，详见webhook事件
notifyUrl	否	Object	BODY	回调数据封装
returnUrl	是	string	BODY	未实名认证重定向地址
status	是	int	BODY	是否启动webhook链接(0:不启动，1：启动)
createDatetime	是	long	BODY	webhook创建时间
updateDatetime	是	long	BODY	webhook更新时间
resultStatusCode	是	String	BODY	状态码
resultCode	是	int	BODY	结果码
resultDesc	是	String	BODY	状态描述

查看指定webhook

查看指定webhook

results matching ""

No results matching ""