POST /interaction/v1/eventDefinitions

Overview

Creates an event definition (name and data schema for an event) and defines an event definition key. The resource uses this key when firing an event to send it to the appropriate journey. Typically, marketers create the event definition in the Journey Builder UI. Use this resource instead if you’re using a custom application for Journey Builder functionality. To call this resource, assign your API Integration the Automation | Interactions | Read scope.

JSON Parameters

NameTypeDescription
typestringRequiredEvent represents the most generic type of Event Definition. Other possible values include ContactEvent, DateEvent, or RestEvent.
namestringRequiredA name for your Event Definition that identifies the event in Marketing Cloud
descriptionstringDescription of Event Definition
modestringYou can run Event Definitions in Production (default) or Test mode.
eventDefinitionKeystringRequiredUnique Id for an Event Definition in Marketing Cloud. Don't include special characters.
sourceApplicationExtensionIdstringA link to the application extension that defines the configuration screens for this type. Journey Builder uses this ID to filter shared entry sources. For example, for the Event Definition to be visible in the Existing Entry sources panel in the UI, this field must be populated. To obtain this value, perform a GET eventDefinition on similar events in Journey Builder.
iconUrlstringURL to an icon displayed in Event Administration and the Journey Builder Canvas that identifies an Event Definition
isVisibleInPickerbooleanIndicates whether the Event Picker shows the Event Definition to users when configuring a journey. To see your Event Definition in Journey Builder, use true.
categorystringBroad category of the event type. The default value is event.
argumentsobjectContains filter criteria for the Event Definition. Only required for types other than event.
arguments.criteriastringWhen the API call defines a filter template, use this parameter as a template when a user chooses and configures the Event Definition. If you aren’t defining an additional filter for the Event Definition, leave this empty.
configurationobjectOptional configuration data for the event. Only required for types other than event.
metaDataobjectOptional data describing the event and its configuration. Only required for types other than event.
dataExtensionIdstringRequiredThe 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.
dataExtensionNamestringThe read-only name of the data extension associated with the event. POST and PUT methods ignore this field.
schemaobjectRequiredSchema 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. See Event Definition Schema for additional information.
sendableCustomObjectFieldstringDefines the subscriber key or email address within a data extension. Required when defining a schema.
sendableSubscriberFieldstringIndicates type of sendable subscriber field. The default value is SubscriberKey. Required when defining a schema.
schedulestringCreates 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. See Firing an Event Using Automation Studio for additional information.

Usage

Example Request

Response: No Errors

Response: Incorrect JSON Format

Response: Runtime Error

Response: Empty or Incorrect Authorization Token