Workflow Steps API Reference

#The Workflow Step object

WorkflowStep represents a workflow step in the system.

canvasPosition

object

childStepIds

array<string>

createdAt

string (date-time)

eventAction

string (enum)

Allowed values

EVENT_ACTION_UNSPECIFIED

EVENT_ACTION_CLIENT_REDIRECT

EVENT_ACTION_QRCODE_SCAN

EVENT_ACTION_PASSWORD

EVENT_ACTION_FORM

string

kind

string (enum)

Allowed values

KIND_UNSPECIFIED

KIND_ENTRY

KIND_EXIT

KIND_INTERACTIVE

linkId

string

parentStepIds

array<string>

payload

object

updatedAt

string (date-time)

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

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

workflowSteps

array<object>

#Error response

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": "string",
  "workflowSteps": [
    {
      "canvasPosition": {
        "x": 0,
        "y": 0
      },
      "childStepIds": [
        "string"
      ],
      "createdAt": "2025-10-08T01:03:21.672Z",
      "eventAction": "EVENT_ACTION_UNSPECIFIED",
      "id": "string",
      "kind": "KIND_UNSPECIFIED",
      "linkId": "string",
      "parentStepIds": [
        "string"
      ],
      "payload": {
        "conversionTracking": false,
        "description": "string",
        "destination": "string",
        "formDescription": "string",
        "formFields": [],
        "formTitle": "string",
        "password": "string",
        "skipForm": false,
        "submitButtonText": "string",
        "title": "string"
      },
      "updatedAt": "2025-10-08T01:03:21.672Z"
    }
  ]
}

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

#Response

200

Everything worked as expected.

workflowStep

object

WorkflowStep represents a workflow step in the system.

#Error response

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-08T01:03:21.672Z",
    "eventAction": "EVENT_ACTION_UNSPECIFIED",
    "id": "string",
    "kind": "KIND_UNSPECIFIED",
    "linkId": "string",
    "parentStepIds": [
      "string"
    ],
    "payload": {
      "conversionTracking": false,
      "description": "string",
      "destination": "string",
      "formDescription": "string",
      "formFields": [
        {}
      ],
      "formTitle": "string",
      "password": "string",
      "skipForm": false,
      "submitButtonText": "string",
      "title": "string"
    },
    "updatedAt": "2025-10-08T01:03:21.672Z"
  }
}

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

#Request body

canvasPosition

object

eventAction

string (enum)

Allowed values

EVENT_ACTION_UNSPECIFIED

EVENT_ACTION_CLIENT_REDIRECT

EVENT_ACTION_QRCODE_SCAN

EVENT_ACTION_PASSWORD

EVENT_ACTION_FORM

string

payload

object

#Response

200

Everything worked as expected.

workflowStep

object

WorkflowStep represents a workflow step in the system.

#Error response

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_UNSPECIFIED","id":"987fcdeb-a321-45e6-b789-123456789012","payload":{"conversionTracking":false,"description":"string","destination":"string","formDescription":"string","formFields":[{"defaultValue":"string","helpText":"string","id":"string","key":"string","label":"string","options":[],"order":0,"placeholder":"string","required":false,"type":"FORM_FIELD_TYPE_UNSPECIFIED","validationPattern":"string"}],"formTitle":"string","password":"string","skipForm":false,"submitButtonText":"string","title":"string"}}'

Sample payload (application/json)

{
  "canvasPosition": {
    "x": 0,
    "y": 0
  },
  "eventAction": "EVENT_ACTION_UNSPECIFIED",
  "id": "987fcdeb-a321-45e6-b789-123456789012",
  "payload": {
    "conversionTracking": false,
    "description": "string",
    "destination": "string",
    "formDescription": "string",
    "formFields": [
      {
        "defaultValue": "string",
        "helpText": "string",
        "id": "string",
        "key": "string",
        "label": "string",
        "options": [],
        "order": 0,
        "placeholder": "string",
        "required": false,
        "type": "FORM_FIELD_TYPE_UNSPECIFIED",
        "validationPattern": "string"
      }
    ],
    "formTitle": "string",
    "password": "string",
    "skipForm": false,
    "submitButtonText": "string",
    "title": "string"
  }
}

Typical response

{
  "workflowStep": {
    "canvasPosition": {
      "x": 0,
      "y": 0
    },
    "childStepIds": [
      "string"
    ],
    "createdAt": "2025-10-08T01:03:21.672Z",
    "eventAction": "EVENT_ACTION_UNSPECIFIED",
    "id": "string",
    "kind": "KIND_UNSPECIFIED",
    "linkId": "string",
    "parentStepIds": [
      "string"
    ],
    "payload": {
      "conversionTracking": false,
      "description": "string",
      "destination": "string",
      "formDescription": "string",
      "formFields": [
        {}
      ],
      "formTitle": "string",
      "password": "string",
      "skipForm": false,
      "submitButtonText": "string",
      "title": "string"
    },
    "updatedAt": "2025-10-08T01:03:21.672Z"
  }
}

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

parentStepId

stringRequiredpath

#Request body

childStepId

string

#Response

200

Everything worked as expected.

message

string

#Error response

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

#Request body

canvasPosition

object

payload

object

#Response

200

Everything worked as expected.

workflowStep

object

WorkflowStep represents a workflow step in the system.

#Error response

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":{"conversionTracking":false,"description":"string","destination":"string","formDescription":"string","formFields":[{"defaultValue":"string","helpText":"string","id":"string","key":"string","label":"string","options":[],"order":0,"placeholder":"string","required":false,"type":"FORM_FIELD_TYPE_UNSPECIFIED","validationPattern":"string"}],"formTitle":"string","password":"string","skipForm":false,"submitButtonText":"string","title":"string"}}'

Sample payload (application/json)

{
  "canvasPosition": {
    "x": 0,
    "y": 0
  },
  "payload": {
    "conversionTracking": false,
    "description": "string",
    "destination": "string",
    "formDescription": "string",
    "formFields": [
      {
        "defaultValue": "string",
        "helpText": "string",
        "id": "string",
        "key": "string",
        "label": "string",
        "options": [],
        "order": 0,
        "placeholder": "string",
        "required": false,
        "type": "FORM_FIELD_TYPE_UNSPECIFIED",
        "validationPattern": "string"
      }
    ],
    "formTitle": "string",
    "password": "string",
    "skipForm": false,
    "submitButtonText": "string",
    "title": "string"
  }
}

Typical response

{
  "workflowStep": {
    "canvasPosition": {
      "x": 0,
      "y": 0
    },
    "childStepIds": [
      "string"
    ],
    "createdAt": "2025-10-08T01:03:21.673Z",
    "eventAction": "EVENT_ACTION_UNSPECIFIED",
    "id": "string",
    "kind": "KIND_UNSPECIFIED",
    "linkId": "string",
    "parentStepIds": [
      "string"
    ],
    "payload": {
      "conversionTracking": false,
      "description": "string",
      "destination": "string",
      "formDescription": "string",
      "formFields": [
        {}
      ],
      "formTitle": "string",
      "password": "string",
      "skipForm": false,
      "submitButtonText": "string",
      "title": "string"
    },
    "updatedAt": "2025-10-08T01:03:21.673Z"
  }
}

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

#Response

200

Everything worked as expected.

No structured schema available for this section.

#Error response

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

parentStepId

stringRequiredpath

childStepId

stringRequiredpath

#Response

200

Everything worked as expected.

message

string

#Error response

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