Get Webhook

Prev Next
Get
/webhook/{webhook_id}

You can view the details of a webhook endpoint via the API.

To view a webhook, send a GET request to https://api.copy.ai/api/webhook/<webhook_id>.

You will receive a response with the details of the webhook.

For example:

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

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
Path parameters
webhook_id
stringRequired

The ID of the webhook

Responses
200

Success

Expand All
object
status
string
data
object (WebhookData)
id
string
url
string
eventType
string
workflowId
string
400

Bad Request

404

Not Found

notFound
{
  "status": "error",
  "errorCode": "NOT_FOUND"
}
object
status
string
errorCode
string