Skip to main content
Version: latest

创建问卷事件 Webhook

接口概述#

  • 功能:向指定URL实时推送问卷的创建、编辑、删除事件,详见 问卷事件推送,针对某个用户ID进行监听,当该用户的问卷被创建、编辑、删除时进行推送。
  • 请求方式: POST
  • 请求地址:/api/users/{user_id}/webhooks?appid={appid}&access_token={access_token}

请求参数#

参数名类型必须参数位置描述示例值
user_idintegeruri用户 ID 或者 团队 ID60000000001,用户 ID 从个人中心页面获得,团队 ID 从团队管理页面获得
urlstringbody进行数据推送的Url,注意该地址需要能接收 POST 请求https://wj.qq.com
is_activeboolbody是否启用(true:启用 false:关闭)true

响应参数#

参数名类型描述
idinteger自增ID
urlstringurl
is_activebool是否启用
created_atdatetime创建时间
updated_atdatetime修改时间

响应示例#

  • 请求成功
{    "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_urlurl不合法
invalid_argument参数校验不通过
resource_exhausted创建数量超过限制
create_error创建webhook失败