Flows | Core API Reference | Product documentation

List Flows

get

List all process flows associated with your company profile.

Pagination

Pagination is available for this request. Please see the section on using pagination for more details.

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

latestVersion
latestVersion_count
latestVersionExists
latestVersion.variables
deployedVersion
deployedVersion_count
deployedVersionExists
deployedVersion.variables
currentVersion
currentVersion_count
currentVersionExists
currentVersion.latestRun
currentVersion.steps
currentVersion.steps.connector
currentVersion.steps.connector.authenticationImplementation
currentVersion.steps.connector.authenticationImplementation.system
currentVersion.steps.variables
currentVersion.steps.cache
currentVersion.steps.dataPool
currentVersion.steps.scriptVersion
currentVersion.steps.scriptVersion.script
currentVersion.schedules
currentVersion.variables
versions
versions_count
versionsExists
versions.schedules
versions.variables
versions.deployedByUser
labels
labels_count
labelsExists
webhooks
webhooks_count
webhooksExists
callbacks
callbacks_count
callbacksExists
notificationGroups
notificationGroups_count
notificationGroupsExists
messageBrokers
messageBrokers_count
messageBrokersExists
messageBrokerQueues
messageBrokerQueues_count
messageBrokerQueuesExists
deployments
deployments_count
deploymentsExists
deployments.virtualEnvironment
deployments.flowVersion
deployments.package
deployments.enabledBy

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

name
marketplace_app_id
labelled
enabled
deployed

Available Fields

These are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.

flows.id
flows.name
flows.enabled_at

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

name
enabled_at
created_at
id

Authorizations

AuthorizationstringRequired

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

Query parameters

filter[name]stringOptional

Filter results by name.

filter[marketplace_app_id]stringOptional

Filter results by marketplace_app_id.

filter[blueprint_id]stringOptional

Filter results by blueprint_id.

filter[blueprint_version_number]stringOptional

Filter results by blueprint_version_number.

filter[labelled]stringOptional

Filter results by label id.

filter[enabled]stringOptional

Filter results by enabled.

filter[deployed]stringOptional

Filter results by deployed.

filter[versions.id]stringOptional

Filter results by versions.id.

filter[,]stringOptional

Filter results by ,.

filter[versions]stringOptional

Filter results by versions.

filter[id]stringOptional

Filter results by id.

includestringOptional

Comma-separated list of relationships to include. Available: latestVersion, latestVersion.variables, deployedVersion, deployedVersion.variables, latestDeployedVersion, latestDeployedVersion.variables, latestDeployedVersion.steps.connector.authenticationImplementation.system, latestDeployedVersion.steps.connector.authenticationImplementation.system.endpoints, latestDeployedVersion.steps.connector.authenticationImplementation.system.endpoints.preScriptVersion, latestDeployedVersion.steps.connector.authenticationImplementation.system.endpoints.postScriptVersion, latestDeployedVersion.steps.connector.authenticationImplementation.system.endpoints.preScriptVersion.script, latestDeployedVersion.steps.connector.authenticationImplementation.system.endpoints.postScriptVersion.script, latestDeployedVersion.steps.scriptVersion.script, latestDeployedVersion.steps.cache, latestDeployedVersion.steps.dataPool, deployedVersion.steps.connector.authenticationImplementation.system, deployedVersion.steps.connector.authenticationImplementation.system.endpoints, deployedVersion.steps.connector.authenticationImplementation.system.endpoints.preScriptVersion, deployedVersion.steps.connector.authenticationImplementation.system.endpoints.postScriptVersion, deployedVersion.steps.connector.authenticationImplementation.system.endpoints.preScriptVersion.script

sortstringOptional

Sort field. Prefix with - for descending. Available: name, enabled_at, created_at, id

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/flows

GET /api/v1/flows HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "is_enabled": false,
      "enabled_at": null,
      "layout_direction": "TB",
      "use_queued_time": false,
      "remove_failed_payloads": false,
      "priority": 0,
      "prod_flag": false,
      "labels": [],
      "notification_group_ids": [],
      "webhooks": [],
      "callbacks": [],
      "message_brokers": [],
      "message_broker_queues": [],
      "created_at": "2024-01-01T00:00:00.000000Z",
      "updated_at": "2024-01-01T00:00:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://core.wearepatchworks.com/api/v1/flows",
    "per_page": 15,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://core.wearepatchworks.com/api/v1/flows?page=1",
    "last": "https://core.wearepatchworks.com/api/v1/flows?page=1",
    "prev": null,
    "next": null
  }
}

