Skip to content

Create Workbench Bindings

POST
/workbench-bindings

Show a workflow’s outputs as columns on a list. FREE.

Requires WRITE access to the list. The columns appear on the list’s next column fetch; their values fill in when the workflow runs.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Bind a workflow’s outputs to columns on one list.

object
bindings
required

At least one. The app refuses an empty set; so does this.

Array<object>
>= 1 items

One workflow output rendered as one grid column.

object
column_name
required

Display name of the column.

string
column_type
required

How the grid treats the column.

string
Allowed values: computed ai enrichment state action review
config
Any of:
object
key
additional properties
any
display_mode

How the cell renders.

string
default: text
node_id
required

The workflow node whose output feeds the column.

string
output_path
required

Dot path into that node’s output.

string
sort_order

Position among the bound columns.

integer
list_id
required

The list whose grid gains the columns.

integer
workflow_id
required

The workflow producing the values.

string

Responses

201

Successful Response

object
data
required

A collection result.

items is ALWAYS present, so a caller can iterate without knowing whether the handler returned a bare list or a named key. When the handler used a named key that key is preserved beside items rather than renamed, because renaming it would make the API and the app disagree about the same data.

object
items

The collection, always present.

Array
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string