Flow Version Steps

List Flow Version Steps

get

Retrieves a paginated list of all steps for a specific flow version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

includestringOptional

Comma-separated list of relationships to include. Available: flowVersion, endpoint, endpoint.system.logo, children, connector, filters, parentFlowStep, routes, variables, scriptVersion, scriptVersion.script, scriptVersion.content, cache, flow, notificationGroup

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get/api/v1/flow-versions/{flow_version}/steps

HTTPcURLJavaScriptPython

GET /api/v1/flow-versions/{flow_version}/steps HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 0,
      "flow_version_id": 0,
      "name": "string",
      "microservice": "string",
      "config": {},
      "parent_id": null,
      "parent_flow_step": null,
      "notification_group": null,
      "order": 0
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://core.wearepatchworks.com/api/v1/flow-versions/29/steps",
    "per_page": 15,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://core.wearepatchworks.com/api/v1/flow-versions/29/steps?page=1",
    "last": "https://core.wearepatchworks.com/api/v1/flow-versions/29/steps?page=1",
    "prev": null,
    "next": null
  }
}

Create Flow Version Step

post

Creates a new step for a flow version. Requires a name and microservice, and optionally accepts configuration, a parent step, and variables.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

Body

application/json

flow_version_idstringOptional

microservicestringRequired

configstringOptional

parent_idintegerOptional

variablesstringOptional

deployed_atstring · date-time · nullableOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post/api/v1/flow-versions/{flow_version}/steps

HTTPcURLJavaScriptPython

POST /api/v1/flow-versions/{flow_version}/steps HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "flow_version_id": 0,
  "name": "string",
  "microservice": "string",
  "config": {},
  "parent_id": null,
  "variables": null
}

ExamplesCreate connector step

{
  "data": {
    "id": 0,
    "flow_version_id": 0,
    "name": "string",
    "microservice": "string",
    "config": {},
    "parent_id": null,
    "parent_flow_step": null,
    "notification_group": null,
    "order": 0
  }
}

Get Flow Version Step

get

Retrieves the details of a specific step for a flow version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

stepstringRequired

The step identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get/api/v1/flow-versions/{flow_version}/steps/{step}

HTTPcURLJavaScriptPython

GET /api/v1/flow-versions/{flow_version}/steps/{step} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 0,
    "flow_version_id": 0,
    "name": "string",
    "microservice": "string",
    "config": {},
    "parent_id": null,
    "parent_flow_step": null,
    "notification_group": null,
    "order": 0
  }
}

Update Flow Version Step

put

Updates an existing step. Accepts name, microservice, configuration, parent step, and variable changes.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

stepstringRequired

The step identifier.

Body

application/json

flow_version_idstringOptional

microservicestringOptional

configstringOptional

parent_idintegerOptional

variablesstringOptional

deployed_atstring · date-time · nullableOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put/api/v1/flow-versions/{flow_version}/steps/{step}

HTTPcURLJavaScriptPython

PUT /api/v1/flow-versions/{flow_version}/steps/{step} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "name": "string",
  "microservice": "string",
  "config": {},
  "parent_id": null,
  "variables": null
}

ExamplesUpdate step config

{
  "data": {
    "id": 0,
    "flow_version_id": 0,
    "name": "string",
    "microservice": "string",
    "config": {},
    "parent_id": null,
    "parent_flow_step": null,
    "notification_group": null,
    "order": 0
  }
}

Delete Flow Version Step

delete

Permanently deletes a specific step from a flow version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

stepstringRequired

The step identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete/api/v1/flow-versions/{flow_version}/steps/{step}

HTTPcURLJavaScriptPython

DELETE /api/v1/flow-versions/{flow_version}/steps/{step} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "string"
}

Create Flow Version Step Children

post

Creates a new child step beneath a specified step, connected via a flow step route.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

stepstringRequired

The step identifier.

Body

application/json

microservicestringRequired

configstringOptional

flow_step_route_idintegerRequired

variablesstringOptional

deployed_atstring · date-time · nullableOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post/api/v1/flow-versions/{flow_version}/steps/{step}/children

HTTPcURLJavaScriptPython

POST /api/v1/flow-versions/{flow_version}/steps/{step}/children HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "name": "string",
  "microservice": "string",
  "config": {},
  "flow_step_route_id": null,
  "variables": null
}

ExamplesCreate script child step

{
  "data": {
    "id": 0,
    "flow_version_id": 0,
    "name": "string",
    "microservice": "string",
    "config": {},
    "parent_id": null,
    "parent_flow_step": null,
    "notification_group": null,
    "order": 0
  }
}

Create Flow Version Step Parent

post

Creates a new parent step above a specified step.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

stepstringRequired

The step identifier.

Body

application/json

microservicestringRequired

configstringOptional

deployed_atstring · date-time · nullableOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post/api/v1/flow-versions/{flow_version}/steps/{step}/parents

HTTPcURLJavaScriptPython

POST /api/v1/flow-versions/{flow_version}/steps/{step}/parents HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "name": "string",
  "microservice": "string",
  "config": {}
}

ExamplesCreate map parent step

{
  "data": {
    "id": 0,
    "flow_version_id": 0,
    "name": "string",
    "microservice": "string",
    "config": {},
    "parent_id": null,
    "parent_flow_step": null,
    "notification_group": null,
    "order": 0
  }
}