Event parameter

This article provides information on the event parameter for data transformation functions.

Data transformation functions have one parameter named event. The event parameter is a metadata object that contains several properties and nested objects describing the event. The actual event data is referenced in the event.data.udo object.

The event parameter object is read-only, except for the custom event data in event.data.udo and some tealium_ properties.

For more information, see Event Data Object.

Event parameter object

The event parameter object contains the following properties:

Property Type Description Writable
account String Account information. No
client_ip String Client IP address. No
data Object See Event Data Object. No
dataSourcePlatform String Name of the data source platform. No
enrichmentOnly Boolean Always false for live events. If false DataAccess is enabled, the event can be sent to DataAccess. May be true for bulk import events (when event.type="BULK_IMPORT"). If true, event data can be used only for enrichment. File import events are not currently supported for data transformation functions. No
env String Specifies the execution environment (dev or prod). No
event_id String Event ID. No
new_visitor Boolean True if this is the first visit for the user, otherwise false. No
page_url Object An object of URL properties. See URL Object.
Omitted for mobile events.
No
post_time Number Time stamp for the event. No
profile String Profile for the account. No
referrer_url Object An object of URL properties. See URL Object.
Omitted for mobile events.
No
type String Specifies whether the event is from a live visit or a bulk import event. Values are LIVE or BULK_IMPORT. File import events are not currently supported for data transformation functions. No
useragent String Specifies the software the user is using, such as the web browser. No
visitor_id String Visitor ID. No
_forwarding_visitor_ids String[] Contains the IDs of the visitors forwarding this event. Used in the visitor stitching process. No

Data source platform values

The value of the dataSourcePlatform property can be one of the following: default, adobe_launch, affirm, android, braze, cordova, cSharp, fileImport, googleAMP, google_tag_manager, http_api_flattened, hubspot_wf, intercom, iOS, iterable, java, javascript, mailchimp, python, RES, roku, salesforce, sendgrid, slack, swift, tiqJavascript, tvOS, watchOS, zapier.

File import events are not currently supported for data transformation functions.

Event data object

The event.data object represents the incoming event and contains the event.data.udo object that can be transformed:

Property Type Description Writable
dom Object Contains information about the page on which the event occurred (domain, query string, etc.) Omitted for mobile events. For more information, see Data Layer. No
firstparty_tealium_cookies Object Object contains cookie properties specified in your data layer.
Omitted for mobile events.
No
js Object Object contains JavaScript variable properties specified in your data layer.
Omitted for mobile events.
No
meta Object Object contains metadata properties specified in your data layer.
Omitted for mobile events.
No
udo Object Object contains the properties of the incoming event. Some properties are read-only. See Writable Properties. Yes

Writable properties

All custom event attributes in event.data.udo are writable, but only some of the tealium_ properties can be modified.

The following tealium_ properties can be modified, but not deleted:

  • event.data.udo.tealium_datasource
  • event.data.udo.tealium_environment
  • event.data.udo.tealium_event
  • event.data.udo.tealium_firstparty_visitor_id
  • event.data.udo.tealium_thirdparty_visitor_id
  • event.data.udo.tealium_library_name
  • event.data.udo.tealium_library_version
  • event.data.udo.tealium_random
  • event.data.udo.tealium_timestamp_epoch
  • event.data.udo.tealium_timestamp_local
  • event.data.udo.tealium_timestamp_utc
  • event.data.udo.tealium_session_number

Read-Only properties

The following object properties are read-only and cannot be modified:

  • event.data.udo.tealium_cf_ttl
  • event.data.udo._dc_ttl_
  • event.data.udo.platform
  • event.data.udo.tealium_visitor_id
  • event.data.udo.tealium_account
  • event.data.udo.tealium_profile
  • event.data.udo.tealium_session_id

URL object

The URL object contains the following standard URL properties:

PROPERTY TYPE DESCRIPTION WRITABLE
domain String Domain of the URL. No
full_url String Full URL. No
path String Path from the URL. May be empty. No
query_params Object An Object that contains one or more key.value pairs. Each key/value pair specifies a query string in the URL. For example:
"query_params": { "utm_medium": "PPC", "utm_source": "LinkedIn" }
No
querystring String Query string from the URL. No
scheme String Specifies the protocol to use for the web site, such as HTTP or HTTPS. No

Example event parameter object

The following shows an example event parameter object:

{
    "account": "XYZ_admin_acct",
    "profile": "main",
    "env": "prod",
    "data": {
        "dom": {
            "url": "https://www.example.com",
            "pathname": "/",
            "domain": "example.com",
            "hash": "",
            "query_string": "",
            "title": "Homepage"
        },
	"js": {},
	"meta": {},
	"udo": {
            "page_view": "view",
            "tealium_account": "XYZ_admin_acct",
            "tealium_profile": "main",
            "page_name": "Homepage",
            "page_type": "main",
            "tealium_event": "page_view",
            "user": {
                "browser_lang": "en-us",
                "ipcinfo": "en-us",
                "signedin": false,
                "city": "san diego",
                "country": "us",
                "country_name": "united states",
                "registry_city": "san diego",
                "registry_country_code": "us",
                "registry_state": "ca",
                "state": "ca"
            }
        },
        "firstparty_tealium_cookies": {
             "trace_id": ""
        }
    },
    "type": "LIVE",
    "enrichmentOnly": false,
    "event_id": "example-event-id",
    "visitor_id": "example-visitor-id",
    "post_time": 1655410928993,
    "useragent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36",
    "client_ip": "",
    "new_visitor": false
}

Was this page helpful?

This page was last updated: January 7, 2023