automation

Services

RPC methods exposed by this API.

AutomationService

AutomationService manages Canvas Scheduler triggers. A matching stopped run or a due SCHEDULE fire enqueues an AutomationTriggeredEvent; the worker dispatches it (v1: EvaluateCanvas).

Method	Request	Response	Description
GetAutomationTrigger	GetAutomationTriggerRequest	GetAutomationTriggerResponse	Retrieve an automation trigger by ID.
CreateAutomationTrigger	CreateAutomationTriggerRequest	CreateAutomationTriggerResponse	Create an automation trigger.
UpdateAutomationTrigger	UpdateAutomationTriggerRequest	UpdateAutomationTriggerResponse	Updates fields named in the update mask. Include `is_enabled` to enable or disable.
ListAutomationTriggers	ListAutomationTriggersRequest	ListAutomationTriggersResponse	Retrieve and optionally filter a list of automation triggers.
DeleteAutomationTrigger	DeleteAutomationTriggerRequest	DeleteAutomationTriggerResponse	Soft-deletes the trigger (sets `archived_date`). History rows stay.
ListAutomationTriggeredEvents	ListAutomationTriggeredEventsRequest	ListAutomationTriggeredEventsResponse	Lists dispatch history. Filter by `automation_trigger_id` or `state`. Match/config failures write one FAILED row per trigger; later repeats are logged only. Dispatch failures set `last_error` on that event.

Messages

Data models used across requests/responses.

AutomationTrigger

AutomationTrigger is a Canvas Scheduler rule: match a stopped run or fire on a cron cadence, then dispatch (v1: EvaluateCanvas).

Field	Type	Label	Description
automation_trigger_id	string
organization_id	string
canvas_id	string
name	string
match_filter	AutomationTriggerMatchFilter		Empty for SCHEDULE triggers (run match does not apply).
user_id	string		User the worker impersonates for EvaluateCanvas.
action_kind	AutomationTriggerActionKind
action_params	AutomationTriggerActionParams		Must match `action_kind`. Wildcards resolve at match time into the triggered event snapshot.
is_enabled	bool
archived_date	google.protobuf.Timestamp	optional
is_archived	bool
created_date	google.protobuf.Timestamp
modified_date	google.protobuf.Timestamp
created_by_user_id	string
modified_by_user_id	string
email_notifications_enabled	bool		If true, also emails `notification_recipient_emails`. The in-app notification to the creator is always created. Defaults to true.
notification_recipient_emails	string	repeated	Dispatch email recipients. Empty uses the creator’s address.
report_name_template	string	optional	Names the reports this automation publishes, overriding the canvas version’s template for its dispatches only. Unset means the canvas version’s template names them. When that is unset, the triggering run is used to name the reports.

Braces mark a placeholder. Supported placeholders are {canvas_name}, {version_number}, and {parameter.<param name>}. | | trigger_kind | AutomationTriggerKind | | Unspecified is treated as RUN_STOP. | | cron_expression | string | optional | 5-field Vixie cron (minute hour day-of-month month day-of-week). Required for SCHEDULE; unset for RUN_STOP. | | timezone | string | optional | IANA timezone for cron_expression (for example America/Los_Angeles). Required for SCHEDULE; unset for RUN_STOP. | | next_fire_at | google.protobuf.Timestamp | optional | Next UTC fire. Server-computed. Set on SCHEDULE only. | | last_fire_at | google.protobuf.Timestamp | optional | UTC fire most recently enqueued. Unset until the first TickDue. |

AutomationTriggerActionParams

AutomationTriggerActionParams is the public action_params shape, oneof by action kind.

Field	Type	Label	Description
oneof kind. canvas_evaluation	CanvasEvaluationActionParams

AutomationTriggerMatchFilter

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).

Field	Type	Label
asset_ids	string	repeated
name_match	AutomationTriggerRunNameMatch	optional
metadata_matches	AutomationTriggerMetadataMatch	repeated

