Platform · Workflow Automation
Workflows
A trigger, a condition and a list of steps. Run one by hand to see exactly what it would do before letting an event drive it.
/api/platform/workflowsPublished as /api/v1/workflowsOverview
| Package | Platform |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Platform › Workflows on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | platform.workflows · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
12 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/platform/workflowsList workflows
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"description": "text",
"category": "automation",
"trigger_type": "text",
"trigger_event": "text",
"trigger_module": "accounting",
"schedule_cron": "text",
"condition": {},
"status": "draft",
"run_count": 10,
"success_count": 10
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/platform/workflows?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/workflows/{id}Read one workflows
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"description": "text",
"category": "automation",
"trigger_type": "text",
"trigger_event": "text",
"trigger_module": "accounting",
"schedule_cron": "text",
"condition": {},
"status": "draft",
"run_count": 10,
"success_count": 10
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/platform/workflows/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/workflowsCreate a workflows
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Workflow code — e.g. WF-PO-APPROVE |
name | text | Yes | Name |
description | text | No | What it does |
category | text | No | Category Allowed: automation approval integration notification data_quality escalation |
trigger_type | text | No | Trigger |
trigger_event | text | No | Event — e.g. platform.payment.captured — the event that starts it. For "Record created" or "Record updated", the screen instead, e.g. leads, with Module set to crm. |
trigger_module | text | No | Module Allowed: accounting crm hrms scm mfg ehr slcm ats platform |
schedule_cron | text | No | Schedule (cron) — Only for a scheduled trigger: minute hour day month weekday, in UTC, e.g. "0 7 * * 1-5" is seven o’clock on weekdays. It runs as the owner, or as the automation service account when the owner is an administrator. |
condition | jsonb | No | Condition — Decides whether the event concerns this workflow at all, before any step runs: {"field":"amount","operator":"gt","value":1000} |
status | text | No | Status Allowed: draft active paused archived |
owner_id | uuid | No | Owner |
max_retries | integer | No | Maximum retries |
timeout_seconds | integer | No | Timeout (seconds) |
Sample body
{
"code": "COD-000001",
"name": "Example",
"description": "text",
"category": "automation",
"trigger_type": "text",
"trigger_event": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"description": "text",
"category": "automation",
"trigger_type": "text",
"trigger_event": "text",
"trigger_module": "accounting",
"schedule_cron": "text",
"condition": {},
"status": "draft",
"run_count": 10,
"success_count": 10
}Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/workflows" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","description":"text","category":"automation","trigger_type":"text","trigger_event":"text"}'PUT/api/platform/workflows/{id}Change a workflows
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Workflow code — e.g. WF-PO-APPROVE |
name | text | Yes | Name |
description | text | No | What it does |
category | text | No | Category Allowed: automation approval integration notification data_quality escalation |
trigger_type | text | No | Trigger |
trigger_event | text | No | Event — e.g. platform.payment.captured — the event that starts it. For "Record created" or "Record updated", the screen instead, e.g. leads, with Module set to crm. |
trigger_module | text | No | Module Allowed: accounting crm hrms scm mfg ehr slcm ats platform |
schedule_cron | text | No | Schedule (cron) — Only for a scheduled trigger: minute hour day month weekday, in UTC, e.g. "0 7 * * 1-5" is seven o’clock on weekdays. It runs as the owner, or as the automation service account when the owner is an administrator. |
condition | jsonb | No | Condition — Decides whether the event concerns this workflow at all, before any step runs: {"field":"amount","operator":"gt","value":1000} |
status | text | No | Status Allowed: draft active paused archived |
owner_id | uuid | No | Owner |
max_retries | integer | No | Maximum retries |
timeout_seconds | integer | No | Timeout (seconds) |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"description": "text",
"category": "automation",
"trigger_type": "text",
"trigger_event": "text",
"trigger_module": "accounting",
"schedule_cron": "text",
"condition": {},
"status": "draft",
"run_count": 10,
"success_count": 10
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/platform/workflows/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/platform/workflows/{id}Delete a workflows
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/platform/workflows/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/workflows/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/workflows/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'GET/api/platform/workflows/{parentId}/stepsSteps
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/platform/workflows/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/steps" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/workflows/{parentId}/stepsSteps
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/workflows/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/steps" \
-H "Authorization: Bearer $TOKEN"PUT/api/platform/workflows/{parentId}/steps/{lineId}Steps
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/platform/workflows/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/platform/workflows/{parentId}/steps/{lineId}Steps
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/platform/workflows/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/workflows/{id}/runRun
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
inputResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/workflows/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/run" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"input":"value"}'POST/api/platform/workflows/dispatchDispatch
Request body
The keys this action reads (* = required; "one of" lists the only values):
eventType*, payloadResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/workflows/dispatch" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"eventType":"value","payload":"value"}'Data model
Every field of a workflows, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
code | text | read, write | Workflow code — e.g. WF-PO-APPROVE |
name | text | read, write | Name |
description | text | read, write | What it does |
category | text | read, write | Category Allowed: automation approval integration notification data_quality escalation |
trigger_type | text | read, write | Trigger |
trigger_event | text | read, write | Event — e.g. platform.payment.captured — the event that starts it. For "Record created" or "Record updated", the screen instead, e.g. leads, with Module set to crm. |
trigger_module | text | read, write | Module Allowed: accounting crm hrms scm mfg ehr slcm ats platform |
schedule_cron | text | read, write | Schedule (cron) — Only for a scheduled trigger: minute hour day month weekday, in UTC, e.g. "0 7 * * 1-5" is seven o’clock on weekdays. It runs as the owner, or as the automation service account when the owner is an administrator. |
condition | jsonb | read, write | Condition — Decides whether the event concerns this workflow at all, before any step runs: {"field":"amount","operator":"gt","value":1000} |
status | text | read, write | Status Allowed: draft active paused archived |
run_count | integer | read only | Run count |
success_count | integer | read only | Success count |
failure_count | integer | read only | Failure count |
last_run_at | timestamp with time zone | read only | Last run at |
owner_id | uuid | read, write | Owner |
max_retries | integer | read, write | Maximum retries |
timeout_seconds | integer | read, write | Timeout (seconds) |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
next_due_at | timestamp with time zone | read only | Next due at |
schedule_zone | text | read only | Schedule zone |
schedule_claimed_by | text | read only | Schedule claimed by |
schedule_claimed_at | timestamp with time zone | read only | Schedule claimed at |
schedule_error | text | read only | Schedule error |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Platform › Workflows for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.