Skip to main content

IEventActionConfig

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.

interface IEventActionConfig {
  id: String!
  trigger: EventTrigger!
  code: String
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  createdBy: Int
  lastModifiedBy: Int
  names(language: String): [LocalizedString!]!
  channelIds: [Int!]
}

Fields​

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

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

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

IEventActionConfig.createdAt ● DateTime! non-null scalar​

Timestamp when the event action configuration was initially created.

Provides audit trail information for tracking configuration lifecycle and changes.

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

IEventActionConfig.createdBy ● Int scalar​

User identifier who created this event action configuration.

Provides audit trail information for tracking configuration ownership and accountability.

IEventActionConfig.lastModifiedBy ● Int scalar​

User identifier who last modified this event action configuration.

Provides audit trail information for tracking recent changes and accountability.

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

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

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

Returned By​

eventActionConfig query

Member Of​

EventActionConfigResponse object

Implemented By​

EventToEmailConfig object ● EventToWebHookConfig object