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

post

/cases

Body

firstNamestring

First name

lastNamestring

Last name

personalNumberstring

Personal Number

emailstring

Email

companyNamestring

Comapny name

companyNumberstring

Company number

companyAddressstring

Company address

phoneobject

Phone

documentsobject[]

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.transactionlink.io/cases' \
  --header 'Content-Type: application/json' \
  --data '{"firstName":"Jan","lastName":"Nowak","personalNumber":17300211234,"email":"[e-mail]","companyName":"Company name","companyNumber":"Company number","companyAddress":"Company address","phone":{"countryCode":48,"number":666666666},"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"}]}'

201

400

201

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

Case was created successfully

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

post

/parameters

Body

workflowDefinitionIdstringrequired

Id of the workflow definition

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

parametersanyrequired

Example: {"param0":0,"param1":1.2222,"param2":true,"param3":"text"}

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.transactionlink.io/parameters' \
  --header 'Content-Type: application/json' \
  --data '{"workflowDefinitionId":"3b2d8a4f-579f-4e2e-a51c-f859e532fe8c","parameters":{"param0":0,"param1":1.2222,"param2":true,"param3":"text"}}'

201

400

404

201

{
  "workflowDefinitionId": "e1413f5b-acb0-4995-919a-3fc60c9592c5",
  "parametersId": "c3faa0ef-e83a-41e8-b178-9fd8e4b0ee81",
  "parameters": {
    "param1": "value1",
    "param2": true,
    "param3": "text"
  }
}

Set of parameters for given workflow was created successfully

Run Workflow

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

Run Workflow

Run Workflow

post

/workflows/run

Body

caseIdstring · uuidrequired

Case identifier for which we want to initiate the workflow

workflowDefinitionIdstringrequired

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.transactionlink.io/workflows/run' \
  --header 'Content-Type: application/json' \
  --data '{"caseId":"123e4567-e89b-12d3-a456-426614174000","workflowDefinitionId":"3b2d8a4f-579f-4e2e-a51c-f859e532fe8c","parametersId":"4b6ffcb6-ab6d-44b9-b5ab-4b5147b0b302"}'

200

404

200

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

Workflow has been run.

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

get

/workflows/{workflowId}

Path parameters

workflowIdstring · uuidrequired

Workflow Identifier

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.transactionlink.io/workflows/{workflowId}'

200

404

200

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

Return the Workflow Status.

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

get

/workflows/{workflowId}/result

Path parameters

workflowIdstring · uuidrequired

Workflow Identifier

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.transactionlink.io/workflows/{workflowId}/result'

200

404

200

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

Return the Workflow Result.