注册 Webhook

您可以通过 API 注册 Webhook 端点，以获得有关工作区中发生的工作流事件的通知。

要注册一个Webhook，向https://api.copy.ai/api/webhook 发送一个POST请求，请求体中需要包含你的Webhook URL、你希望被通知的事件类型，以及一个可选的工作流ID的JSON数据。

您将收到包含您注册的 webhook 详细信息的响应：

JSON

{
  "status": "success",
  "data": {
    "id": "<id of webhook>",
    "url": "<https://mywebsite.com/webhook>",
    "eventType": "workflowRun.completed",
    "workflowId": "<my-workflow-id>"
  }
}

**注意：**如果未包含工作流程 ID，您将收到工作区中所有工作流程的事件。

事件类型

事件类型	描述
`workflowRun.started`	每当工作流运行开始时发送事件。
`workflowRun.completed`	每当工作流运行完成时发送事件。
`workflowRun.failed`	每当工作流运行失败时发送事件。
`workflowCreditLimit.reached`	当您的工作区达到信用额度时发送事件。

curl --location --request POST 'http://dev-cn.your-api-server.com/api/webhook' \ --header 'x-copy-ai-api-key;' \ --header 'content-type: application/json' \ --data-raw '{ "url": "<https://mywebsite.com/webhook>", "eventType": "workflowRun.completed", "workflowId": "<my-workflow-id>" }'

请求参数

Header 参数

content-type

string

必需

示例值:

application/json

x-copy-ai-api-key

string

必需

Body 参数application/json

eventType

string

必需

您想要接收通知的事件类型。

url

string

必需

Webhook 端点的 URL。

workflowId

string

可选

（可选）您想要接收其事件的工作流程 ID。

示例

事件类型#

请求参数

返回响应

事件类型