获取 Webhook

开发环境

http://dev-cn.your-api-server.com

GET

https://api.copy.ai/api/webhook/{webhook_id}

您可以通过 API 查看 Webhook 端点的详细信息。
要查看一个Webhook，发送一个GET请求至 https://api.copy.ai/api/webhook/<webhook_id>。
你将收到一个包含该Webhook详细信息的响应。
例如：

{
	"status": "success",
	"data": {
		"id": "<webhook_id>",
		"url": "<https://mywebsite.com/webhook>",
		"eventType": "workflowRun.completed",
		"workflowId": "<workflow_id>"
	}
}

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.copy.ai/api/webhook/' \
--header 'x-copy-ai-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{}'

响应示例

200 - 成功示例

{
	status: "success",
  data: {
		id: "<webhook_id>",
		url: "<https://mywebsite.com/webhook>",
		eventType: "workflowRun.completed",
		workflowId: "<workflow_id>"
	}
}

请求参数

Path 参数

webhook_id

string

必需

Webhook 的 ID

Header 参数

x-copy-ai-api-key

string

必需

Body 参数application/json

object {0}

示例

返回响应

🟢200成功

application/json

Body

status

string

必需

data

object

必需

string

必需

url

string

必需

eventType

string

必需

workflowId

string

必需

🟠400请求有误

🟠404记录不存在

修改于 2023-12-26 09:49:39

获取所有 Webhook