EventDefinitions
Manages event definitions within Salesforce Marketing Cloud. An event definition specifies a trigger, such as a form submission or API call, that initiates an automated process like a journey entry or data update. This table allows you to create, delete, and query event definitions to orchestrate customer experiences.
Table Specific Information
Select
Retrieve all event definitions:
SELECT * FROM EventDefinitions
Retrieve a specific event definition:
SELECT * FROM EventDefinitions WHERE Id = '9955614b-02e7-4147-91a2-3f5f5fe9d679'
Retrieve all event definitions which are running in a specific mode:
SELECT * FROM EventDefinitions WHERE Mode = 'Test'
Retrieve all event definitions which contain the specified quoted phrase in their names:
SELECT * FROM EventDefinitions WHERE CONTAINS (Name, 'Welcome Journey')
Insert
To create an event definition, you will need to specify at least the Name and Type column. DataExtensionId is also required. If you do not specify it, you must specify the Schema column.
INSERT INTO EventDefinitions (Type, Name, DataExtensionId, IsVisibleInPicker) VALUES ('Event', 'FirstEventDefinition', '74bc3342-eaca-e711-b98f-38eaa71427a1', true)
Delete
Event definitions may be deleted by providing the Id of the event definition and issuing a DELETE statement.
DELETE FROM EventDefinitions WHERE Id = 'f10efb9e-cb91-4fc9-be50-c20f00f7f255'
Columns
| Name | Type | ReadOnly | References | Filters | Description |
| Id [KEY] | String | True | = |
Specifies the unique identifier (Id) that represents the event definition in Salesforce Marketing Cloud. This system-generated value is used to reference the event definition in Journey Builder, Event Administration, and API operations. | |
| Type | String | False |
Defines the type of the event definition. The event type determines how the event is initiated and processed within Journey Builder. The allowed values are Event, ContactEvent, DateEvent, RestEvent. | ||
| Name | String | False | Contains |
Specifies the name that identifies the event definition in Marketing Cloud. This name appears in Event Administration and Journey Builder interfaces and helps users distinguish among available event sources. | |
| CreatedDate | Datetime | True |
Records the date and time when the event definition was created. This timestamp is automatically assigned and supports audit tracking and historical reporting. | ||
| CreatedBy | Integer | True |
Specifies the Id of the user who created the event definition. This reference enables audit traceability and assists administrators in reviewing ownership or activity history. | ||
| ModifiedDate | Datetime | True |
Records the most recent date and time when the event definition was updated. This value updates automatically whenever any configuration property is changed. | ||
| ModifiedBy | Integer | True |
Specifies the Id of the user who last modified the event definition. This field helps track configuration updates for governance and compliance auditing. | ||
| Mode | String | False | = |
Defines the operational mode that determines how the event definition runs. Mode settings affect whether events are triggered manually, by schedule, or through API calls. The allowed values are Production, Test. The default value is Production. | |
| EventDefinitionKey | String | False |
Specifies the external key that uniquely identifies the event definition in Salesforce Marketing Cloud. This key must be unique and cannot contain special characters. It provides a stable reference across environments and API integrations. | ||
| DataExtensionId | String | False |
Specifies the Id of the data extension that is associated with the event. When an event is fired through the API, the system writes event data to this data extension. This parameter is required when no schema is provided. | ||
| DataExtensionName | String | False |
Displays the read-only name of the data extension that is associated with the event. This value helps users verify which data extension is linked to a specific event definition. | ||
| Description | String | False |
Provides a summary that describes the purpose or behavior of the event definition. Including a meaningful description improves discoverability and documentation accuracy across business units. | ||
| Schema | String | False |
Specifies the schema information that defines the structure of event data. When no data extension Id is provided, this schema is used to create the corresponding data extension automatically. This property ensures that incoming event data conforms to the expected format. | ||
| SendableCustomObjectField | String | False |
Defines the field within the associated data extension that stores the subscriber key or email address. This value is required when defining a schema and enables message sends and contact association. | ||
| SendableSubscriberField | String | False |
Indicates the type of subscriber field that the event definition uses to identify recipients. This field is required when defining a schema to ensure proper linkage between contact records and event data. | ||
| Schedule | String | False |
Defines the scheduling information for an event-driven automation that runs daily according to the specified timing. When a schedule is configured, the system automatically creates a Fire Event activity in Automation Studio that triggers events from the associated data extension. | ||
| FilterDefinitionId | String | False |
Specifies the Id of the filter definition that applies to the event. Filter definitions allow targeted event processing by limiting the scope of contacts that qualify for triggering. | ||
| FilterDefinitionTemplate | String | False |
Specifies the template that is used to create or apply a filter definition for the event. Templates help standardize segmentation logic across event definitions. | ||
| IconUrl | String | False |
Specifies the URL of the icon that represents the event definition in Event Administration and the Journey Builder Canvas. The icon provides a visual cue that helps users recognize the event type quickly. | ||
| Arguments | String | False |
Contains filter criteria that define how the event data is evaluated before triggering. | ||
| Configuration | String | False |
Specifies additional configuration data for the event. | ||
| ConfigurationArguments | String | False |
Defines the set of arguments that configure how the event definition executes. These arguments can include dynamic parameters, mappings, or service endpoints used during event processing. | ||
| Metadata | String | False |
Contains optional metadata that describes the event and its configuration properties. This parameter is typically used for event types other than 'Event' to store descriptive or operational information that supplements the definition. | ||
| InteractionCount | Integer | False |
Records the total number of interactions that are associated with the event definition. This value provides insight into event usage and frequency within Journey Builder. | ||
| IsVisibleInPicker | Boolean | False |
A Boolean field that returns a value of 'true' when the event definition is visible in the Event Picker for use in Journey Builder configuration. It returns a value of 'false' when the event is hidden or reserved for system use. The default value is true. | ||
| Category | String | False |
Specifies the general category or classification of the event type. Categories help group events by function or source for easier discovery and filtering in administrative tools. The default value is event. | ||
| PublishedInteractionCount | Integer | False |
Records the number of published interactions that use the event definition. This value helps determine the event's adoption and deployment within live journeys. | ||
| AutomationId | String | False |
Specifies the Id of the automation that is linked to the event definition. This reference connects the event configuration to its corresponding Automation Studio workflow. |