Services
RPC methods exposed by this API.AutomationService
AutomationService manages Canvas Scheduler automation triggers. An automation trigger fires when a producer (v1: RunService.StopRun) observes a Run whose metadata matches the trigger’s match filter; the resulting automation_triggered_events row is dispatched by the automation worker after a bounded wait, currently by calling CanvasService.EvaluateCanvas.Messages
Data models used across requests/responses.AutomationTrigger
AutomationTriggerActionParams
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.AutomationTriggerMatchFilter
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; empty metadata_matches matches any metadata. Dimensions are AND’d. Name matching for STARTS_WITH / ENDS_WITH / CONTAINS is case-insensitive; REGEX uses Go regexp semantics (add (?i) for case-insensitive patterns).AutomationTriggerMetadataMatch
AutomationTriggerMetadataMatch is an equality filter against a run’s entity-metadata key/value. Key names are case-sensitive. Values are compared as strings (numbers/booleans are stringified with Go’s default formatting). All listed matches are AND’d together.AutomationTriggerParamValue
AutomationTriggerParamValue is one canvas param: a JSON literal or a run-scoped wildcard source. Prefer this over ad-hoc{"source":"..."}
objects in a free-form Struct.
AutomationTriggerRunNameMatch
AutomationTriggerRunNameMatch expresses a filter against runs.name.AutomationTriggeredEvent
AutomationTriggeredEvent is one (automation_trigger, run) match. When dispatch succeeds,canvas_execution_id points at the resulting
canvas_executions row (and published report, when publish=true).
CanvasEvaluationActionParams
CanvasEvaluationActionParams is the typed template for AUTOMATION_TRIGGER_ACTION_KIND_CANVAS_EVALUATION. Wildcards in param_json are resolved into automation_triggered_events.action_params_snapshot; the automation worker pass-throughs that snapshot to EvaluateCanvas.CanvasEvaluationActionParams.ParamJsonEntry
CreateAutomationTriggerRequest
The request for a call toAutomationService_CreateAutomationTrigger.
CreateAutomationTriggerResponse
The response of a call toAutomationService_CreateAutomationTrigger.
DeleteAutomationTriggerRequest
The request for a call toAutomationService_DeleteAutomationTrigger.
Soft-deletes by setting archived_date.
DeleteAutomationTriggerResponse
The response of a call toAutomationService_DeleteAutomationTrigger.
This message has no fields.
GetAutomationTriggerRequest
The request for a call toAutomationService_GetAutomationTrigger.
GetAutomationTriggerResponse
The response of a call toAutomationService_GetAutomationTrigger.
ListAutomationTriggeredEventsRequest
The request for a call toAutomationService_ListAutomationTriggeredEvents.
ListAutomationTriggeredEventsResponse
The response of a call toAutomationService_ListAutomationTriggeredEvents.
ListAutomationTriggersRequest
The request for a call toAutomationService_ListAutomationTriggers.
ListAutomationTriggersResponse
The response of a call toAutomationService_ListAutomationTriggers.
UpdateAutomationTriggerRequest
The request for a call toAutomationService_UpdateAutomationTrigger.
The trigger’s automation_trigger_id is used to identify the row; every
other field is applied only when named in update_mask.
UpdateAutomationTriggerResponse
The response of a call toAutomationService_UpdateAutomationTrigger.
To archive a trigger, include archived_date in the mask and set the
field. To unarchive, include archived_date in the mask and clear it.
Enums
Allowed constant values used in message fields.AutomationTriggerActionKind
AutomationTriggerActionKind is what an automation trigger does when it fires. v1 supportsAUTOMATION_TRIGGER_ACTION_KIND_CANVAS_EVALUATION only; the
enum is kept so future dispatch types (webhook, email, …) can be added
without a breaking change.