Get
/webhook
You can view the details of all webhook endpoints registered for your workspace via the API.
To view all webhooks registered for your workspace, send a GET request to https://api.copy.ai/api/webhook.
You will receive a response with the details for all webhooks.
For example:
JSON
{
"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
}
]
}Security
API Key: ApiKeyAuth
Header parameter namex-copy-ai-api-key
Copy.ai API key for authentication
Header parameters
x-copy-ai-api-key
stringRequired
Query parameters
size
integer
Number of webhooks to include in pagination (up to 100, defaults to 10).
Default10
page
integer
Used to specify further pages (starts at 0).
Default0
Responses
200
Success
success
{
"total": "2",
"data": [
{
"id": "",
"url": "https://mywebsite.com/webhook",
"eventType": "workflowRun.completed",
"workflowId": ""
},
{
"id": "",
"url": "https://mywebsite.com/webhook",
"eventType": "workflowRun.started",
"workflowId": null
}
]
} object
total
integer
data
Array of object (WebhookData)
object
id
string
url
string
eventType
string
workflowId
string
400
Bad Request
422
Validation Error