Actions
Use actions to define what an automation does.
An automation's actions are an ordered list of steps: leaf steps (group: "action") and control-flow actions (group: "control_flow") that nest more actions.
The action object
| Property | Type | Description |
|---|---|---|
id | string | Opaque node ID. Optional on input, Tape creates one when you leave it out. Present on every read. |
type | string | The action type. See Action types. |
group | string | action or control_flow. Follows from type and is read-only. You can leave it out on input. |
custom_name | string | Optional label. Absent when not set. |
deactivate | boolean | Whether the step is skipped. Absent when not set. |
continue_on_error | boolean | Whether the run goes on when this step fails. Absent when not set. |
config | object | The step's settings, keyed as the action's config_schema describes. Required on every action you write through the API. An empty {} is valid for a step you haven't set up yet, unless the type's config_schema requires members, for example code for custom_code or exit_type for exit. Such a config and a missing config key return 400. Dynamic values inside use the reference model. |
(control-flow config) | For conditional and for_loop, config holds the branch and loop structure. See Control-flow actions. |
Write and read a config
config keys come from the action's config_schema on meta/action, but a written config doesn't read back byte for byte.
- Tape fills in defaults for missing members on read. A missing
match_conditionorattach_files_match_conditionreads back as an empty filter group ornull, missing required arrays (ref_collection_defs,field_assignments,call_arguments,http_call_headers,sorts) as[]. The exception isfield_assignmentsofrecord_create: left out, it stays out on read. An unchangedGET→PUTstill works, but don't compare write and read. field_assignmentsis a typed union per field type. It's the payload of every action that changes records (record_create,current_record_update,referenced_records_update,collected_records_update) and is told apart byfield_type. Themeta/actionschema describes its array items only loosely, so copy the filled assignments fromrecord_createorcurrent_record_update. An empty[]is accepted in every case and changes no field value.- A paired
_enabledflag controlslimit. Incollect_app_recordsandcollect_app_view_records,limitonly takes effect whenlimit_enabledistrue, so send both. Either way, a collect stops at the server maximum of 1000 records and cuts off the rest without an error when the automation runs. See Limits and throttling. The_enabledflags fortriggering_app_idsandcustom_variable_defsbelong to the trigger config, not the action config. - A condition inside
config, for example thematch_conditionof a collect or filter action, uses the same public filter tree as theconditionof aconditional: lower-caseoperator: "and" | "or"withrows. - Passing
config_schemachecks only the structure. A config that passes the schema is saved. Rules that depend on meaning show up later as broken-reason codes when you validate or activate. Examples: theapp_idofreferenced_records_updatemust be an app that the trigger app relates to, and a sort key must be scoped to the collection. - All config enum values are lower-case. Send them exactly as
meta/actionlists them, for examplehttp_call_type: "post",exit_type: "success",ref_collection_defs[].direction: "incoming",match_type: "all".
Stricter config shapes per type may follow. Read the keys from meta/action, and don't hard-code internal encodings.
Action types
There are 35 action types: 33 leaf actions (group: "action") and 2 control-flow actions (group: "control_flow").
- Each type's
configkeys come from itsconfig_schemaonGET /v1/automation/meta/action. - The labels and descriptions below follow that endpoint. The automation editor can name an action differently. Each action page gives its editor name.
- The families only help you read the list. An action's real grouping is its
groupfield.
Code & variables
| Action | What it does |
|---|---|
custom_code | Run code: runs custom code in the automation sandbox. |
custom_variable | Set variable: computes and stores a custom variable for later actions. |
Current record
| Action | What it does |
|---|---|
record_create | Create record: creates a record in a database app. |
current_record_update | Update record: updates the current record. |
current_record_delete | Delete record: deletes the current record. |
current_record_restore | Restore record: restores the current (soft-deleted) record. |
current_record_get_previous_revision | Get previous revision: loads the previous revision of the current record. |
current_record_comment_create | Add comment: adds a comment to the current record. |
current_record_comment_or_reply_reply_create | Add reply: adds a reply to the current comment or reply. |
current_record_comment_or_reply_delete | Delete comment or reply: deletes the current comment or reply. |
Record collections
| Action | What it does |
|---|---|
collect_app_records | Collect app records: collects records from a database app, optionally filtered. |
collect_app_view_records | Collect app view records: collects records from a view of a database app. |
collect_referenced_records | Collect referenced records: collects records referenced by the current record. |
collected_records_collect_referenced_records | Collect referenced records (from collection): collects records referenced by a starting record collection. |
filter_record_collection | Filter collection: filters a record collection. |
sort_record_collection | Sort collection: sorts a record collection. |
clear_record_collection | Clear collection: empties a record collection. |
collected_records_update | Update collected records: updates every record in a collection. |
referenced_records_update | Update referenced records: updates records referenced by the current record. |
collected_records_comment_create | Comment on collected records: adds a comment to every record in a collection. |
rollup_iterable_values | Roll up values: aggregates the values of an iterable (count, sum, average, …). |
Most of these actions work in pairs: one creates a collection, a later one uses it.
- A
collect_*action creates arecord_collection. - A later action uses it:
filter_record_collection,sort_record_collection,clear_record_collection, thecollected_records_*family, or theiterableof afor_loop. - The action that creates the collection must come first in the automation.
- The later action references the collection with an object,
{ "kind": "variable", "source": "action", "action_type": "record_collection", "app_id": … }. Tape resolves it to the nearest earlier action that creates such a collection. It never names that action'sid. - An action that uses a collection without a matching earlier action fails validation.
Automation calls & weblinks
| Action | What it does |
|---|---|
current_record_call_automation | Call automation: calls another automation with the current record. |
collected_records_call_automation | Call automation for collected records: calls another automation for every record in a collection. |
current_record_generate_automation_weblink | Generate weblink: generates a weblink that calls an automation with the current record. |
display_webpage | Display webpage: displays a webpage in a weblink flow. |
redirect_user | Redirect user: redirects the user to a URL in a weblink flow. |
The call and weblink actions reference a target automation by ID. The target must exist, be in the right database app and have the matching trigger. Otherwise the definition fails validation.
current_record_call_automationneeds a target withautomation_calledin the same database app as the trigger.collected_records_call_automationneeds a target withautomation_calledin the database app of itsrecord_collection. Withoutrecord_collection, validation reportsaction_invalidandaction_automation_invalid.current_record_generate_automation_weblinkneeds a target withweblink_clickedin the same database app as the trigger. The action itself runs with any trigger that has a record. See Trigger context.
A paused target is a valid reference, but a call to it creates no run. See Call an automation.
Email & documents
| Action | What it does |
|---|---|
send_email | Send email: sends an email. |
collected_records_send_email | Send email for collected records: sends an email for every record in a collection. |
create_pdf | Create PDF: renders an HTML template to a PDF file. |
HTTP requests
| Action | What it does |
|---|---|
http_call | HTTP request: makes an outbound HTTP request. |
authenticated_http_call | Authenticated HTTP request: makes an outbound HTTP request signed by an authentication provider. |
- Outbound requests have SSRF protection. Tape refuses hosts that resolve to private or internal addresses.
authenticated_http_callalso needs anauthentication_provider_id. The public API has no endpoint to create or list connections. An organization admin sets them up in Tape. You can define the action through the API, but without a valid provider ID, Tape skips it when the automation runs.
Flow control
| Action | What it does |
|---|---|
delay | Delay: pauses the automation for a fixed duration. |
exit | Exit: ends the automation run with success or failure. |
for_loop | For loop: runs nested actions for each item of an iterable. group: "control_flow". |
conditional | Condition: runs nested actions only when a condition holds. group: "control_flow". |
Trigger context
Some actions are only valid with a matching trigger. A wrong pairing fails validation with action_invalid, unless the row says otherwise.
| Action(s) | Requires trigger |
|---|---|
display_webpage | weblink_clicked |
redirect_user | weblink_clicked. Validation doesn't check this pairing. The editor offers the action only there. |
current_record_comment_or_reply_reply_create, current_record_comment_or_reply_delete | record_comment_or_reply_created |
current_record_* (update, delete, restore, get_previous_revision, comment_create, call_automation, generate_automation_weblink), collect_referenced_records | Any trigger with a record (not periodic or webhook_received without a record) |
referenced_records_update | Any trigger with a record. Validation doesn't check the trigger, only app_id: without it action_app_missing, without a relation to the trigger's database app action_app_invalid. Without a current record, Tape skips the action when the automation runs. |
Triggers with a record are record_created, record_updated, record_deleted, record_comment_or_reply_created, date_field_arrived, automation_called and weblink_clicked.
Control-flow actions
conditional and for_loop keep their whole structure inside config, like every other action. There are no top-level control-flow fields.
- Each branch or condition is switched on by presence. A member you leave out is off.
- A nested body is an array of actions in
action_rows.
conditional: config keys
| Key | Type | Description |
|---|---|---|
condition | filter group | null | The branch condition. null or left out means true in every case. |
action_rows | array of actions | The if/then branch. |
else_action_rows | array of actions | The else branch. Leave it out to switch it off. |
for_loop: config keys
| Key | Type | Description |
|---|---|---|
iterable | reference | The collection to loop over. The public name is iterable; the internal name is iterable_variable_def. |
action_rows | array of actions | The loop body. |
break_condition | filter group | null | Stops the loop when it matches. Leave it out to switch it off. |
continue_condition | filter group | null | Skips to the next item when it matches. Leave it out to switch it off. |
See conditional and for_loop for full config examples.
Coming from Podio
Find the Tape action for each step of a Podio flow or a Globiflow flow.
| Podio flow or Globiflow step | Tape action |
|---|---|
| Create item | record_create |
item.update, update item | current_record_update, referenced_records_update, collected_records_update |
comment.create, comment | current_record_comment_create |
| Send email | send_email |
| Wait | delay, 15, 30, 45 or 60 seconds |
| Call flow | current_record_call_automation |
Webhook call, octoblu.trigger | http_call |
| Generate PDF | create_pdf |
| Search items, loop | collect_app_records, for_loop |
task.create, status.create | No action. Use a checklist field instead of tasks. |