获取所有 Webhook
GET
/api/webhook您可以通过 API 查看为您的工作区注册的所有 Webhook 端点的详细信息。
要查看为你的工作区注册的所有Webhook,发送一个GET请求至 https://api.copy.ai/api/webhook。
你将收到一个响应,其中包含所有Webhook的详细信息。
例如:
{
"total": 2,
"data":
[
{
"id": "<webhook_id>",
"url": "<https://mywebsite.com/webhook>",
"eventType": "workflowRun.completed",
"workflowId": "<workflow_id>"
},
{
"id": "<webhook_id>",
"url": "<https://mywebsite.com/webhook>",
"eventType": "workflowRun.started",
"workflowId": null
}
]
}
请求参数
Query 参数
size
string
可选
分页中包含的 Webhook 数量(最多 100 个,默认为 10)。
示例值:
10
page
string
可选
用于指定更多页面(从 0 开始)。
示例值:
0
示例代码
返回响应
成功(200)
参数错误(422)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
total
integer
必需
data
array [object {4}]
必需
id
string
必需
url
string
必需
eventType
string
必需
workflowId
string | null
必需
示例
成功示例
{
"total": 2,
"data": [
{
"id": "<webhook_id>",
"url": "<https://mywebsite.com/webhook>",
"eventType": "workflowRun.completed",
"workflowId": "<workflow_id>"
},
{
"id": "<webhook_id>",
"url": "<https://mywebsite.com/webhook>",
"eventType": "workflowRun.started",
"workflowId": null
}
]
}
最后修改时间: 1 年前