Skip to content

Create Workbench Trigger

POST
/workbench/tables/{table_id}/triggers

React to rows as they arrive or change. CAN ARM ONGOING SPEND.

enabled DEFAULTS TO TRUE. With action_type: run_ai, every matching row is enriched, and charged, as it arrives. webhook_notify URLs are checked and unsafe targets refused.

Authorizations

Parameters

Path Parameters

table_id
required

Workbench table id (UUID).

string

Workbench table id (UUID).

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

React to rows as they arrive or change.

action_type: run_ai enriches, and charges for, every matching row. webhook_notify posts to a URL you give in action_config.

object
action_config
object
key
additional properties
any
action_type
required
string
Allowed values: run_ai run_formula export webhook_notify
conditions
Any of:
object
key
additional properties
any
enabled
boolean
default: true
event_type
required
string
Allowed values: ingest ai_complete status_change
name
required
string
>= 1 characters <= 255 characters

Responses

201

Successful Response

object
data
required

One enrichment object, open-shaped.

Open on purpose: a workbench column set is defined by the CUSTOMER at runtime, and the enrichment result shapes grow with every provider added. Pinning them would drop whatever a provider returned that this contract had not caught up on, which on an enrichment surface is the data the customer paid for.

object
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