Skip to main content
The category the created automation gets.
String!
required
When the trigger fires.
String!
required
The merchant-facing trigger name.
Step kinds an insert operation on updateMarketingAutomation accepts for an automation with this trigger in this store. Any other kind returns STEP_NOT_INSERTABLE. START_AGENT_CONVERSATION is listed only while Commerce Agent is on.
String!
required
Pass as triggerKey to createMarketingAutomation.
required
JSON Schema for triggerData.predicate on this trigger, generated from the same Zod schema updateMarketingAutomation validates. Recover checkout predicates are left out.
Boolean!
required
If true, createMarketingAutomation requires eventName. Only custom_event.
String!
required
The trigger’s stored schema type, as schemaType on the trigger step. Decides which step kinds can be inserted.
The trigger an email or SMS template needs to be sent by this automation. A template with any other trigger returns TEMPLATE_TRIGGER_MISMATCH. UNKNOWN means no public template trigger exists for it.
Fields a triggerData predicate can match on this trigger, for condition steps, entry conditions, and skip conditions. A predicate on any other field returns INVALID_STEP_PATCH.
JSON Schema for triggerSpecificFields on the trigger step, generated from the same Zod schema updateMarketingAutomation validates. Null when the trigger has none; passing triggerSpecificFields then returns INVALID_STEP_PATCH.