Create Flow

post

Create a new process flow.

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

flow.name

string

☑

flow.description

string

flow.prod_flag

☑

Authorizations

AuthorizationstringRequired

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

Body

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flows

POST /api/v1/flows HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "flow": {
    "name": "string",
    "description": "string",
    "prod_flag": false
  }
}

{
  "data": {
    "id": 0,
    "name": "string",
    "description": "string",
    "is_enabled": false,
    "enabled_at": null,
    "layout_direction": "TB",
    "use_queued_time": false,
    "remove_failed_payloads": false,
    "priority": 0,
    "prod_flag": false,
    "labels": [],
    "notification_group_ids": [],
    "webhooks": [],
    "callbacks": [],
    "message_brokers": [],
    "message_broker_queues": [],
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z"
  }
}

Get Flow

get

Retrieves details for a single process flow by the flow id.

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

latestVersion
latestVersion_count
latestVersionExists
latestVersion.variables
deployedVersion
deployedVersion_count
deployedVersionExists
deployedVersion.variables
currentVersion
currentVersion_count
currentVersionExists
currentVersion.latestRun
currentVersion.steps
currentVersion.steps.connector
currentVersion.steps.connector.authenticationImplementation
currentVersion.steps.connector.authenticationImplementation.system
currentVersion.steps.variables
currentVersion.steps.cache
currentVersion.steps.dataPool
currentVersion.steps.scriptVersion
currentVersion.steps.scriptVersion.script
currentVersion.schedules
currentVersion.variables
versions
versions_count
versionsExists
versions.schedules
versions.variables
versions.deployedByUser
labels
labels_count
labelsExists
webhooks
webhooks_count
webhooksExists
callbacks
callbacks_count
callbacksExists
notificationGroups
notificationGroups_count
notificationGroupsExists
messageBrokers
messageBrokers_count
messageBrokersExists
messageBrokerQueues
messageBrokerQueues_count
messageBrokerQueuesExists
deployments
deployments_count
deploymentsExists
deployments.virtualEnvironment
deployments.flowVersion
deployments.package
deployments.enabledBy

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

name
marketplace_app_id
labelled
enabled
deployed

Available Fields

These are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.

flows.id
flows.name
flows.enabled_at

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

name
enabled_at
created_at
id

Authorizations

AuthorizationstringRequired

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

Path parameters

flowstringRequired

The flow identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

filter[marketplace_app_id]stringOptional

Filter results by marketplace_app_id.

filter[blueprint_id]stringOptional

Filter results by blueprint_id.

filter[blueprint_version_number]stringOptional

Filter results by blueprint_version_number.

filter[labelled]stringOptional

Filter results by label id.

filter[enabled]stringOptional

Filter results by enabled.

filter[deployed]stringOptional

Filter results by deployed.

filter[versions.id]stringOptional

Filter results by versions.id.

filter[,]stringOptional

Filter results by ,.

filter[versions]stringOptional

Filter results by versions.

filter[id]stringOptional

Filter results by id.

includestringOptional

Comma-separated list of relationships to include. Available: latestVersion, latestVersion.variables, deployedVersion, deployedVersion.variables, latestDeployedVersion, latestDeployedVersion.variables, latestDeployedVersion.steps.connector.authenticationImplementation.system, latestDeployedVersion.steps.connector.authenticationImplementation.system.endpoints, latestDeployedVersion.steps.connector.authenticationImplementation.system.endpoints.preScriptVersion, latestDeployedVersion.steps.connector.authenticationImplementation.system.endpoints.postScriptVersion, latestDeployedVersion.steps.connector.authenticationImplementation.system.endpoints.preScriptVersion.script, latestDeployedVersion.steps.connector.authenticationImplementation.system.endpoints.postScriptVersion.script, latestDeployedVersion.steps.scriptVersion.script, latestDeployedVersion.steps.cache, latestDeployedVersion.steps.dataPool, deployedVersion.steps.connector.authenticationImplementation.system, deployedVersion.steps.connector.authenticationImplementation.system.endpoints, deployedVersion.steps.connector.authenticationImplementation.system.endpoints.preScriptVersion, deployedVersion.steps.connector.authenticationImplementation.system.endpoints.postScriptVersion, deployedVersion.steps.connector.authenticationImplementation.system.endpoints.preScriptVersion.script

sortstringOptional

Sort field. Prefix with - for descending. Available: name, enabled_at, created_at, id

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/flows/{flow}

