Skip to main content
POST
CreateAutomationTrigger

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The request for a call to AutomationService_CreateAutomationTrigger.

The request for a call to AutomationService_CreateAutomationTrigger.

canvasId
string
required
name
string
required
matchFilter
object
required

AutomationTriggerMatchFilter is the selector evaluated asynchronously after StopRun. StopRun inserts an automation_source_event (RUN_STOP); the automation_worker then pages through the org's enabled, non-archived automation_triggers and enqueues a row for each trigger whose match_filter accepts the run (the trigger's canvas_id identifies which canvas to evaluate later — runs themselves have no canvas association). Empty asset_ids matches any asset; absent name_match matches any name. Name matching for STARTS_WITH / ENDS_WITH / CONTAINS is case-insensitive; REGEX uses Go regexp semantics (add (?i) for case-insensitive patterns).

actionKind
enum<string>
default:AUTOMATION_TRIGGER_ACTION_KIND_UNSPECIFIED
required

AutomationTriggerActionKind is what an automation trigger does when it fires. v1 supports AUTOMATION_TRIGGER_ACTION_KIND_CANVAS_EVALUATION only; the enum is kept so future dispatch types (webhook, email, ...) can be added without a breaking change.

Available options:
AUTOMATION_TRIGGER_ACTION_KIND_UNSPECIFIED,
AUTOMATION_TRIGGER_ACTION_KIND_CANVAS_EVALUATION
actionParams
object

AutomationTriggerActionParams is the public action_params shape. oneof by action kind so future dispatch types (webhook, email, ...) don't fall back to google.protobuf.Struct.

isEnabled
boolean

Response

A successful response.

The response of a call to AutomationService_CreateAutomationTrigger.

automationTrigger
object
required