TRANXACT.AI Help

Platform · Events & Webhooks

Webhooks

Events pushed out to another system, signed with HMAC-SHA256 so the receiver can prove where they came from.

Type REST8 operationsBase path /api/platform/webhooksPublished as /api/v1/webhooks

Download specification (OpenAPI 3.1) Screen: Webhooks

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 › Webhooks 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.webhooks · 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

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

GET/api/platform/webhooksList webhooks

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",
      "code": "COD-000001",
      "name": "Example",
      "direction": "outbound",
      "target_url": "https://example.com",
      "events": [],
      "secret_cipher": "text",
      "signature_algo": "hmac-sha256",
      "status": "active",
      "retry_limit": 10,
      "delivery_count": "12.0000",
      "failure_count": "12.0000",
      "last_delivery_at": "2026-10-30T09:00:00Z",
      "created_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "direction": "outbound",
  "target_url": "https://example.com",
  "events": [],
  "secret_cipher": "text",
  "signature_algo": "hmac-sha256",
  "status": "active",
  "retry_limit": 10,
  "delivery_count": "12.0000",
  "failure_count": "12.0000",
  "last_delivery_at": "2026-10-30T09:00:00Z",
  "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/webhooks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/webhooksCreate a webhooks

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesWebhook code
nametextYesName
directiontextNoDirection
Allowed: outbound inbound
target_urltextNoTarget URL
events_textNoEvents — Comma separated. A delivery for an event it does not subscribe to is refused.
signature_algotextNoSignature algorithm — Every delivery is signed. Saved without a signing secret, one is generated and shown to you once.
Allowed: hmac-sha256
statustextNoStatus
Allowed: active paused disabled
retry_limitintegerNoRetry limit

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "direction": "outbound",
  "target_url": "https://example.com",
  "events": [],
  "signature_algo": "hmac-sha256"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "direction": "outbound",
  "target_url": "https://example.com",
  "events": [],
  "secret_cipher": "text",
  "signature_algo": "hmac-sha256",
  "status": "active",
  "retry_limit": 10,
  "delivery_count": "12.0000",
  "failure_count": "12.0000",
  "last_delivery_at": "2026-10-30T09:00:00Z",
  "created_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/webhooks" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","direction":"outbound","target_url":"https://example.com","events":[],"signature_algo":"hmac-sha256"}'
PUT/api/platform/webhooks/{id}Change a webhooks

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
codetextYesWebhook code
nametextYesName
directiontextNoDirection
Allowed: outbound inbound
target_urltextNoTarget URL
events_textNoEvents — Comma separated. A delivery for an event it does not subscribe to is refused.
signature_algotextNoSignature algorithm — Every delivery is signed. Saved without a signing secret, one is generated and shown to you once.
Allowed: hmac-sha256
statustextNoStatus
Allowed: active paused disabled
retry_limitintegerNoRetry limit

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "direction": "outbound",
  "target_url": "https://example.com",
  "events": [],
  "secret_cipher": "text",
  "signature_algo": "hmac-sha256",
  "status": "active",
  "retry_limit": 10,
  "delivery_count": "12.0000",
  "failure_count": "12.0000",
  "last_delivery_at": "2026-10-30T09:00:00Z",
  "created_at": "2026-10-30T09:00:00Z"
}

Sample request

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

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

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):

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/webhooks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/deliver" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"eventType":"value","payload":"value"}'
PUT/api/platform/webhooks/{id}/secretSecret

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):

secret

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/webhooks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/secret" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"secret":"value"}'

Data model

Every field of a webhooks, 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
codetextread, writeWebhook code
nametextread, writeName
directiontextread, writeDirection
Allowed: outbound inbound
target_urltextread, writeTarget URL
events_textread, writeEvents — Comma separated. A delivery for an event it does not subscribe to is refused.
secret_cipherbytearead onlySecret cipher
signature_algotextread, writeSignature algorithm — Every delivery is signed. Saved without a signing secret, one is generated and shown to you once.
Allowed: hmac-sha256
statustextread, writeStatus
Allowed: active paused disabled
retry_limitintegerread, writeRetry limit
delivery_countbigintread onlyDelivery count
failure_countbigintread onlyFailure count
last_delivery_attimestamp with time zoneread onlyLast delivery at
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
exception_overridejsonbread onlyException override
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 › Webhooks 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.