Workflows

Use workflows to automate multi-step processes

The Workflow Execution object

A Workflow Execution represents an instance of a workflow run triggered by your backend or frontend application. You can run workflows on a Transactionlink-hosted page, embed the form in your app, or execute them entirely in the background.

Use this object to initialize the flow, pass context, and retrieve completion status via webhooks or polling.

We recommend creating a new execution each time a user starts a workflow, to ensure that the flow is fresh and state is isolated for every attempt.

Initialise a new workflow execution

post

Initialise a new workflow execution

Authorizations

Header parameters

AuthorizationstringRequired

Bearer token for authentication

Example: Bearer eyJhbGciOiJub25lIn0.eyJ3b3Jrc3BhY2VJZCI6ImI0YmJlNzVhLWY1OTMtNGJlMS04MWViLTNlMDZiYThjZGIxYiIsICJpYXQiOjE3NTY0NTk5NjYsICJleHAiOjE3NTY0NjM1NjYsICJjdXN0b206dGVhbUlkIjoiMzU4Nzg5NDYtMzY1NS00NzgzLTlhYWQtNWZhN2YwOGFiMjAzIn0.

Content-TypestringRequired

Content type of the request - application/json

Example: application/json;charset=UTF-8

Body

workflowDefinitionIdstringRequired

Identifier of the workflow definition to execute

localestringRequired

Locale for the workflow execution, e.g., 'en', 'fr'

parametersobjectRequired

Key-value pairs of parameters required for the workflow execution

expiresAtstring | nullableOptional

Optional expiration date-time for the workflow execution in ISO 8601 format

Responses

200

200

application/json;charset=UTF-8

post

HTTPcURLJavaScriptPython

POST /workflows HTTP/1.1
Host: api.sandbox.transactionlink.io
Authorization: text
Content-Type: application/json;charset=UTF-8
Accept: */*
Content-Length: 126

"{\n  \"workflowDefinitionId\" : \"c7c0a346-ee1f-4d11-898b-5cfd812c8029\",\n  \"locale\" : \"uk\",\n  \"parameters\" : { }\n}"

200

200

{
  "id" : "0fc2dd2b-3c0c-448a-a514-96f5e02caa6a",
  "workspaceId" : "b4bbe75a-f593-4be1-81eb-3e06ba8cdb1b",
  "workflowDefinitionId" : "c7c0a346-ee1f-4d11-898b-5cfd812c8029",
  "parameters" : { },
  "name" : "workflow-name",
  "revision" : "abc",
  "status" : "RUNNING",
  "locale" : "uk",
  "expiresAt" : "2025-08-29T10:32:46.288669Z",
  "uiOptions" : { },
  "executionType" : "BACKGROUND",
  "executionVersion" : 1
}

Find a workflow execution by its ID

get

Find a workflow execution by its ID

Authorizations

Path parameters

workflowIdstringRequired

Unique identifier of the workflow execution to retrieve

Header parameters

AuthorizationstringRequired

Bearer token for authentication

Example: Bearer eyJhbGciOiJub25lIn0.eyJ3b3Jrc3BhY2VJZCI6ImY3Yzc0ZWY0LTk4NmItNDFhMS1hZTA2LWYyN2EwYTgzOTM3NyIsICJpYXQiOjE3NTY0NTk5NjYsICJleHAiOjE3NTY0NjM1NjYsICJjdXN0b206dGVhbUlkIjoiOTk3N2MyYjktNTAzYi00YmY0LWJmYzUtNWZlNTI1MmZmODc1In0.

Responses

200

200

application/json;charset=UTF-8

get

HTTPcURLJavaScriptPython

GET /workflows/{workflowId} HTTP/1.1
Host: api.sandbox.transactionlink.io
Authorization: text
Accept: */*

200

200

{
  "id" : "5d75e598-2d94-46db-9c19-158bc9149159",
  "workspaceId" : "f7c74ef4-986b-41a1-ae06-f27a0a839377",
  "workflowDefinitionId" : "76ebf1d0-66cc-4498-9fe5-be0aba5eafbc",
  "parameters" : { },
  "name" : "workflow-name",
  "revision" : "abc",
  "status" : "RUNNING",
  "locale" : "uk",
  "expiresAt" : "2025-08-29T10:32:46.242361Z",
  "uiOptions" : { },
  "executionType" : "BACKGROUND",
  "executionVersion" : 1
}

Cancel a running workflow execution

post

Cancel a running workflow execution

Authorizations

Path parameters

workflowIdstringRequired

Unique identifier of the workflow execution to cancel

Header parameters

AuthorizationstringRequired

Bearer token for authentication

Example: Bearer eyJhbGciOiJub25lIn0.eyJ3b3Jrc3BhY2VJZCI6IjdhNWZkNTllLWE2MjktNDBmYy1iMTU3LTYzZjc5ZDczOThkNiIsICJpYXQiOjE3NTY0NTk5NjYsICJleHAiOjE3NTY0NjM1NjYsICJjdXN0b206dGVhbUlkIjoiMGZjZWIxNGQtOWEyNC00MzU1LTg1OGUtYjNjNmNlMWI2ZDBjIn0.

Responses

200

200

No content

post

HTTPcURLJavaScriptPython

POST /workflows/{workflowId}/cancel HTTP/1.1
Host: api.sandbox.transactionlink.io
Authorization: text
Accept: */*

200

200

No content