Running Workflow

The Workflows API enables the initiation of workflows that do not involve integrations requiring interaction with the end user, such as scanning documents or completing forms. All necessary data for the execution of the process can be provided through input parameters.

Flow overview

Steps

Create Case

The initial step is to create a case, which represents an individual who will go through the workflow.

During case creation, you can provide additional data such as first name, last name, number, or company name. These details can be utilized when executing tasks in the workflow. This step must be carried out on your backend server.

Please ensure that you create a Case for every new end user, as it acts as their representation within the system. For returning users, you can utilize the previously created Case to streamline the process.

Create case

Create a case with provided data

POSThttps://api.transactionlink.io/cases

Body

application/json

firstNamestring

First name

lastNamestring

Last name

personalNumberstring

Personal Number

emailstring

Email

phoneobject

Phone

companyNamestring

Comapny name

companyNumberstring

Company number

companyAddressstring

Company address

documentsarray of object

Response

201400

Case was created successfully

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/cases', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "firstName": "Jan",
      "lastName": "Nowak",
      "personalNumber": 17300211234,
      "email": "[e-mail]",
      "phone": {
        "countryCode": 48,
        "number": 666666666
      },
      "companyName": "Company name",
      "companyNumber": "Company number",
      "companyAddress": "Company address",
      "documents": [
        {
          "resourceId": "20fd5007-008d-447c-8378-6f81ea48fe65",
          "resourceName": "File name.pdf",
          "resourcePath": "resources/e1413f5b-acb0-4995-919a-3fc60c9592c5/20fd5007-008d-447c-8378-6f81ea48fe65/File name.pdf"
        },
        {
          "resourceId": "20fd5007-008d-447c-8378-6f81ea48fe65",
          "resourceName": "File name.pdf",
          "resourcePath": "resources/e1413f5b-acb0-4995-919a-3fc60c9592c5/20fd5007-008d-447c-8378-6f81ea48fe65/File name.pdf"
        }
      ]
    }),
});
const data = await response.json();

Response

201400

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

Create Parameters (optional)

The second step involves passing custom parameters to the workflow if the process requires it. Configuration of this should be done from the dashboard.

Create parameters

Create a set of parameters for given workflow definition to use

POSThttps://api.transactionlink.io/parameters

Body

application/json

workflowDefinitionId*string

Id of the workflow definition

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

parameters*any

Response

201400404

Set of parameters for given workflow was created successfully

Body

application/json

parametersId*string

Id of the parameters set

Example: "c3faa0ef-e83a-41e8-b178-9fd8e4b0ee81"

workflowDefinitionId*string

Id of the workflow definition

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

parameters*any

Request

JavaScriptCurlPython

const response = await fetch('https://api.transactionlink.io/parameters', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "workflowDefinitionId": "3b2d8a4f-579f-4e2e-a51c-f859e532fe8c",
      "parameters": {
        "param0": 0,
        "param1": 1.2222,
        "param2": true,
        "param3": "text"
      }
    }),
});
const data = await response.json();

Response

201400404

{
  "parametersId": "c3faa0ef-e83a-41e8-b178-9fd8e4b0ee81",
  "workflowDefinitionId": "3b2d8a4f-579f-4e2e-a51c-f859e532fe8c",
  "parameters": {
    "param0": 0,
    "param1": 1.2222,
    "param2": true,
    "param3": "text"
  }
}

Run Workflow

Next, we can initiate the workflow by providing the workflowDefinitionId, caseId, and optional parametersId.

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

Check Workflow Status

The workflow result will only be available upon its completion. To check if the workflow has finished, one can implement long polling and periodically check its status through an API or receive a webhook with information about the completed process.

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 Workflow Result

Upon receiving confirmation that the workflow has finished, you can then fetch the result of the process. The specific outcome of the process is contingent upon its individual configuration.

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