Copy.ai
App · 7 actions
Run Copy.ai workflows, read their results, and manage workflow event webhooks.
Actions
| Action | What it does |
|---|---|
| Delete webhook | Delete webhook. |
| Get webhook | Get webhook. |
| Get workflow run | Get workflow run. |
| List webhooks | List webhooks. |
| List workflow runs | List workflow runs. |
| Register webhook | Register webhook. |
| Start workflow run | Start workflow run. |
Delete webhook
Delete webhook.
Inputs
- Webhook ID
webhook_idtextRequired - Webhook id.
Outputs
responseobject- Response.
Example output
{
"response": {
"data": {
"data": [],
"id": "example",
"output": {},
"status": "example",
"total": 0
},
"status": "example"
}
}Get webhook
Get webhook.
Inputs
- Webhook ID
webhook_idtextRequired - Webhook id.
Outputs
responseobject- Response.
Example output
{
"response": {
"data": {
"data": [],
"id": "example",
"output": {},
"status": "example",
"total": 0
},
"status": "example"
}
}Get workflow run
Get workflow run.
Inputs
- Workflow
copy_workflow_idtextRequired - Workflow id.
- Run ID
run_idtextRequired - Run id.
Outputs
responseobject- Response.
Example output
{
"response": {
"data": {
"data": [],
"id": "example",
"output": {},
"status": "example",
"total": 0
},
"status": "example"
}
}List webhooks
List webhooks. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Size
sizenumber - Size.From 1.0 to 100.0.
- Page
pagenumber - Page.From 1.0 to 100000.0.
Outputs
responseobject- Response.
Example output
{
"response": {
"data": {
"data": [],
"id": "example",
"output": {},
"status": "example",
"total": 0
},
"status": "example"
}
}List workflow runs
List workflow runs. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Workflow
copy_workflow_idtextRequired - Workflow id.
- Size
sizenumber - Size.From 1.0 to 100.0.
- Page
pagenumber - Page.From 1.0 to 100000.0.
Outputs
responseobject- Response.
Example output
{
"response": {
"data": {
"data": [],
"id": "example",
"output": {},
"status": "example",
"total": 0
},
"status": "example"
}
}Register webhook
Register webhook.
Inputs
- URL
urltextRequired - Url.
- Event type
event_typetextRequired - Event type.One of:
workflowRun.started,workflowRun.completed,workflowRun.failed,workflowCreditLimit.reached. - Workflow
copy_workflow_idtext - Workflow id.
Outputs
responseobject- Response.
Example output
{
"response": {
"data": {
"data": [],
"id": "example",
"output": {},
"status": "example",
"total": 0
},
"status": "example"
}
}Start workflow run
Start workflow run.
Inputs
- Workflow
copy_workflow_idtextRequired - Workflow id.
- Start variables
start_variablesobjectRequired - Start variables.
- Metadata
metadataobject - Metadata.
Outputs
responseobject- Response.
Example output
{
"response": {
"data": {
"data": [],
"id": "example",
"output": {},
"status": "example",
"total": 0
},
"status": "example"
}
}