EventDefinitions
Create, delete and query event definitions.
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 | = |
The Id of the event definition. | |
| Type | String | False |
The type of the event definition. The allowed values are Event, ContactEvent, DateEvent, RestEvent. | ||
| Name | String | False | Contains |
A name for your Event Definition that identifies the event in Marketing Cloud. | |
| CreatedDate | Datetime | True |
The datetime when the event definition was created. | ||
| CreatedBy | Integer | True |
The Id of the event definition creator. | ||
| ModifiedDate | Datetime | True |
The datetime when the event definition was updated. | ||
| ModifiedBy | Integer | True |
The Id of the event definition modifier. | ||
| Mode | String | False | = |
The mode in which the event definitions can run. The allowed values are Production, Test. The default value is Production. | |
| EventDefinitionKey | String | False |
Unique Id for an Event Definition in Marketing Cloud. Don't include special characters. | ||
| DataExtensionId | String | False |
The ID for the data extension associated with the event. Events fired from the API write to this data extension. Required only when not providing a schema. | ||
| DataExtensionName | String | False |
The read-only name of the data extension associated with the event. | ||
| Description | String | False |
The description of Event Definition. | ||
| Schema | String | False |
Schema information for an event. The call uses this information to create a data extension associated with the Event Definition. Only required when not providing a dataExtensionId value. | ||
| SendableCustomObjectField | String | False |
Defines the subscriber key or email address within a data extension. Required when defining a schema. | ||
| SendableSubscriberField | String | False |
Indicates type of sendable subscriber field. The default value is SubscriberKey. Required when defining a schema. | ||
| Schedule | String | False |
Creates an automation run daily according to the defined schedule. The call automatically adds a Fire Event activity to the automation. This automation fires events from the data extension defined as part of the Event Definition. | ||
| FilterDefinitionId | String | False |
The Id of the filter definition. | ||
| FilterDefinitionTemplate | String | False |
The template of the filter definition. | ||
| IconUrl | String | False |
URL to an icon displayed in Event Administration and the Journey Builder Canvas that identifies an Event Definition. | ||
| Arguments | String | False |
Contains filter criteria for the Event Definition. Only required for types other than event. | ||
| Configuration | String | False |
Optional configuration data for the event. Only required for types other than event. | ||
| ConfigurationArguments | String | False |
The configuration arguments of Event Definition. | ||
| Metadata | String | False |
Optional data describing the event and its configuration. Only required for types other than event. | ||
| InteractionCount | Integer | False |
The interaction counter. | ||
| IsVisibleInPicker | Boolean | False |
Indicates whether the Event Picker shows the Event Definition to users when configuring a journey. The default value is true. | ||
| Category | String | False |
Broad category of the event type. The default value is event. | ||
| PublishedInteractionCount | Integer | False |
The published interaction counter. | ||
| AutomationId | String | False |
The Id of the Automation. |