新建webhook

• 描述
• 使用须知
• 接口URL
• 请求参数
• 请求示例
• 响应参数
• 响应数据样例

描述

新建webhook

使用须知

开发前，请仔细阅读开发指南。

• POST请求头

{"Authorization": "Bearer YOUR_APIKEY"}

• YOUR_APIKEY请阅读开发指南了解。

接口URL

POST - /openapi/v1/webhook/create

请求参数

参数名	示例值	参数类型	是否必填	参数描述
type	2	Number	是	webhook类型, 1：通讯录 2：表单
appId	572177e6951f4dc54168c1eb	String	是	应用id，通讯录 webhook不用填
entryId	5ebc5c2deee7ea61f7ac25df	String	是	表单id，通讯录 webhook不用填
url	https://www.xxxxx.com/webhook	String	是	推送服务器地址
encrypt_key	-	String	否	加密Secret
event_info	[]	Array	是	推送事件类型, 通讯录webhook该值不用填 0：有新数据提交时推送；1：有数据被修改时推送；2：有数据被删除时推送；3：有数据被恢复时推送；4：表单结构有变化时推送；5：流程事件；6：有新增评论时推送；:7：有评论被修改时推送；

请求示例

{
    "type": 1,
    "appId": "572177e6951f4dc54168c1eb",
    "entryId": "5ebc5c2deee7ea61f7ac25df",
    "url": "https://www.xxxxx.com/webhook",
    "encrypt_key": "",
    "event_info": [
        0,
        1,
        2,
        3,
        7
    ]
}

响应参数

参数名	示例值	参数类型	参数描述
id	175	String
appId	572177e6951f4dc54168c1eb	String	应用id，通讯录webhook该值为空
entryId	5ebc5c2deee7ea61f7ac25df	String	表单id，通讯录webhook该值为空
event_info	[]	Array	推送事件类型, 通讯录webhook该值为空 0：有新数据提交时推送；1：有数据被修改时推送；2：有数据被删除时推送；3：有数据被恢复时推送；4：表单结构有变化时推送；5：流程事件；6：有新增评论时推送；:7：有评论被修改时推送；
status	1	Number	状态： 1：启用， 0：停用
url	https://www.xxxxx.com/webhook	String	推送服务器地址
encrypt_key	-	String	加密Secret

响应数据样例

{
    "id": "175",
    "appId": "572177e6951f4dc54168c1eb",
    "entryId": "5ebc5c2deee7ea61f7ac25df",
    "event_info": [
        0,
        1,
        2,
        3,
        7
    ],
    "status": 1,
    "url": "https://www.xxxxx.com/webhook",
    "encrypt_key": ""
}