AutomationTriggerMetadataMatch

AutomationTriggerMetadataMatch is an equality filter on run entity-metadata. Keys are case-sensitive; values compare as Go-stringified strings. Listed matches are AND’d.

Field	Type	Label	Description
key	string
value	string

AutomationTriggerParamValue

AutomationTriggerParamValue is one canvas param: a JSON literal or a run-scoped source.

Field	Type	Label	Description
oneof value. literal	google.protobuf.Value
oneof value. source	AutomationTriggerParamSource

AutomationTriggerRunNameMatch

AutomationTriggerRunNameMatch expresses a filter against runs.name.

Field	Type	Label	Description
kind	AutomationTriggerRunNameMatchKind
value	string

AutomationTriggeredEvent

AutomationTriggeredEvent is one (trigger, run) dispatch. canvas_execution_id and report_id are set when dispatch published an execution or report.

Field	Type	Label	Description
automation_triggered_event_id	string
organization_id	string
automation_trigger_id	string
run_id	string		Empty on SCHEDULE fires. Not proto3 optional: that would move field 4 into a oneof.
state	AutomationTriggeredEventState
dispatch_after	google.protobuf.Timestamp
canvas_execution_id	string	optional
attempt_count	int32
last_error	string	optional
terminal_date	google.protobuf.Timestamp	optional
created_date	google.protobuf.Timestamp
modified_date	google.protobuf.Timestamp
created_by_user_id	string
modified_by_user_id	string
report_id	string	optional	Published report for the dispatched execution. Unset when dispatch did not publish.
scheduled_for	google.protobuf.Timestamp	optional	Scheduled fire this row represents. Set on SCHEDULE only.

CanvasEvaluationActionParams

CanvasEvaluationActionParams is the CANVAS_EVALUATION template. Wildcards in param_json resolve into the triggered event’s action_params_snapshot for EvaluateCanvas.

Field	Type	Label	Description
canvas_version_id	string
param_json	CanvasEvaluationActionParams.ParamJsonEntry	repeated

CanvasEvaluationActionParams.ParamJsonEntry

Field	Type	Label	Description
key	string
value	AutomationTriggerParamValue

CreateAutomationTriggerRequest

The request for a call to AutomationService_CreateAutomationTrigger.

Field	Type	Label	Description
canvas_id	string
name	string
match_filter	AutomationTriggerMatchFilter
action_kind	AutomationTriggerActionKind
action_params	AutomationTriggerActionParams
is_enabled	bool	optional
email_notifications_enabled	bool	optional	Defaults to true when unset.
notification_recipient_emails	string	repeated	Defaults to the creating user’s address when empty.
report_name_template	string	optional	Names the reports this automation publishes, stored on the trigger. Omit it to let the server apply the run-aware default: when the trigger binds a triggering run and the canvas has no template of its own, the new trigger is given one naming its reports after that run. See `sift_internal.canvas.v1.Canvas.report_name_template` for the syntax.
trigger_kind	AutomationTriggerKind		Unspecified is treated as RUN_STOP.
cron_expression	string	optional	Required when trigger_kind is SCHEDULE.
timezone	string	optional	IANA timezone. Required when trigger_kind is SCHEDULE.

CreateAutomationTriggerResponse

The response of a call to AutomationService_CreateAutomationTrigger.

Field	Type	Label	Description
automation_trigger	AutomationTrigger

DeleteAutomationTriggerRequest

The request for a call to AutomationService_DeleteAutomationTrigger.

Field	Type	Label	Description
automation_trigger_id	string

DeleteAutomationTriggerResponse

The response of a call to AutomationService_DeleteAutomationTrigger. This message has no fields.

GetAutomationTriggerRequest

The request for a call to AutomationService_GetAutomationTrigger.

Field	Type	Label	Description
automation_trigger_id	string

GetAutomationTriggerResponse

The response of a call to AutomationService_GetAutomationTrigger.

