TRANXACT.AI Help

Agentic AI · Orchestrate

Triggers

What starts a run. A trigger created from a template is never armed — a new tenant should not have agents running before anybody has read what they do.

Type REST6 operationsBase path /api/agentic/triggersPublished as /api/v1/triggers

Download specification (OpenAPI 3.1) Screen: Triggers

Overview

PackageAgentic AI
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 Agentic AI › Triggers 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.
Tableagent.triggers · 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

6 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/agentic/triggersList triggers

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",
      "name_local": "Example",
      "workflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "trigger_kind": "text",
      "schedule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "cron_expr": "text",
      "timezone": "text",
      "event_name": "Example",
      "target_module": "text",
      "target_resource": "text"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/agentic/triggers?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/agentic/triggers/{id}Read one triggers

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",
  "name_local": "Example",
  "workflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "trigger_kind": "text",
  "schedule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cron_expr": "text",
  "timezone": "text",
  "event_name": "Example",
  "target_module": "text",
  "target_resource": "text"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/agentic/triggers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/agentic/triggersCreate a triggers

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
name_localtextNoName local
workflow_iduuidNoWorkflow
agent_iduuidNoAgent — One or the other. A trigger that names both runs the workflow.
trigger_kindtextNoKind
cron_exprtextNoSchedule — For a scheduled trigger: five fields as cron writes them (minute hour day month weekday), e.g. 0 7 * * 1-5 for 07:00 on weekdays.
timezonetextNoTime zone — The time zone the schedule is read in. Type to find one, e.g. Riyadh. Empty: UTC.
event_nametextNoEvent — For an event trigger: the event that starts it, e.g. acct.ar_invoice.posted. The list shows the events raised here; choose Other to type a name with * in it, e.g. acct.*.posted.
target_moduletextNoModule — For a record trigger: the module of the records watched, e.g. HR.
target_resourcetextNoResource — For a record trigger: the screen whose records are watched, e.g. Employees.
record_eventtextNoWhen a record is
Allowed: created updated deleted status_changed
filter_exprtextNoOnly when — A condition the record or event must meet, e.g. amount > 10000. Empty: every one.
cube_keytextNoCube — For a threshold trigger: the figures it watches.
measure_keytextNoMeasure — For a threshold trigger: the figure in that cube.
comparatortextNoCrosses — gt above, gte at or above, lt below, lte at or below, eq equal, neq not equal, changes_by moves by at least the threshold.
Allowed: gt gte lt lte eq neq changes_by
threshold_valuenumericNoThreshold — The figure compared against.
webhook_pathtextNoWebhook path
min_interval_secondsintegerNoNever more often than (seconds) — A quiet period after it fires, e.g. 3600 for at most once an hour.
max_per_dayintegerNoMost per day — It stops firing for the day after this many runs.
statustextNoStatus — The one setting that decides whether it fires: only an active trigger starts runs. One made from a template starts inactive. error means it was stopped because it could not start a run (Last error says why); it stays stopped until the cause is fixed and it is set active again. Changing Status clears Last error.
Allowed: inactive active paused error
is_activebooleanNoIs active

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "name_local": "Example",
  "workflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "trigger_kind": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "name_local": "Example",
  "workflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "trigger_kind": "text",
  "schedule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cron_expr": "text",
  "timezone": "text",
  "event_name": "Example",
  "target_module": "text",
  "target_resource": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/agentic/triggers" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","name_local":"Example","workflow_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","agent_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","trigger_kind":"text"}'
