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 selects which stopped runs a trigger matches. Empty asset_ids, absent name_match, and empty metadata_matches each match any value. Dimensions are AND'd. STARTS_WITH / ENDS_WITH / CONTAINS are case-insensitive; REGEX is Go regexp (add (?i) for case-insensitive).

actionKind
enum<string>
default:AUTOMATION_TRIGGER_ACTION_KIND_UNSPECIFIED
required

AutomationTriggerActionKind is what a trigger does when it fires. v1 is CANVAS_EVALUATION only.

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.

isEnabled
boolean
emailNotificationsEnabled
boolean

Defaults to true when unset.

notificationRecipientEmails
string[]

Defaults to the creating user's address when empty.

Response

A successful response.

The response of a call to AutomationService_CreateAutomationTrigger.

automationTrigger
object
required

AutomationTrigger is a Canvas Scheduler rule: match a stopped run, then dispatch (v1: EvaluateCanvas).