Field	Type	Label	Description
automation_trigger	AutomationTrigger

ListAutomationTriggeredEventsRequest

The request for a call to AutomationService_ListAutomationTriggeredEvents.

Field	Type	Description
page_size	uint32
page_token	string
filter	string	CEL filter. Available fields: `automation_triggered_event_id`, `automation_trigger_id`, `automation_trigger_name`, `run_id`, `run_name`, `state`.
order_by	string	Order-by. Available fields: `created_date`, `dispatch_after`. Default: `created_date desc`.

ListAutomationTriggeredEventsResponse

The response of a call to AutomationService_ListAutomationTriggeredEvents.

Field	Type	Label	Description
automation_triggered_events	AutomationTriggeredEvent	repeated
next_page_token	string

ListAutomationTriggersRequest

The request for a call to AutomationService_ListAutomationTriggers.

Field	Type	Description
page_size	uint32
page_token	string
filter	string	CEL filter. Available fields: `automation_trigger_id`, `canvas_id`, `name`, `action_kind`, `trigger_kind`, `is_enabled`, `is_archived`, `archived_date`.
order_by	string	Order-by. Available fields: `created_date`, `modified_date`, `name`, `next_fire_at`. Default: `created_date desc`.

ListAutomationTriggersResponse

The response of a call to AutomationService_ListAutomationTriggers.

Field	Type	Label	Description
automation_triggers	AutomationTrigger	repeated
next_page_token	string

UpdateAutomationTriggerRequest

The request for a call to AutomationService_UpdateAutomationTrigger. Fields apply only when named in update_mask. Archive by setting archived_date in the mask; unarchive by clearing it.

Field	Type	Label	Description
automation_trigger	AutomationTrigger
update_mask	google.protobuf.FieldMask

UpdateAutomationTriggerResponse

The response of a call to AutomationService_UpdateAutomationTrigger.

Field	Type	Label	Description
automation_trigger	AutomationTrigger

Enums

Allowed constant values used in message fields.

AutomationTriggerActionKind

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

Name	Number	Description
AUTOMATION_TRIGGER_ACTION_KIND_UNSPECIFIED	0
AUTOMATION_TRIGGER_ACTION_KIND_CANVAS_EVALUATION	1

AutomationTriggerKind

AutomationTriggerKind is the source that causes a trigger to fire.

Name	Number	Description
AUTOMATION_TRIGGER_KIND_UNSPECIFIED	0
AUTOMATION_TRIGGER_KIND_RUN_STOP	1	Fire after a matching run stops.
AUTOMATION_TRIGGER_KIND_SCHEDULE	2	Fire on a recurring cron cadence in an IANA timezone.

Reserved. Create/Update reject this value. |

AutomationTriggerParamSource

AutomationTriggerParamSource is a wildcard resolved from the triggering run into action_params_snapshot.

Name	Number	Description
AUTOMATION_TRIGGER_PARAM_SOURCE_UNSPECIFIED	0
AUTOMATION_TRIGGER_PARAM_SOURCE_TRIGGERING_RUN	1	Resolves to the triggering run’s run_id (string).
AUTOMATION_TRIGGER_PARAM_SOURCE_TRIGGERING_RUN_ASSETS	2	Resolves to the triggering run’s asset_ids (string array).

AutomationTriggerRunNameMatchKind

AutomationTriggerRunNameMatchKind is the operator on runs.name in an automation trigger match filter.

Name	Number	Description
AUTOMATION_TRIGGER_RUN_NAME_MATCH_KIND_UNSPECIFIED	0
AUTOMATION_TRIGGER_RUN_NAME_MATCH_KIND_STARTS_WITH	1
AUTOMATION_TRIGGER_RUN_NAME_MATCH_KIND_ENDS_WITH	2
AUTOMATION_TRIGGER_RUN_NAME_MATCH_KIND_CONTAINS	3
AUTOMATION_TRIGGER_RUN_NAME_MATCH_KIND_REGEX	4

