Skip to main content
Automation API

Triggers

Use one of the nine trigger types to decide when an automation runs.

A trigger is a flat object { type, config }, and an automation has zero or one. GET /v1/automation/meta/trigger returns the full, current catalog with the config_schema of each type. Build against it instead of hard-coding.

Trigger types​

Label is the name that meta/trigger returns. Name in Tape is the name in the automation editor.

typeLabelName in TapeFires when …
record_createdRecord createdRecord createdA record is created in the app.
record_updatedRecord updatedRecord updatedA record is updated, optionally only when specific fields change.
record_deletedRecord deletedRecord deletedA record is deleted.
record_comment_or_reply_createdComment or reply createdComment addedA comment or reply is added to a record.
date_field_arrivedDate arrivedDate arrivesA date from a field is reached, optionally with an offset.
automation_calledAutomation calledAutomation callsAnother automation calls this one.
periodicPeriodicOn scheduleA recurring schedule is due.
webhook_receivedWebhook receivedWebhook receivedAn inbound webhook comes in.
weblink_clickedWeblink clickedWeb link clickedSomeone opens a generated weblink.
Trigger picker in the automation editor with the list of all nine triggers

Config​

This trigger fires only when the field with ID 512 changes:

Trigger
{ "type": "record_updated", "config": { "trigger_on_changes_field_ids": [512] } }

Each type has its own config shape, described by its config_schema. Values can be dynamic where the type allows it.

Which field changes fire record_updated?

trigger_on_changes_field_ids has three states:

  • null or left out: fires on a change to any field.
  • A list with field IDs: fires only on changes to those fields.
  • An empty []: never fires. validate reports trigger_updated_fields_empty.

app_id is not a config field. Tape takes the app from the automation itself and ignores a legacy config.app_id. See Create an automation.

Why does Tape reject a config field it returned?

Some config fields are set by Tape and read-only, for example the webhook_url of a webhook_received trigger. They appear when you read a config, and Tape rejects them on write. The config_schema marks them with "readOnly": true (standard JSON Schema), so remove them before you send a config.

What are the _enabled flags for?

Some config values only take effect when a boolean next to them, <field>_enabled, is true. The automation_called and weblink_clicked triggers pair triggering_app_ids with triggering_app_ids_enabled, and custom_variable_defs with custom_variable_defs_enabled.

A minimal {} config is accepted, because all members are optional. Send the paired _enabled flag whenever you set its value.

Set or remove a trigger​

Next steps​