GET /api/v1/flows/{flow} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 0,
    "name": "string",
    "description": "string",
    "is_enabled": false,
    "enabled_at": null,
    "layout_direction": "TB",
    "use_queued_time": false,
    "remove_failed_payloads": false,
    "priority": 0,
    "prod_flag": false,
    "labels": [],
    "notification_group_ids": [],
    "webhooks": [],
    "callbacks": [],
    "message_brokers": [],
    "message_broker_queues": [],
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z"
  }
}

Update Flow

put

Updates an existing process flow.

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

flow.name

string

flow.description

string

flow.enabled_at

labels

labels.*.id

☑

notification_groups

flow.use_queued_time

flow.remove_failed_payloads

flow.priority

integer

flow.prod_flag

Authorizations

AuthorizationstringRequired

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

Path parameters

flowstringRequired

The flow identifier.

Body

notification_groupsstringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/flows/{flow}

PUT /api/v1/flows/{flow} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 190

{
  "flow": {
    "name": "string",
    "description": "string",
    "enabled_at": null,
    "use_queued_time": false,
    "remove_failed_payloads": false,
    "priority": 0,
    "prod_flag": false
  },
  "labels": [],
  "notification_groups": []
}

{
  "data": {
    "id": 0,
    "name": "string",
    "description": "string",
    "is_enabled": false,
    "enabled_at": null,
    "layout_direction": "TB",
    "use_queued_time": false,
    "remove_failed_payloads": false,
    "priority": 0,
    "prod_flag": false,
    "labels": [],
    "notification_group_ids": [],
    "webhooks": [],
    "callbacks": [],
    "message_brokers": [],
    "message_broker_queues": [],
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z"
  }
}

Delete Flow

delete

Deletes a given process flow.

Authorizations

AuthorizationstringRequired

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

Path parameters

flowstringRequired

The flow identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/flows/{flow}

DELETE /api/v1/flows/{flow} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "string"
}

Export Flow

post

Export process flow as a JSON file.

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

flow_id

integer

☑

Authorizations

AuthorizationstringRequired

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

Body

flow_idintegerRequired

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flows/export

POST /api/v1/flows/export HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "flow_id": 0
}

{
  "metadata": {
    "company_name": "string",
    "flow_name": "string",
    "exported_at": "2024-01-01T00:00:00+00:00",
    "exported_by": "string",
    "flow_id": 0,
    "flow_version": 0,
    "import_summary": {
      "setup_required": {
        "connectors_needing_config": 0,
        "auth_implementations_needing_credentials": 0,
        "variables_needing_values": 0
      },
      "dependencies": [],
      "imported_resources": [],
      "next_steps": []
    }
  },
  "flow": {
    "id": 0,
    "name": "string",
    "description": "string",
    "is_enabled": false,
    "enabled_at": null,
    "layout_direction": "string",
    "use_queued_time": false,
    "remove_failed_payloads": false,
    "priority": 0,
    "prod_flag": false,
    "labels": [],
    "webhooks": [],
    "callbacks": [],
    "versions": []
  },
  "systems": [],
  "scripts": [],
  "dependencies": []
}

Import Flow

post

Import a previously exported process flow (from a JSON file).

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

flow

☑

metadata

☑

as_marketplace

Authorizations

AuthorizationstringRequired

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

Body

flowstringRequired

metadatastringRequired

as_marketplacestringOptional

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flows/import

POST /api/v1/flows/import HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "flow": "string",
  "metadata": "string",
  "as_marketplace": null
}

{
  "metadata": {
    "company_name": "string",
    "flow_name": "string",
    "exported_at": "2024-01-01T00:00:00+00:00",
    "exported_by": "string",
    "flow_id": 0,
    "flow_version": 0,
    "import_summary": {
      "setup_required": {
        "connectors_needing_config": 0,
        "auth_implementations_needing_credentials": 0,
        "variables_needing_values": 0
      },
      "dependencies": [],
      "imported_resources": [],
      "next_steps": []
    }
  },
  "flow": {
    "id": 0,
    "name": "string",
    "description": "string",
    "is_enabled": false,
    "enabled_at": null,
    "layout_direction": "string",
    "use_queued_time": false,
    "remove_failed_payloads": false,
    "priority": 0,
    "prod_flag": false,
    "labels": [],
    "webhooks": [],
    "callbacks": [],
    "versions": []
  },
  "systems": [],
  "scripts": [],
  "dependencies": []
}

Initialise Flow Manually

post

