Workflows

Workflows API enables you to run flow through api

To enable the workflow to be triggered via the public API, ensure proper configuration while avoiding any tasks that necessitate interaction with the end user.

POST Run Workflow

Run Workflow

Run Workflow

POSThttps://api.transactionlink.io/workflows/run

Body

application/json

caseId*string (uuid)

Case identifier for which we want to initiate the workflow

workflowDefinitionId*string

Id of the workflow definition

Example: "3b2d8a4f-579f-4e2e-a51c-f859e532fe8c"

parametersIdstring

Id of the parameters used in workflow

Example: "4b6ffcb6-ab6d-44b9-b5ab-4b5147b0b302"

Response

200404

Workflow has been run.

Body

application/json

id*string (uuid)

Id of the Workflow

Example: "63131229-edc5-49d0-888b-7724e65d7d2d"

caseId*string

Id of the Case

Example: "3b2d8a4f-579f-4e2e-a51c-f859e532fe8c"

status*enum

Status of the workflow

COMPLETEDFAILEDRUNNING

Request

JavaScriptCurlPython

const response = await fetch('https://api.transactionlink.io/workflows/run', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "caseId": "123e4567-e89b-12d3-a456-426614174000",
      "workflowDefinitionId": "3b2d8a4f-579f-4e2e-a51c-f859e532fe8c"
    }),
});
const data = await response.json();

Response

200404

{
  "id": "63131229-edc5-49d0-888b-7724e65d7d2d",
  "caseId": "3b2d8a4f-579f-4e2e-a51c-f859e532fe8c",
  "status": "COMPLETED"
}

GET Check Workflow Status

Check Workflow Status

Check Workflow Status

GEThttps://api.transactionlink.io/workflows/{workflowId}

Path parameters

workflowId*string (uuid)

Workflow Identifier

Response

200404

Return the Workflow Status.

Body

application/json

id*string (uuid)

Id of the Workflow

Example: "63131229-edc5-49d0-888b-7724e65d7d2d"

caseId*string

Id of the Case

Example: "3b2d8a4f-579f-4e2e-a51c-f859e532fe8c"

status*enum

Status of the workflow

COMPLETEDFAILEDRUNNING

Request

JavaScriptCurlPython

const response = await fetch('https://api.transactionlink.io/workflows/{workflowId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "id": "63131229-edc5-49d0-888b-7724e65d7d2d",
  "caseId": "3b2d8a4f-579f-4e2e-a51c-f859e532fe8c",
  "status": "COMPLETED"
}

GET Get Workflow Result

Get Workflow Result

Get Workflow Result

GEThttps://api.transactionlink.io/workflows/{workflowId}/result

Path parameters

workflowId*string (uuid)

Workflow Identifier

Response

200404

Return the Workflow Result.

Body

application/json

createdDate*string

Creation time

caseId*string

Case Id

partyId*string

Case id

partyDetails*object

Request

JavaScriptCurlPython

const response = await fetch('https://api.transactionlink.io/workflows/{workflowId}/result', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "createdDate": "text",
  "caseId": "text",
  "partyId": "text",
  "partyDetails": {
    "personal": {
      "firstName": "text",
      "lastName": "text",
      "personalNumber": "text",
      "email": "text",
      "phone": {
        "countryCode": "text",
        "number": "text"
      }
    },
    "business": {
      "companyNumber": "text",
      "companyName": "text",
      "companyAddress": "text"
    },
    "documents": [
      {
        "resourceId": "text",
        "resourceName": "text",
        "resourcePath": "text"
      }
    ]
  }
}