更新指定webhook

1.描述:更新用户指定webhook

2.接口地址:

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

请求头：采用HMAC认证

请求体：

{
    "webhookName": "新的webhook名称",
    "webhookUrl": "http://example.com/newcallbackaddress",
    "events": [
        "envelopeStart",
        "envelopeReject",
        "recipientReject"
    ],
    "status": 1,
    "notifyUrl": {
        "returnUrl": "www.example.com"
    }
}

3.请求方式

PUT

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==" \
-d "{
\"webhookName\": \"新的webhook名称\",
\"webhookUrl\": \"http://example.com/newcallbackaddress\",
\"events\": [
\"envelopeStart\",
\"envelopeReject\",
\"recipientReject\"
],
\"status\": 1,
\"notifyUrl\": {
\"returnUrl\": \"www.example.com\"
}
}" "http://api.signit.cn/ws-rest/v1/users/1834/webhooks/18"

b.请求字段说明

字段	必填	类型	位置	长度
user-id	是	long	url-path	用户id
webhook-id	是	long	url-path	需要更新的webhookid
webhookName	是	String	请求体	webhook名称
webhookUrl	是	String	请求体	webhook推送地址
event	是	array	请求体	webhook定义的事件，详见webhook事件
status	是	int	请求体	是否启动webhook链接(0:不启动，1：启动)
notifyUrl	否	object	请求体	通知地址
returnUrl	否	String	请求体	未实名认证时回调地址

5.响应参数说明

a.响应示例

响应成功：

{
  "resultStatusCode": "100700000",
  "resultCode": 0,
  "resultDesc": "ok"
}

响应失败：

{
  "resultStatusCode": "100700102",
  "resultCode": 1,
  "resultDesc": "webhook事件异常"
}

b.响应字段说明

字段	是否必填	类型	位置	说明
resultStatusCode	是	String	BODY	状态码
resultCode	是	int	BODY	结果码
resultDesc	是	String	BODY	状态描述

修改webhook

更新指定webhook

results matching ""

No results matching ""