Skip to main content
PUT
Declares what happens when new rows land in a dataset: invoke an action on

Authorizations

Authorization
string
header
required

An Erdo API key (erdo_api_...) or scoped token (erdo_token_...).

Body

application/json
after
string

for. Both are triggered by the same write, so without it they run at the same moment and neither can see the other's work. With it, a row is held until that declaration has recorded its result for the same row, and what it recorded arrives as this declaration's starting result — so an alert can say what a lookup found. A row is never held indefinitely: if the result has not landed within a few minutes, the row is acted on without it.

backfill
string

Without it a declaration only ever sees what arrives next, which is the right default — declaring one must not silently invoke a paid action once per historical row — but it leaves no way to say "and do the ones you got wrong". A declaration whose steps were mistaken is otherwise permanent: every row it already decided about is remembered as decided.

"all" means every row. A timestamp means every row at or after it. Both clear the record of what has been acted on, so the rows in range are taken through the steps again even though they have been through them before — which is the entire request.

dataset
string

including ones created later.

destination
Where to record what the steps returned. Omitting a destination entirely is · object

normal: a step that sends an email or files a ticket has done its work by running, and has nothing to store.

enabled
boolean

than pausing it, so declaring it again later starts from the rows arriving then instead of working through everything that accumulated in between.

key_column
string

this dataset upserts on. It is how a row being written a second time is recognised as the same row rather than a new one. Normally detected; set it when the dataset identifies a row unconventionally.

name
string

dataset can both alert a desk and enrich a record without either replacing the other. Lowercase letters, digits, hyphens and underscores.

on_update
string

written again: "skip" (the default) leaves it alone, and "act" takes it through the steps again. Default to skip unless a later write genuinely changes the answer — acting again invokes the actions again, and pays for them again.

steps
One step of a declaration. A step is EITHER an action to invoke (app and key) · object[]

once an earlier action has answered, and a script always runs. A step whose templated input resolves to nothing cannot be built for that row, so the next one is tried instead.

timestamp_column
string

detected; set it when the dataset names that column unconventionally.

Response

Success response

after
string
dataset
string
destination
Where to record what the steps returned. Omitting a destination entirely is · object

normal: a step that sends an email or files a ticket has done its work by running, and has nothing to store.

enabled
boolean
job_id
string

history can be inspected through the automation surfaces.

key_column
string
name
string
on_update
string
steps
One step of a declaration. A step is EITHER an action to invoke (app and key) · object[]
timestamp_column
string