Event definition
Fields
| Field Name | Type | Display Name |
|---|---|---|
| EventDefinitionId | Int32 | Event definition id |
| Created | DateTime | Created |
| CreatedBy | String | Created by |
| CustomValues | Dictionary`2 | Custom values |
| Description | String | Description |
| EventName | String | Event name |
| IncludeInTracking | Boolean | Include in tracking |
| IsAutomaticCreate | Boolean | Is automatic create |
| IsInactive | Boolean | Is inactive |
| LastModified | DateTime | Last modified |
| LastModifiedBy | String | Last modified by |
| Location | String | Location |
| OrganizationId | Int32 | Organization id |
| SendEmail | Boolean | Send email |
| SendEmailDocumentId | Nullable`1 | Send email document id |
| TriggerConditionFields | String | Trigger condition fields (deprecated — always null in new records) |
| TriggerEntityName | String | Trigger entity name (deprecated — always null in new records) |
| TriggerEventName | String | Trigger event name (deprecated — always null in new records) |
As of March 2026, the trigger fields (TriggerEventName, TriggerEntityName, TriggerConditionFields) have been removed from the application-layer create/update commands. New event definitions are always created with null trigger values. The database columns remain for backward compatibility with existing data. Trigger-based automation has been migrated to the workflow engine.
Custom Values
The CustomValues dictionary supports the following well-known keys:
| Key | Type | Description |
|---|---|---|
mapToEventDefinitionId | int | When set, the tracking event import service will map incoming events matching this definition to the target EventDefinition specified by this ID. This allows aliasing or redirecting event definitions — for example, mapping a carrier-specific event code to a canonical internal event definition. |
Example: Event Definition Mapping
If EventDefinition A (ID 10) has CustomValues["mapToEventDefinitionId"] = 20, then when a tracking event is imported and matched to EventDefinition A, the system will instead create the tracking event using EventDefinition B (ID 20). This is useful for normalizing external carrier events to standard internal definitions.