抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • 基础配置
  • 开发信息配置
  • IP白名单配置
  • SPI配置
  • Webhooks配置
  • 验收准备
  • 测试验收
  • 应用上线
  • 排查工具
  • 注意
    当前功能正在定向邀测中,仅限参加测试的开发者使用,全面放开时间请等待平台公告。

    功能介绍

    本页面用于配置 Webhooks。
    webhook 是用户事件触发反向通知的机制,开发者可根据需要订阅事件,接收通知。

    前提条件

    已完成 SPI 配置

    配置说明

    回调地址

    回调地址配置

    第一步:在解决方案接入详情页左侧导航栏选中基础配置-Webhooks配置。
    第二步:点击页面中配置请求网址 URL 模块中的配置按钮,填写你要配置的请求网址,完成后点击确定按钮保存。

    回调地址验证

    完成请求网址编辑后,点击保存时,开放平台会向你配置的网址推送一个 application/json 格式的 POST 请求, 该请求用于验证你配置的网址的合法性。 通过开放平台验证的请求网址才能配置成功,请求网址配置成功后,你才可以进一步订阅你的应用关心的事件。
    开放平台发送的验证请求示例:
    {"event": "verify_webhook","client_key": "","content": {"challenge": 12345}}
    当你收到开放平台 POST 验证请求时,你需要解析出 challenge 值,并立即返回该 challenge 值作为响应。
    注意
    返回内容需要放入 ResponseBody 里,不能直接返回,需要返回内容为 text 格式的 JSON 数据。
    {"challenge": 12345}

    事件订阅

    开发者可通过页面中订阅事件模块订阅需要通知的事件。
    说明
    如果开发者服务器长时间未响应事件推送请求,可能会取消开发者的订阅状态,开发者需重新订阅。