Skip to main content

EventToEmailConfigCreateInput

Input for creating email event action configurations.

Extends base event action creation with email-specific fields including template identification for automated email sending.

input EventToEmailConfigCreateInput {
  names: [LocalizedStringInput!]!
  trigger: EventTrigger!
  code: String
  channelIds: [Int!]
  isDefault: Boolean
  emailTemplateId: String!
}

Fields​

EventToEmailConfigCreateInput.names ● [LocalizedStringInput!]! non-null input​

Display names in multiple languages.

Must contain at least one localized name. Each language entry must be unique and properly validated.

EventToEmailConfigCreateInput.trigger ● EventTrigger! non-null enum​

System event that activates this action configuration.

Defines which event type will cause this automation to execute, enabling event-driven workflow processing.

EventToEmailConfigCreateInput.code ● String scalar​

Custom event code for CUSTOM_EVENT triggers.

Required when trigger is CUSTOM_EVENT. Maximum length of 64 characters. Used to identify which configurations to execute for custom events.

EventToEmailConfigCreateInput.channelIds ● [Int!] list scalar​

Array of channel identifiers for filtering event action configurations.

Used to restrict event action configurations to specific communication channels. When omitted, returns all channels.

EventToEmailConfigCreateInput.isDefault ● Boolean scalar​

Whether this configuration runs when an event of its trigger is not targeted at specific event actions.

When omitted, true. A non-default configuration only runs when a send targets it by ID (eventActionConfigIds on the order and quote trigger mutations); on every other trigger, false means it never runs. Cannot be null.

EventToEmailConfigCreateInput.emailTemplateId ● String! non-null scalar​

Email template identifier for message content.

Must be a valid UUID format referencing an existing email template in the system. The template defines the email content, subject, and formatting.

Member Of​

eventToEmailConfigCreate mutation