Webhook 端点
停用 Webhook 端点
将 Webhook 端点状态设为 inactive，但不会删除端点。
https://api.unifyport.ai/v1/webhook-endpoints/{endpoint_id}/deactivate支持的渠道
调用前准备
在服务端使用资源所属工作区的 X-Api-Key。运行示例前替换所有占位符。
参数从哪里取得
- account_id
- 从创建或查询账号的响应取得 data.id。账号标识属于 X-Api-Key 对应的工作区。 获取账号
请求参数
请求头
X-Api-Key工作区 API Key，工作区由该请求头解析得到。
路径参数
endpoint_id用于该 webhook endpoints 路由的标识符。
查询参数
account_id可选的公开账号 ID，例如 acc_example。不可为空、仅含空白或重复出现。参数名必须精确使用 account_id；大小写变体返回 400 invalid_request，不按省略处理。列表省略时只返回工作空间端点；指定时只返回账号独立配置（没有独立配置则 data=[]，不混入继承的工作空间配置）。详情、停用、删除仅校验已有账号归属；不匹配返回 400 invalid_request。显式账号不存在或不属于当前工作空间返回 404 account_not_found (20020)。
minLength: 1 · pattern: \S
请求体
该接口无需 JSON 请求体。
如何理解结果
确认响应中的 status=inactive。此端点不再用于新投递，但停用不保证取消已经在途的请求。
响应 200 OK
{
"request_id": "<REQUEST_ID>",
"data": {
"id": "we_example",
"url": "https://example.com/webhook-updated",
"status": "inactive",
"subscribed_events": [
"message.delivered",
"message.read"
],
"signing_enabled": false,
"retry_policy": {
"max_attempts": 1
}
}
}
响应体
idWebhook 端点标识（we_...）。
account_id账号独立端点的公开账号 ID；工作空间端点省略此字段，不返回 null。
minLength: 1
url接收 Webhook 投递的绝对 HTTP(S) URL；生产环境建议 HTTPS。
format: uri
status端点状态：active 或 inactive。
enum: active, inactive
subscribed_events[]投递到该端点的公开标准事件类型；["*"] 表示全部公开事件，不包含 provider.raw_event。
signing_enabled设置了签名密钥且对投递进行签名时为 true。
retry_policyobject接口返回的重试设置。max_attempts 统计首次投递后的重试次数，默认 3，范围为 0 到 5。
retry_policy接口返回的重试设置。max_attempts 统计首次投递后的重试次数，默认 3，范围为 0 到 5。
max_attempts已配置的首次投递后重试次数，范围为 0 到 5。
响应
200200 OK
请求成功，响应体示例如上。
400请求错误
请求体、路径或参数不合法。
401未授权
X-Api-Key 请求头缺失或无效。
404未找到
未找到请求的资源；请结合 error.code 和当前操作核对。
失败后怎么处理
检查 HTTP 状态和 error.code/numeric_code，保存 request_id 用于排查。按原因修正参数、继续授权或检查运行态。重试发送及其他写操作前先确认上一次结果，避免重复操作。 错误码参考
- invalid_request · 10000 · 400
- 检查必填字段、格式和渠道条件，修正请求后再调用。
- missing_api_key · 11000 · 401
- 检查 X-Api-Key 是否正确、工作区是否有效。
- invalid_api_key · 11001 · 401
- 检查 X-Api-Key 是否正确、工作区是否有效。