创建问卷事件 Webhook
#
接口概述- 功能:向指定URL实时推送问卷的创建、编辑、删除事件,详见 问卷事件推送,针对某个用户ID进行监听,当该用户的问卷被创建、编辑、删除时进行推送。
- 请求方式: POST
- 请求地址:/api/users/{user_id}/webhooks?appid={appid}&access_token={access_token}
#
请求参数参数名 | 类型 | 必须 | 参数位置 | 描述 | 示例值 |
---|---|---|---|---|---|
user_id | integer | 是 | uri | 用户 ID 或者 团队 ID | 60000000001,用户 ID 从个人中心页面获得,团队 ID 从团队管理页面获得 |
url | string | 是 | body | 进行数据推送的Url,注意该地址需要能接收 POST 请求 | https://wj.qq.com |
is_active | bool | 是 | body | 是否启用(true:启用 false:关闭) | true |
#
响应参数参数名 | 类型 | 描述 |
---|---|---|
id | integer | 自增ID |
url | string | url |
is_active | bool | 是否启用 |
created_at | datetime | 创建时间 |
updated_at | datetime | 修改时间 |
#
响应示例- 请求成功
{ "code": "OK", "error": { "type": "" }, "data": { "id": 42, "user_id": 1411902221, "object": "User_60000000001", "url": "https://wj.qq.com/", "secret": "", "is_active": true, "options": "{\"listenedResources\":[\"survey\"]}", "created_at": "2022-06-21 16:02:33", "updated_at": "2022-06-21 16:02:33" }, "request_id": "e4b27037-d876-427d-95c7-d5a737dd1677"}
- 请求失败
{ "code": "InvalidArgument", "error": { "type": "invalid_argument_url", }, "data": {}, "request_id": "ddec96d2-165e-4f3e-8a64-2057db116983"}
#
错误码error.type 错误代码 | 错误描述 |
---|---|
permission_denied | 无创建权限 |
invalid_argument_url | url不合法 |
invalid_argument | 参数校验不通过 |
resource_exhausted | 创建数量超过限制 |
create_error | 创建webhook失败 |