TRANXACT.AI Help

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.

Type REST12 operationsBase path /api/platform/workflowsPublished as /api/v1/workflows

Download specification (OpenAPI 3.1) Screen: Workflows

Overview

PackagePlatform
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tableplatform.workflows · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
codetextYesWorkflow code — e.g. WF-PO-APPROVE
nametextYesName
descriptiontextNoWhat it does
categorytextNoCategory
Allowed: automation approval integration notification data_quality escalation
trigger_typetextNoTrigger
trigger_eventtextNoEvent — 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_moduletextNoModule
Allowed: accounting crm hrms scm mfg ehr slcm ats platform
schedule_crontextNoSchedule (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.
conditionjsonbNoCondition — Decides whether the event concerns this workflow at all, before any step runs: {"field":"amount","operator":"gt","value":1000}
statustextNoStatus
Allowed: draft active paused archived
owner_iduuidNoOwner
max_retriesintegerNoMaximum retries
timeout_secondsintegerNoTimeout (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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
codetextYesWorkflow code — e.g. WF-PO-APPROVE
nametextYesName
descriptiontextNoWhat it does
categorytextNoCategory
Allowed: automation approval integration notification data_quality escalation
trigger_typetextNoTrigger
trigger_eventtextNoEvent — 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_moduletextNoModule
Allowed: accounting crm hrms scm mfg ehr slcm ats platform
schedule_crontextNoSchedule (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.
conditionjsonbNoCondition — Decides whether the event concerns this workflow at all, before any step runs: {"field":"amount","operator":"gt","value":1000}
statustextNoStatus
Allowed: draft active paused archived
owner_iduuidNoOwner
max_retriesintegerNoMaximum retries
timeout_secondsintegerNoTimeout (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

input

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/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*, payload

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
codetextread, writeWorkflow code — e.g. WF-PO-APPROVE
nametextread, writeName
descriptiontextread, writeWhat it does
categorytextread, writeCategory
Allowed: automation approval integration notification data_quality escalation
trigger_typetextread, writeTrigger
trigger_eventtextread, writeEvent — 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_moduletextread, writeModule
Allowed: accounting crm hrms scm mfg ehr slcm ats platform
schedule_crontextread, writeSchedule (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.
conditionjsonbread, writeCondition — Decides whether the event concerns this workflow at all, before any step runs: {"field":"amount","operator":"gt","value":1000}
statustextread, writeStatus
Allowed: draft active paused archived
run_countintegerread onlyRun count
success_countintegerread onlySuccess count
failure_countintegerread onlyFailure count
last_run_attimestamp with time zoneread onlyLast run at
owner_iduuidread, writeOwner
max_retriesintegerread, writeMaximum retries
timeout_secondsintegerread, writeTimeout (seconds)
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
next_due_attimestamp with time zoneread onlyNext due at
schedule_zonetextread onlySchedule zone
schedule_claimed_bytextread onlySchedule claimed by
schedule_claimed_attimestamp with time zoneread onlySchedule claimed at
schedule_errortextread onlySchedule error
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Platform › Workflows for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.