创建webhook

1.描述:创建新的webhook

2.接口地址:

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

请求头：采用HMAC认证

请求体：

{
    "webhookName": "webhook名称",
    "webhookUrl": "http://callback.url",
    "events": [
        "envelopeStart",
        "envelopeCompleted",
        "envelopeReject",
        "envelopeRevoke",
        "envelopeNotify",
        "recipientConfirm",
        "recipientReject"
    ],
    "status": 1,
    "notifyUrl": {
        "returnUrl": "www.register.com"
    }
}

3.请求方式

POST

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://callback.url\",
\"events\": [
\"envelopeStart\",
\"envelopeCompleted\",
\"envelopeReject\",
\"envelopeRevoke\",
\"envelopeNotify\",
\"recipientConfirm\",
\"recipientReject\"
],
\"status\": 1,
\"notifyUrl\": {
\"returnUrl\": \"www.register.com\"
}
}" "http://api.signit.cn/ws-rest/v1/users/1834/webhooks"

b.请求字段说明

5.响应参数说明

a.响应示例

• 响应成功：

  {
    "resultStatusCode": "100700000",
    "resultCode": 0,
    "resultDesc": "webhook操作成功",
    "resultData": {
        "userId": 1834,
        "createDatetime": 1494381168914,
        "updateDatetime": 1494381168984,
        "status": 1,
        "notifyUrl": {
            "returnUrl": "www.register.com"
        },
        "webhookId": 13,
        "webhookName": "webhook名称",
        "webhookUrl": "http://callback.url"
    }
  }
  

• 响应失败：

  {
    "resultStatusCode": "100600108",
    "resultCode": 1,
    "resultDesc": "参数错误"
  }
  

b.响应字段说明