AutomationService

CreateAutomationTrigger

Create an automation trigger.

post/api/v1/automation-triggers

Request

  • Base URL: https://api.siftstack.com
  • URL: https://api.siftstack.com/api/v1/automation-triggers
  • Auth: HTTP bearer

Request body

canvasIdstring required
namestring required
actionKind'AUTOMATION_TRIGGER_ACTION_KIND_UNSPECIFIED' | 'AUTOMATION_TRIGGER_ACTION_KIND_CANVAS_EVALUATION' required

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

isEnabledboolean
emailNotificationsEnabledboolean

Defaults to true when unset.

notificationRecipientEmailsstring[]

Defaults to the creating user's address when empty.

reportNameTemplatestring

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.

triggerKind'AUTOMATION_TRIGGER_KIND_UNSPECIFIED' | 'AUTOMATION_TRIGGER_KIND_RUN_STOP' | 'AUTOMATION_TRIGGER_KIND_SCHEDULE'

AutomationTriggerKind is the source that causes a trigger to fire.

  • AUTOMATION_TRIGGER_KIND_RUN_STOP: Fire after a matching run stops.
  • AUTOMATION_TRIGGER_KIND_SCHEDULE: Fire on a recurring cron cadence in an IANA timezone.

Reserved. Create/Update reject this value.

cronExpressionstring

Required when trigger_kind is SCHEDULE.

timezonestring

IANA timezone. Required when trigger_kind is SCHEDULE.

Response

A successful response.

Changes

No recorded changes to this operation across all 1 revision of this API.