marketingAutomationCatalog

Required scopes: marketing_automations_read

Returns

required

What this store can build: the triggers its automation builder offers and the step kinds each one can insert. Does not list templates, segments, or strategies; look those up by id. Condition-step expressions use the fields in segmentConditionCatalog.

Show fields

[MarketingAutomationCatalogStepKind!]!

required

Every step kind this API models field-by-field, including TRIGGER, which can be updated but not inserted.

Show fields

Boolean!

required

Whether a new step of this kind can be inserted. TRIGGER is false: an automation has exactly one.

MarketingAutomationStepKind!

required

The step kind, as kind on a read step.

String!

required

The input key that carries this step’s fields, such as sendEmail or wait.

[MarketingAutomationCatalogTrigger!]!

required

Every trigger createMarketingAutomation accepts for this store, the same list the automation builder offers. Triggers for products the store has not turned on, integrations it has not connected, and BigCommerce or CommentSold abandonment on a store without that platform are left out and return TRIGGER_NOT_AVAILABLE. date and price_drop are never listed because this API cannot create them. An existing automation whose trigger is no longer listed can still be edited.

Show fields

MarketingAutomationCategory!

required

The category the created automation gets.

String!

required

When the trigger fires.

String!

required

The merchant-facing trigger name.

[MarketingAutomationStepKind!]!

required

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.

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.

MarketingTrigger!

required

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.

Example

query {
  marketingAutomationCatalog
}

Getting Started

Reference

marketingAutomationCatalog

Returns

Example

​Returns

​Example

Returns

Example