获取所有 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
        }
    ]
}

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://dev-cn.your-api-server.com/api/webhook?size=10&page=0' \
--header 'x-copy-ai-api-key;'

响应示例

200 - 成功示例

{
  "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）。

示例值:

page

string

可选

用于指定更多页面（从 0 开始）。

示例值:

Header 参数

x-copy-ai-api-key

string

必需

返回响应

🟢200成功

application/json

Body

total

integer

必需

data

array [object {4}]

必需

string

必需

url

string

必需

eventType

string

必需

workflowId

string | null

必需

🟠422参数错误

修改于 2023-12-26 09:30:05

获取 Webhook

删除 Webhook