PUT/api/agentic/triggers/{id}Change a triggers

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
codetextYesCode
nametextYesName
name_localtextNoName local
workflow_iduuidNoWorkflow
agent_iduuidNoAgent — One or the other. A trigger that names both runs the workflow.
trigger_kindtextNoKind
cron_exprtextNoSchedule — For a scheduled trigger: five fields as cron writes them (minute hour day month weekday), e.g. 0 7 * * 1-5 for 07:00 on weekdays.
timezonetextNoTime zone — The time zone the schedule is read in. Type to find one, e.g. Riyadh. Empty: UTC.
event_nametextNoEvent — For an event trigger: the event that starts it, e.g. acct.ar_invoice.posted. The list shows the events raised here; choose Other to type a name with * in it, e.g. acct.*.posted.
target_moduletextNoModule — For a record trigger: the module of the records watched, e.g. HR.
target_resourcetextNoResource — For a record trigger: the screen whose records are watched, e.g. Employees.
record_eventtextNoWhen a record is
Allowed: created updated deleted status_changed
filter_exprtextNoOnly when — A condition the record or event must meet, e.g. amount > 10000. Empty: every one.
cube_keytextNoCube — For a threshold trigger: the figures it watches.
measure_keytextNoMeasure — For a threshold trigger: the figure in that cube.
comparatortextNoCrosses — gt above, gte at or above, lt below, lte at or below, eq equal, neq not equal, changes_by moves by at least the threshold.
Allowed: gt gte lt lte eq neq changes_by
threshold_valuenumericNoThreshold — The figure compared against.
webhook_pathtextNoWebhook path
min_interval_secondsintegerNoNever more often than (seconds) — A quiet period after it fires, e.g. 3600 for at most once an hour.
max_per_dayintegerNoMost per day — It stops firing for the day after this many runs.
statustextNoStatus — The one setting that decides whether it fires: only an active trigger starts runs. One made from a template starts inactive. error means it was stopped because it could not start a run (Last error says why); it stays stopped until the cause is fixed and it is set active again. Changing Status clears Last error.
Allowed: inactive active paused error
is_activebooleanNoIs active

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",
  "name_local": "Example",
  "workflow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "agent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "trigger_kind": "text",
  "schedule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cron_expr": "text",
  "timezone": "text",
  "event_name": "Example",
  "target_module": "text",
  "target_resource": "text"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/agentic/triggers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/agentic/triggers/{id}Delete a triggers

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/agentic/triggers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/agentic/triggers/{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/agentic/triggers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a triggers, 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, writeCode
nametextread, writeName
name_localtextread, writeName local
workflow_iduuidread, writeWorkflow
agent_iduuidread, writeAgent — One or the other. A trigger that names both runs the workflow.
trigger_kindtextread, writeKind
schedule_iduuidread onlySchedule id
cron_exprtextread, writeSchedule — For a scheduled trigger: five fields as cron writes them (minute hour day month weekday), e.g. 0 7 * * 1-5 for 07:00 on weekdays.
timezonetextread, writeTime zone — The time zone the schedule is read in. Type to find one, e.g. Riyadh. Empty: UTC.
event_nametextread, writeEvent — For an event trigger: the event that starts it, e.g. acct.ar_invoice.posted. The list shows the events raised here; choose Other to type a name with * in it, e.g. acct.*.posted.
target_moduletextread, writeModule — For a record trigger: the module of the records watched, e.g. HR.
target_resourcetextread, writeResource — For a record trigger: the screen whose records are watched, e.g. Employees.
record_eventtextread, writeWhen a record is
Allowed: created updated deleted status_changed
filter_exprtextread, writeOnly when — A condition the record or event must meet, e.g. amount > 10000. Empty: every one.
cube_keytextread, writeCube — For a threshold trigger: the figures it watches.
measure_keytextread, writeMeasure — For a threshold trigger: the figure in that cube.
comparatortextread, writeCrosses — gt above, gte at or above, lt below, lte at or below, eq equal, neq not equal, changes_by moves by at least the threshold.
Allowed: gt gte lt lte eq neq changes_by
threshold_valuenumericread, writeThreshold — The figure compared against.
webhook_pathtextread, writeWebhook path
webhook_secret_cipherbytearead onlyWebhook secret cipher
webhook_secret_last4textread onlyWebhook secret last4
min_interval_secondsintegerread, writeNever more often than (seconds) — A quiet period after it fires, e.g. 3600 for at most once an hour.
max_per_dayintegerread, writeMost per day — It stops firing for the day after this many runs.
fired_countbigintread onlyFired count
last_fired_attimestamp with time zoneread onlyLast fired at
next_due_attimestamp with time zoneread onlyNext due at
statustextread, writeStatus — The one setting that decides whether it fires: only an active trigger starts runs. One made from a template starts inactive. error means it was stopped because it could not start a run (Last error says why); it stays stopped until the cause is fixed and it is set active again. Changing Status clears Last error.
Allowed: inactive active paused error
last_errortextread onlyLast error
is_activebooleanread, writeIs active
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
last_valuenumericread onlyLast value
last_statebooleanread onlyLast state
last_checked_attimestamp with time zoneread onlyLast checked at
claimed_bytextread onlyClaimed by
claimed_attimestamp with time zoneread onlyClaimed at
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 Agentic AI › Triggers 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.