Workflow Steps API Reference

#The Workflow Step object

Models a node in the Linkbreakers workflow canvas, defining what should occur after a scan (redirects, gates, forms) and how it connects to other steps in the visitor journey.

canvasPosition

object

Canvas position for React Flow node positioning

childStepIds

array<string>

Child workflow step IDs (steps that this step can transition to, UUID)

createdAt

string (date-time)

When the workflow step was created

eventAction

string (enum)

This workflow step doesn't contain the redirection itself, because it's handled by the CLIENT_REDIRECT step itself.

Allowed values

EVENT_ACTION_UNSPECIFIED

Event action not specified

EVENT_ACTION_CLIENT_REDIRECT

Redirect visitors to a destination URL

EVENT_ACTION_QRCODE_SCAN

Entry step triggered when the QR code is scanned.

EVENT_ACTION_PASSWORD_VERIFY

Require visitors to enter a password before proceeding

EVENT_ACTION_FORM_SUBMIT

Present a data collection form to visitors

string

The unique identifier of the workflow step (UUID)

kind

string (enum)

The kind of workflow step (entry, exit, etc.) - read-only, determined by server

Allowed values

KIND_UNSPECIFIED

Workflow step kind not specified

KIND_ENTRY

Entry steps are automatically triggered when a visitor reaches the workflow

KIND_EXIT

Exit steps finalize the workflow (commonly a redirect)

KIND_INTERACTIVE

Interactive steps require visitor input (forms, passwords, etc.)

linkId

string

The link ID this workflow step belongs to (UUID)

parentStepIds

array<string>

Parent workflow step IDs (steps that can transition into this step, UUID)

payload

object

Workflow step payload - uses oneof for type safety based on EventAction

updatedAt

string (date-time)

When the workflow step was last updated

Learn more

Learn more about workflows in Linkbreakers

Example object

{
  "canvasPosition": {
    "x": 0,
    "y": 0
  },
  "childStepIds": [
    "string"
  ],
  "createdAt": "2025-10-29T07:55:34.518Z",
  "eventAction": "EVENT_ACTION_CLIENT_REDIRECT",
  "id": "a5f7b184-9d74-4f2a-9ed9-8f6a98cb12f4",
  "kind": "KIND_INTERACTIVE",
  "linkId": "123e4567-e89b-12d3-a456-426614174000",
  "parentStepIds": [
    "string"
  ],
  "payload": {
    "clientRedirect": {
      "conversionTracking": true,
      "destination": "https://brand.example.com/checkout"
    },
    "form": {
      "formDescription": "string",
      "formFields": [
        {}
      ],
      "formTitle": "string",
      "skipForm": false,
      "submitButtonText": "string"
    },
    "password": {
      "description": "string",
      "password": "string",
      "title": "string"
    },
    "qrcodeScan": {}
  },
  "updatedAt": "2025-10-29T07:55:34.518Z"
}

GET/v1/links/{linkId}/workflow-stepsRequires auth

#List workflow steps for a link

Retrieves all workflow steps for a specific link

#Parameters

path parameters

linkId

stringRequiredpath

The ID of the link to list workflow steps for (UUID)

query parameters

pageSize

integer (int32)query

The maximum number of workflow steps to return (optional)

pageToken

stringquery

The token for retrieving the next page of results (optional)

#Response

200

Everything worked as expected.

nextPageToken

string

Cursor to fetch the next page of workflow steps

workflowSteps

array<object>

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/links/{linkId}/workflow-steps?pageSize={pageSize}&pageToken={pageToken}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "nextPageToken": "eyJzdGVwSWQiOiI5ODcifQ==",
  "workflowSteps": [
    {
      "canvasPosition": {
        "x": 0,
        "y": 0
      },
      "childStepIds": [
        "string"
      ],
      "createdAt": "2025-10-29T07:55:34.517Z",
      "eventAction": "EVENT_ACTION_CLIENT_REDIRECT",
      "id": "a5f7b184-9d74-4f2a-9ed9-8f6a98cb12f4",
      "kind": "KIND_INTERACTIVE",
      "linkId": "123e4567-e89b-12d3-a456-426614174000",
      "parentStepIds": [
        "string"
      ],
      "payload": {
        "clientRedirect": {},
        "form": {},
        "password": {},
        "qrcodeScan": {}
      },
      "updatedAt": "2025-10-29T07:55:34.517Z"
    }
  ]
}

Base URL: https://api.linkbreakers.com

GET/v1/links/{linkId}/workflow-steps/{id}Requires auth

#Get workflow step details

Retrieves information about a specific workflow step.

#Parameters

path parameters

linkId

stringRequiredpath

The ID of the link (UUID)

stringRequiredpath

The ID of the workflow step to retrieve (UUID)

#Response

200

Everything worked as expected.

workflowStep

object

