Skip to main content

EventToEmailConfig

Event action configuration for email automation.

Defines automated email sending based on templates when system events occur. Includes template references and recipient settings for reliable email delivery.

type EventToEmailConfig implements IEventActionConfig {
id: String!
trigger: EventTrigger!
code: String
createdAt: DateTime!
lastModifiedAt: DateTime!
createdBy: Int
lastModifiedBy: Int
names(
language: String
): [LocalizedString!]!
emailTemplateId: String!
}

Fields

EventToEmailConfig.id ● String! non-null scalar

Unique identifier for the event action configuration.

Uses UUID v7 format for chronological ordering and global uniqueness across the system.

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

EventToEmailConfig.code ● String scalar

Custom event identifier for CUSTOM_EVENT triggers.

Required when trigger type is CUSTOM_EVENT. Used to match and execute specific configurations when custom events are triggered.

EventToEmailConfig.createdAt ● DateTime! non-null scalar

Timestamp when the event action configuration was initially created.

Provides audit trail information for tracking configuration lifecycle and changes.

EventToEmailConfig.lastModifiedAt ● DateTime! non-null scalar

Timestamp when the event action configuration was last updated.

Provides audit trail information for tracking recent changes and configuration history.

EventToEmailConfig.createdBy ● Int scalar

User identifier who created this event action configuration.

Provides audit trail information for tracking configuration ownership and accountability.

EventToEmailConfig.lastModifiedBy ● Int scalar

User identifier who last modified this event action configuration.

Provides audit trail information for tracking recent changes and accountability.

EventToEmailConfig.names ● [LocalizedString!]! non-null object

Localized display names for the event action configuration.

Provides human-readable names in multiple languages for user interface display and identification purposes.

EventToEmailConfig.names.language ● String scalar

Language code filter for localized content.

Filters localized string results to return only entries matching the specified language code. When omitted, returns all available language variants.

EventToEmailConfig.emailTemplateId ● String! non-null scalar

Reference to the email template for message content.

Must be a valid UUID referencing an existing email template that defines the email structure, content, and formatting.

Interfaces

IEventActionConfig interface

Base interface for event action configurations.

Defines the common structure for all event action types including email and webhook configurations. Provides shared fields for identification, timing, and event triggering.

Returned By

eventToEmailConfigCreate mutation ● eventToEmailConfigUpdate mutation