TRANXACT.AI Help

Platform · Extension Hooks

Hook Runs

Every run of every hook that did something or failed, and every evaluation of a hook still in dry run: when, what fired, what it did and how long it took. Kept for thirty days.

Type REST5 operationsBase path /api/platform/hook-runsPublished as /api/v1/hook-runs

Download specification (OpenAPI 3.1) Screen: Hook Runs

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 › Hook Runs 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.
Tableext.hook_runs · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

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

GET/api/platform/hook-runsList hook runs

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": "1250.00",
      "hook_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "hook_name": "Example",
      "point": "text",
      "module_key": "text",
      "resource_key": "text",
      "record_id": "text",
      "event_key": "text",
      "outcome": "text",
      "mode": "text",
      "message": "text",
      "duration_ms": "1250.00",
      "detail": {},
      "created_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "1250.00",
  "hook_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hook_name": "Example",
  "point": "text",
  "module_key": "text",
  "resource_key": "text",
  "record_id": "text",
  "event_key": "text",
  "outcome": "text",
  "mode": "text",
  "message": "text",
  "duration_ms": "1250.00",
  "detail": {},
  "created_at": "2026-10-30T09:00:00Z"
}

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

Sample request

curl "https://demo.tranxact.ai/api/platform/hook-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/hook-runsPost hook runs

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/hook-runs" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/platform/hook-runs/{id}Put hook runs

Path parameters

NameTypeDescription
idstring (uuid)The record's id, 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/hook-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/platform/hook-runs/{id}Delete hook runs

Path parameters

NameTypeDescription
idstring (uuid)The record's id, 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/hook-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a hook run, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
idbigintread onlyId
org_iduuidread onlyOrg id
hook_iduuidread onlyHook id
hook_nametextread onlyHook name
pointtextread onlyPoint
module_keytextread onlyModule key
resource_keytextread onlyResource key
record_idtextread onlyRecord id
event_keytextread onlyEvent key
outcometextread onlyOutcome
modetextread onlyMode
messagetextread onlyMessage
duration_msnumericread onlyDuration ms
detailjsonbread onlyDetail
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
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 › Hook Runs 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.