Models a node in the Linkbreakers workflow canvas, defining what should occur after a scan (redirects, gates, forms) and how it connects to other steps in the visitor journey.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/links/{linkId}/workflow-steps/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "workflowStep": {
    "canvasPosition": {
      "x": 0,
      "y": 0
    },
    "childStepIds": [
      "string"
    ],
    "createdAt": "2025-10-29T07:55:34.517Z",
    "eventAction": "EVENT_ACTION_CLIENT_REDIRECT",
    "id": "a5f7b184-9d74-4f2a-9ed9-8f6a98cb12f4",
    "kind": "KIND_INTERACTIVE",
    "linkId": "123e4567-e89b-12d3-a456-426614174000",
    "parentStepIds": [
      "string"
    ],
    "payload": {
      "clientRedirect": {
        "conversionTracking": true,
        "destination": "https://brand.example.com/checkout"
      },
      "form": {
        "formDescription": "string",
        "formFields": [],
        "formTitle": "string",
        "skipForm": false,
        "submitButtonText": "string"
      },
      "password": {
        "description": "string",
        "password": "string",
        "title": "string"
      },
      "qrcodeScan": {}
    },
    "updatedAt": "2025-10-29T07:55:34.517Z"
  }
}

Base URL: https://api.linkbreakers.com

POST/v1/links/{linkId}/workflow-stepsRequires auth

#Create a new workflow step

This endpoint allows users to create a new workflow step for a link. Workflow steps define the behavior of links, such as redirection destinations.

#Parameters

path parameters

linkId

stringRequiredpath

The ID of the link to create the workflow step for (UUID)

#Request body

canvasPosition

object

Canvas position for React Flow node positioning

eventAction

string (enum)

This workflow step doesn't contain the redirection itself, because it's handled by the CLIENT_REDIRECT step itself.

Allowed values

EVENT_ACTION_UNSPECIFIED

Event action not specified

EVENT_ACTION_CLIENT_REDIRECT

Redirect visitors to a destination URL

EVENT_ACTION_QRCODE_SCAN

Entry step triggered when the QR code is scanned.

EVENT_ACTION_PASSWORD_VERIFY

Require visitors to enter a password before proceeding

EVENT_ACTION_FORM_SUBMIT

Present a data collection form to visitors

string

Optional ID for the workflow step (UUID; if not provided, will be generated by backend)

payload

object

Workflow step payload - uses oneof for type safety based on EventAction

#Response

200

Everything worked as expected.

workflowStep

object

Models a node in the Linkbreakers workflow canvas, defining what should occur after a scan (redirects, gates, forms) and how it connects to other steps in the visitor journey.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X POST "https://api.linkbreakers.com/v1/links/{linkId}/workflow-steps" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"canvasPosition":{"x":0,"y":0},"eventAction":"EVENT_ACTION_FORM_SUBMIT","id":"987fcdeb-a321-45e6-b789-123456789012","payload":{"clientRedirect":{"conversionTracking":true,"destination":"https://brand.example.com/checkout"},"form":{"formDescription":"string","formFields":[{}],"formTitle":"string","skipForm":false,"submitButtonText":"string"},"password":{"description":"string","password":"string","title":"string"},"qrcodeScan":{}}}'

Sample payload (application/json)

{
  "canvasPosition": {
    "x": 0,
    "y": 0
  },
  "eventAction": "EVENT_ACTION_FORM_SUBMIT",
  "id": "987fcdeb-a321-45e6-b789-123456789012",
  "payload": {
    "clientRedirect": {
      "conversionTracking": true,
      "destination": "https://brand.example.com/checkout"
    },
    "form": {
      "formDescription": "string",
      "formFields": [
        {}
      ],
      "formTitle": "string",
      "skipForm": false,
      "submitButtonText": "string"
    },
    "password": {
      "description": "string",
      "password": "string",
      "title": "string"
    },
    "qrcodeScan": {}
  }
}

Typical response

{
  "workflowStep": {
    "canvasPosition": {
      "x": 0,
      "y": 0
    },
    "childStepIds": [
      "string"
    ],
    "createdAt": "2025-10-29T07:55:34.517Z",
    "eventAction": "EVENT_ACTION_CLIENT_REDIRECT",
    "id": "a5f7b184-9d74-4f2a-9ed9-8f6a98cb12f4",
    "kind": "KIND_INTERACTIVE",
    "linkId": "123e4567-e89b-12d3-a456-426614174000",
    "parentStepIds": [
      "string"
    ],
    "payload": {
      "clientRedirect": {
        "conversionTracking": true,
        "destination": "https://brand.example.com/checkout"
      },
      "form": {
        "formDescription": "string",
        "formFields": [],
        "formTitle": "string",
        "skipForm": false,
        "submitButtonText": "string"
      },
      "password": {
        "description": "string",
        "password": "string",
        "title": "string"
      },
      "qrcodeScan": {}
    },
    "updatedAt": "2025-10-29T07:55:34.517Z"
  }
}

Base URL: https://api.linkbreakers.com

