Execute workflow

Endpoint

POST https://embedworkflow.com/api/v1/workflows/{id}/execute

Path Parameters

id string, required

System-generated unique identifier

Request Body

id_type string, optionaldefault: id

Type of identifier used in the URL

user_key string, optionaldefault: main

User's key

execution_data object, optionaldefault: [object Object]

Data required to execute the workflow. Key-value pairs that provide context and variables needed during workflow execution.

Response

Returns created.

Response Properties

hashid string

System-generated unique identifier

actions_count integer

Total number of actions in the execution

completed_actions_count integer

Number of completed actions

created_at string

Created at in specified timezone

created_at_string string

Created at formatted as human-readable string

created_at_utc string

Created at in UTC

execution_data object

Data context for the execution

failed_actions_count integer

Number of failed actions

id string

System-generated unique identifier

idle_actions_count integer

Number of idle actions

key string

Unique key for the execution

log object

Execution log details

name string

Name of the execution

object string

Object type identifier

running_actions_count integer

Number of currently running actions

status string

Current status of the execution

stopped_actions_count integer

Number of stopped actions

Errors

404 - not found

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "hashid": "6opb4",
  "actions_count": 0,
  "completed_actions_count": 0,
  "created_at": "2025-08-19T11:19:18-04:00",
  "created_at_string": "Aug 19, 2025 11:19 am EDT",
  "created_at_utc": "2025-08-19T15:19:18Z",
  "execution_data": {
    "user_name": "John Doe"
  },
  "failed_actions_count": 0,
  "id": "0198c2e9-cc9f-7277-af8a-40c7ef19273a",
  "idle_actions_count": 0,
  "key": "workflow_15",
  "log": {},
  "name": "Workflow 15",
  "object": "execution",
  "running_actions_count": 0,
  "status": "running",
  "stopped_actions_count": 0
}