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.

Run Workflow

post

Differences between versions: version 1 relies on caseId and is scheduled for deprecation, whereas version 2 uses recordId (this field is optional) and is recommended moving forward.

Body

application/jsonapplication/json;version=2

caseIdstring · uuidRequired

Case identifier for which we want to initiate the workflow

workflowDefinitionIdstringRequired

ID of the workflow definition

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

parametersIdstringOptional

ID of the parameters used in workflow

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

Responses

200

Workflow has been run

application/json

idstring · uuidRequired

ID of the Workflow

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

caseIdstringRequired

ID of the Case

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

statusstring · enumRequired

Status of the workflow

Possible values:

404

Workflow Definition Not Found

application/json

post

/workflows/run

HTTPcURLJavaScriptPython

POST /workflows/run HTTP/1.1
Host: api.transactionlink.io
Content-Type: application/json
Accept: */*
Content-Length: 165

{
  "caseId": "11111111-2222-3333-4444-555555555555",
  "workflowDefinitionId": "3b2d8a4f-579f-4e2e-a51c-f859e532fe8c",
  "parametersId": "4b6ffcb6-ab6d-44b9-b5ab-4b5147b0b302"
}

application/jsonapplication/json;version=2

{
  "id": "e1413f5b-acb0-4995-919a-3fc60c9592c5",
  "caseId": "c3faa0ef-e83a-41e8-b178-9fd8e4b0ee81",
  "status": "COMPLETED"
}

Get Workflow Result

get

Retrieve the result of a workflow

Path parameters

workflowIdstring · uuidRequired

Workflow identifier

Responses

200

Returns the workflow result

application/json

createdDatestringRequired

Creation time

caseIdstringRequired

Case Id

partyIdstringRequired

Case id

404

Workflow not found

application/json

get

/workflows/{workflowId}/result

HTTPcURLJavaScriptPython

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

{
  "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"
      }
    ]
  }
}

Check Workflow Status

get

Check the status of a workflow

Path parameters

workflowIdstring · uuidRequired

Workflow identifier

Responses

200

Returns the Workflow Status

application/json

idstring · uuidRequired

ID of the Workflow

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

caseIdstringRequired

ID of the Case

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

statusstring · enumRequired

Status of the workflow

Possible values:

404

Workflow not found

application/json

get

/workflows/{workflowId}

HTTPcURLJavaScriptPython

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

{
  "id": "e1413f5b-acb0-4995-919a-3fc60c9592c5",
  "caseId": "c3faa0ef-e83a-41e8-b178-9fd8e4b0ee81",
  "status": "COMPLETED"
}