POST/v1/links/{linkId}/workflow-steps/{parentStepId}/relationshipsRequires auth

#Add relationship between workflow steps

Creates a parent-child relationship between two workflow steps.

#Parameters

path parameters

linkId

stringRequiredpath

The ID of the link (UUID)

parentStepId

stringRequiredpath

The ID of the parent workflow step (UUID)

#Request body

childStepId

string

The ID of the child workflow step (UUID)

#Response

200

Everything worked as expected.

message

string

Confirmation message

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X POST "https://api.linkbreakers.com/v1/links/{linkId}/workflow-steps/{parentStepId}/relationships" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"childStepId":"456789ab-cdef-1234-5678-9abcdef01234"}'

Sample payload (application/json)

{
  "childStepId": "456789ab-cdef-1234-5678-9abcdef01234"
}

Typical response

{
  "message": "string"
}

Base URL: https://api.linkbreakers.com

PATCH/v1/links/{linkId}/workflow-steps/{id}Requires auth

#Update a workflow step

Updates an existing workflow step for a link.

#Parameters

path parameters

linkId

stringRequiredpath

The ID of the link (UUID)

stringRequiredpath

The ID of the workflow step to update (UUID)

#Request body

canvasPosition

object

Canvas position for React Flow node positioning

payload

object

Workflow step payload - uses oneof for type safety based on EventAction

#Response

200

Everything worked as expected.

workflowStep

object

Models a node in the Linkbreakers workflow canvas, defining what should occur after a scan (redirects, gates, forms) and how it connects to other steps in the visitor journey.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X PATCH "https://api.linkbreakers.com/v1/links/{linkId}/workflow-steps/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"canvasPosition":{"x":0,"y":0},"payload":{"clientRedirect":{"conversionTracking":true,"destination":"https://brand.example.com/checkout"},"form":{"formDescription":"string","formFields":[{}],"formTitle":"string","skipForm":false,"submitButtonText":"string"},"password":{"description":"string","password":"string","title":"string"},"qrcodeScan":{}}}'

Sample payload (application/json)

{
  "canvasPosition": {
    "x": 0,
    "y": 0
  },
  "payload": {
    "clientRedirect": {
      "conversionTracking": true,
      "destination": "https://brand.example.com/checkout"
    },
    "form": {
      "formDescription": "string",
      "formFields": [
        {}
      ],
      "formTitle": "string",
      "skipForm": false,
      "submitButtonText": "string"
    },
    "password": {
      "description": "string",
      "password": "string",
      "title": "string"
    },
    "qrcodeScan": {}
  }
}

Typical response

{
  "workflowStep": {
    "canvasPosition": {
      "x": 0,
      "y": 0
    },
    "childStepIds": [
      "string"
    ],
    "createdAt": "2025-10-29T07:55:34.518Z",
    "eventAction": "EVENT_ACTION_CLIENT_REDIRECT",
    "id": "a5f7b184-9d74-4f2a-9ed9-8f6a98cb12f4",
    "kind": "KIND_INTERACTIVE",
    "linkId": "123e4567-e89b-12d3-a456-426614174000",
    "parentStepIds": [
      "string"
    ],
    "payload": {
      "clientRedirect": {
        "conversionTracking": true,
        "destination": "https://brand.example.com/checkout"
      },
      "form": {
        "formDescription": "string",
        "formFields": [],
        "formTitle": "string",
        "skipForm": false,
        "submitButtonText": "string"
      },
      "password": {
        "description": "string",
        "password": "string",
        "title": "string"
      },
      "qrcodeScan": {}
    },
    "updatedAt": "2025-10-29T07:55:34.518Z"
  }
}

Base URL: https://api.linkbreakers.com

DELETE/v1/links/{linkId}/workflow-steps/{id}Requires auth

#Delete a workflow step

Removes a workflow step from the link. This operation cannot be undone.

#Parameters

path parameters

linkId

stringRequiredpath

The ID of the link (UUID)

stringRequiredpath

The ID of the workflow step to delete (UUID)

#Response

200

Everything worked as expected.

No structured schema available for this section.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X DELETE "https://api.linkbreakers.com/v1/links/{linkId}/workflow-steps/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{}

Base URL: https://api.linkbreakers.com

DELETE/v1/links/{linkId}/workflow-steps/{parentStepId}/relationships/{childStepId}Requires auth

#Remove relationship between workflow steps

Removes a parent-child relationship between two workflow steps.

#Parameters

path parameters

linkId

stringRequiredpath

The ID of the link (UUID)

parentStepId

stringRequiredpath

The ID of the parent workflow step (UUID)

childStepId

stringRequiredpath

The ID of the child workflow step (UUID)

#Response

200

Everything worked as expected.

message

string

Confirmation message

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X DELETE "https://api.linkbreakers.com/v1/links/{linkId}/workflow-steps/{parentStepId}/relationships/{childStepId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "message": "string"
}

Base URL: https://api.linkbreakers.com