跳到主要内容

修改 Webhook

重要提示

该功能为 尊享版 付费功能,如未升级,请先 升级 后再使用

接口概述

  • 功能:修改 webhook 数据
  • 请求方式: POST
  • 请求地址:/api/surveys/{survey_id}/webhooks/{webhook_id}?appid={appid}&access_token={access_token}

请求参数

参数名类型必须参数位置描述示例值
survey_idintegeruri问卷ID292190
webhook_idintegeruriwebhook ID42
urlstringbody进行数据推送的Url43
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": "Survey_292190",
"url": "https://wesurvey.com/",
"secret": "open_test",
"is_active": true,
"options": "{\"listenedResources\":[\"answer\"]}",
"created_at": "2021-06-21 16:02:33",
"updated_at": "2021-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参数校验不通过
not_found找不到数据
update_error创建webhook失败