Copy.ai

App · 7 actions

Run Copy.ai workflows, read their results, and manage workflow event webhooks.

Actions

ActionWhat it does
Delete webhookDelete webhook.
Get webhookGet webhook.
Get workflow runGet workflow run.
List webhooksList webhooks.
List workflow runsList workflow runs.
Register webhookRegister webhook.
Start workflow runStart workflow run.

Delete webhook

Delete webhook.

Inputs

Webhook IDwebhook_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 IDwebhook_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

Workflowcopy_workflow_idtextRequired
Workflow id.
Run IDrun_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

Sizesizenumber
Size.From 1.0 to 100.0.
Pagepagenumber
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

Workflowcopy_workflow_idtextRequired
Workflow id.
Sizesizenumber
Size.From 1.0 to 100.0.
Pagepagenumber
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

URLurltextRequired
Url.
Event typeevent_typetextRequired
Event type.One of: workflowRun.started, workflowRun.completed, workflowRun.failed, workflowCreditLimit.reached.
Workflowcopy_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

Workflowcopy_workflow_idtextRequired
Workflow id.
Start variablesstart_variablesobjectRequired
Start variables.
Metadatametadataobject
Metadata.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "data": {
      "data": [],
      "id": "example",
      "output": {},
      "status": "example",
      "total": 0
    },
    "status": "example"
  }
}

On this page