Link

A single-use link with a specific workflow

Link is a preconfigured and hosted workflow that enables your customers to effortlessly complete a onboarding process within a matter of minutes by utilizing the provided link.

Each newly generated link causes the previous one to expire.

Generate link with the onboarding 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

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 the workflow

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

Responses

201

Link has been generated.

linkstringRequired

Generated link to the workflow.

Example: https://link.transactionlink.io/0df7e442-720c-4afb-8fed-c2664d6cb803

400

Request is invalid

application/json

404

Case or Record not found

application/json

post/link

POST /link 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"
}

{
  "link": "https://link.transactionlink.io/0df7e442-720c-4afb-8fed-c2664d6cb803"
}

Generate link with the onboarding 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

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 the workflow

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

Responses

201

Link has been generated.

linkstringRequired

Generated link to the workflow.

Example: https://link.transactionlink.io/0df7e442-720c-4afb-8fed-c2664d6cb803

400

Request is invalid

application/json

404

Case or Record not found

application/json

post/link/send

POST /link/send 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"
}

{
  "link": "https://link.transactionlink.io/0df7e442-720c-4afb-8fed-c2664d6cb803"
}

Delete link

delete

Delete link

Path parameters

caseIdstring · uuidRequired

UUID of the case to delete

Responses

204

Link has been deleted.

No content

404

Case not found

application/json

delete/link/{caseId}

DELETE /link/{caseId} HTTP/1.1
Host: api.transactionlink.io
Accept: */*

No content