Initialise a process flow manually - the equivalent of using the initialise flow button on the canvas. The flow starts immediately (it is not added to a queue). You can make up to 10 requests to this endpoint per minute. If you are implementing an automated, programmtic integration with Patchworks with greater request volumes, consider using the Start Flow endpoint instead.

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

flow_id

integer

☑

version_id

integer

payload

string

☑

flow_variables

virtual_environment_id

integer

Authorizations

AuthorizationstringRequired

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

Path parameters

flow_idstringRequired

The unique identifier of the flow.

version_idstringRequired

The unique identifier of the version.

Body

flow_idintegerRequired

version_idintegerOptional

payloadstringRequired

flow_variablesstringOptional

virtual_environment_idintegerOptional

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flows/{flow_id}/manual/{version_id}

POST /api/v1/flows/{flow_id}/manual/{version_id} HTTP/1.1
Host: start.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "flow_id": 0,
  "version_id": 0,
  "payload": "string",
  "flow_variables": null,
  "virtual_environment_id": null
}

{
  "message": "string",
  "data": {
    "flow_run_id": "string"
  }
}

Start Flow

post

Intended for programmatic, system-to-system integrations, where flows are scheduled via the API. In this case, flow runs are added to a queue and picked up when concurrency is available.

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

flow_id

integer

☑

version_id

integer

payload

string

☑

flow_variables

virtual_environment_id

integer

Authorizations

AuthorizationstringRequired

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

Path parameters

flow_idstringRequired

The unique identifier of the flow.

version_idstringRequired

The unique identifier of the version.

Body

flow_idintegerRequired

version_idintegerOptional

payloadstringRequired

flow_variablesstringOptional

virtual_environment_idintegerOptional

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flows/{flow_id}/start/{version_id}

POST /api/v1/flows/{flow_id}/start/{version_id} HTTP/1.1
Host: start.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "flow_id": 0,
  "version_id": 0,
  "payload": "string",
  "flow_variables": null,
  "virtual_environment_id": null
}

{
  "message": "string",
  "data": {
    "scheduled_flow_id": "string"
  }
}

Duplicate Flow

post

Duplicates - i.e. clones - an existing process flow. This is the API equivalent of what happens when you use the duplicate option in the dashboard. The result is a new process flow in the same company, with the same name appended with an incremental number.

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

flow_version_id

☑

Authorizations

AuthorizationstringRequired

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

Path parameters

flowstringRequired

The flow identifier.

Body

flow_version_idstringRequired

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flows/{flow}/duplicate

POST /api/v1/flows/{flow}/duplicate HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "flow_version_id": "0"
}

{
  "data": {
    "id": 0,
    "name": "string",
    "description": "string",
    "is_enabled": false,
    "enabled_at": null,
    "layout_direction": "TB",
    "use_queued_time": false,
    "remove_failed_payloads": false,
    "priority": 0,
    "prod_flag": false,
    "labels": [],
    "notification_group_ids": [],
    "webhooks": [],
    "callbacks": [],
    "message_brokers": [],
    "message_broker_queues": [],
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z"
  }
}

Update Flow Layout Direction

patch

Toggles the canvas layout direction for a specific flow. If the flow is currently set to vertical then it switches to horizontal, and vice versa.

Authorizations

AuthorizationstringRequired

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

Path parameters

flowstringRequired

The flow identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

patch

/api/v1/flows/{flow}/layout-direction

PATCH /api/v1/flows/{flow}/layout-direction HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

hashtagList Flows

hashtagPagination

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Fields

hashtagAvailable Sorts

hashtagCreate Flow

hashtagValidation Rules

hashtagGet Flow

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Fields

hashtagAvailable Sorts

hashtagUpdate Flow

hashtagValidation Rules

hashtagDelete Flow

hashtagExport Flow

hashtagValidation Rules

hashtagImport Flow

hashtagValidation Rules

hashtagInitialise Flow Manually

hashtagValidation Rules

hashtagStart Flow

hashtagValidation Rules

hashtagDuplicate Flow

hashtagValidation Rules

hashtagUpdate Flow Layout Direction

List Flows

Pagination

Available Includes

Available Filters

Available Fields

Available Sorts

Create Flow

Validation Rules

Get Flow

Available Includes

Available Filters

Available Fields

Available Sorts

Update Flow

Validation Rules

Delete Flow

Export Flow

Validation Rules

Import Flow

Validation Rules

Initialise Flow Manually

Validation Rules

Start Flow

Validation Rules

Duplicate Flow

Validation Rules

Update Flow Layout Direction