帮助中心GitHub

创建 webhook

创建一个新的 webhook 端点以接收实时事件通知。

参数

请求体

name string 必填
webhook 端点的易读名称
url string 必填
将接收 webhook POST 请求的 HTTPS URL
event_types array 必填
要订阅的事件(使用 "all" 表示所有事件)
description string
可选的参考说明
is_active boolean
webhook 是否处于启用状态
retry_attempts integer
失败时的重试次数(0-10)
timeout integer
请求超时时间,单位为秒(5-60)
auth_type string (none | basic | bearer | custom)
你的端点使用的身份验证方式
auth_config object
身份验证凭据(取决于 auth_type)
custom_headers object
请求中要包含的额外 HTTP 头

返回

201 webhook 创建成功
400 验证错误
401 需要身份验证

相关

Webhooks
POST/api/v1/webhooks
atoship © 2026