AutomationTriggeredEventState

AutomationTriggeredEventState is the lifecycle of one (trigger, run) dispatch. DISPATCHING and CANCELLED are reserved and unused.

Name	Number	Description
AUTOMATION_TRIGGERED_EVENT_STATE_UNSPECIFIED	0
AUTOMATION_TRIGGERED_EVENT_STATE_WAITING	1
AUTOMATION_TRIGGERED_EVENT_STATE_DISPATCHING	2
AUTOMATION_TRIGGERED_EVENT_STATE_DONE	3
AUTOMATION_TRIGGERED_EVENT_STATE_FAILED	4
AUTOMATION_TRIGGERED_EVENT_STATE_CANCELLED	5

Authenticate

Clients

Review

Export

Attachments

Reference

Services

AutomationService

Messages

AutomationTrigger

AutomationTriggerActionParams

AutomationTriggerMatchFilter

AutomationTriggerMetadataMatch

AutomationTriggerParamValue

AutomationTriggerRunNameMatch

AutomationTriggeredEvent

CanvasEvaluationActionParams

CanvasEvaluationActionParams.ParamJsonEntry

CreateAutomationTriggerRequest

CreateAutomationTriggerResponse

DeleteAutomationTriggerRequest

DeleteAutomationTriggerResponse

GetAutomationTriggerRequest

GetAutomationTriggerResponse

ListAutomationTriggeredEventsRequest

ListAutomationTriggeredEventsResponse

ListAutomationTriggersRequest

ListAutomationTriggersResponse

UpdateAutomationTriggerRequest

UpdateAutomationTriggerResponse

Enums

AutomationTriggerActionKind

AutomationTriggerKind

AutomationTriggerParamSource

AutomationTriggerRunNameMatchKind

AutomationTriggeredEventState

​Services

​AutomationService

​Messages

​AutomationTrigger

​AutomationTriggerActionParams

​AutomationTriggerMatchFilter

​AutomationTriggerMetadataMatch

​AutomationTriggerParamValue

​AutomationTriggerRunNameMatch

​AutomationTriggeredEvent

​CanvasEvaluationActionParams

​CanvasEvaluationActionParams.ParamJsonEntry

​CreateAutomationTriggerRequest

​CreateAutomationTriggerResponse

​DeleteAutomationTriggerRequest

​DeleteAutomationTriggerResponse

​GetAutomationTriggerRequest

​GetAutomationTriggerResponse

​ListAutomationTriggeredEventsRequest

​ListAutomationTriggeredEventsResponse

​ListAutomationTriggersRequest

​ListAutomationTriggersResponse

​UpdateAutomationTriggerRequest

​UpdateAutomationTriggerResponse

​Enums

​AutomationTriggerActionKind

​AutomationTriggerKind

​AutomationTriggerParamSource

​AutomationTriggerRunNameMatchKind

​AutomationTriggeredEventState

Services

AutomationService

Messages

AutomationTrigger

AutomationTriggerActionParams

AutomationTriggerMatchFilter

AutomationTriggerMetadataMatch

AutomationTriggerParamValue

AutomationTriggerRunNameMatch

AutomationTriggeredEvent

CanvasEvaluationActionParams

CanvasEvaluationActionParams.ParamJsonEntry

CreateAutomationTriggerRequest

CreateAutomationTriggerResponse

DeleteAutomationTriggerRequest

DeleteAutomationTriggerResponse

GetAutomationTriggerRequest

GetAutomationTriggerResponse

ListAutomationTriggeredEventsRequest

ListAutomationTriggeredEventsResponse

ListAutomationTriggersRequest

ListAutomationTriggersResponse

UpdateAutomationTriggerRequest

UpdateAutomationTriggerResponse

Enums

AutomationTriggerActionKind

AutomationTriggerKind

AutomationTriggerParamSource

AutomationTriggerRunNameMatchKind

AutomationTriggeredEventState