1. Home
  2. Integrations
  3. Webhooks
  4. VEX Webhook Field Definitions

VEX Webhook Field Definitions

PathFactory provides a robust data set based on the engagement of all of your event registrants and attendees with both the main video component and supplementary content in each VEX session. To pass this detailed engagement data to other platforms, most commonly Marketing Automation Platforms (MAPs), VEX leverages PathFactory’s Webhook Integrations. Some webhook fields behave differently within VEX than PathFactory’s core Campaign Tools (Content Tracks or Explore Pages). The following article describes the data passed by each Webhook field within VEX.


Form Capture Webhook

Visitor Email:

The email address the registrant input in the VEX Registration form.


Visitor Name:

First and last name the registrant input in the VEX Registration form.


First Name:

First name the registrant input in the VEX Registration form.


Last Name:

Last name the registrant input in the VEX Registration form.


Job Title:

Job title the registrant input in the VEX Registration form.


Phone Number:

Phone number the registrant input in the VEX Registration form.


Company:

Company name the registrant input in the VEX Registration form.


Opt In:

If the opt-in field was present in the registration form, this field will store the value that the visitor selected. If the visitor selects “Yes” to opt-in, the value passed will be “1”. If the visitor selects “No” to opt-in, the value passed will be “0”.


Experience Name:

Event Name of the event the attendee has registered for, value will be as entered in the Event Setup.


Experience External ID:

External ID of the event the attendee has registered for, as entered in the Event Setup.


Content URL:

URL the registrant was on when they registered, not including any query strings present at the time of registration.


Query String:

Full query string that was within the registrants URL, including all parameters and values, at the time of registration.


UTM Campaign:

The utm_campaign query string parameter present in an attendees URL at the time of registration.


UTM Content

The utm_content query string parameter present in an attendee’s URL at the time of registration.


UTM Medium:

The utm_medium query string parameter present in an attendee’s URL at the time of registration.


UTM Source:

The utm_source query string parameter present in an attendee’s URL at the time of registration.


UTM Term:

The utm_term query string parameter present in an attendee’s URL at the time of registration.


Webhook Name:

Name that you give to the webhook when you create it inside PathFactory.

imageWebhooks Configuration page


Event Type:

Used to display the name of what triggered the webhook. In this case it would be “Form Capture”. Note: the term Event being used here is NOT in the context of a VEX event.


Event Time:

Date/time the registration form was submitted, not the time of your VEX event.


Form Name:

Name of the standard form that was used in the VEX event and was submitted by your registrant.

imageForm Configuration page


The following Form Capture Webhook Fields are not used by PathFactory VEX:

The following fields will return a proprietary PathFactory ID which doesn’t relate to any set-up you’ve done in VEX. As such they should be disregarded for your VEX events.
  • Experience ID
  • Experience LookBook ID
The following fields will be empty for VEX Registrants:
  • Content External ID
  • Content Media Type
  • Content Type
  • Content Title
  • Content Source URL


Visitor Session Webhook

These are the fields most commonly used by VEX customers

Known Visitor Email:

The email address of the attendee.


Experience Name:

This will return the Event Name of the event, as entered on the Event Setup.


Experience External ID:

This will return the External ID of the event, as entered on the Event Setup.


Content Count – Time Thresholds Met:

The number of sessions and assets for which the engagement threshold has been met while the visitor is engaged in an Event.


Session Start Time:

The actual date/time of when the attendee started engaging with your PathFactory VEX event, recorded in your PathFactory install timezone. Note: this is NOT the start time of your VEX Event or the VEX session.


Session Start Time (UTC):

The actual date/time of when the attendee started engaging with your PathFactory VEX event, recorded in UTC. Note: this is NOT the start time of your VEX Event or the VEX session.


Session End Time:

The actual date/time of when the attendee finished engaging with your PathFactory VEX event, recorded in your PathFactory install timezone. Note: this is NOT the end time of your VEX Event or the VEX session.


Session End Time (UTC):

The actual date/time of when the attendee finished engaging with your PathFactory VEX event, recorded in UTC. Note: this is NOT the end time of your VEX Event or the VEX session.


Engagement Time:

Total time (in seconds) the attendee spent engaging with your VEX Event in their visitor session.


Total Views:

The total number of sessions and assets the attendee hit.


Assets Viewed:

This field returns the number of unique content assets viewed by the attendee. This includes each piece of Supplemental Content, plus the session itself.


Content Journey:

This field returns the slug of each piece of supplemental content, plus the slug of each session the attendee viewed (regardless of the time they spent on it). The slug can be controlled for supplemental content in the Content Library, and is determined for the session within the Session Setup. The assets and session will be represented by their unique URL slugs in this format:
[ContentAsset1][ContentAsset2][ContentAsset3]


Content List – Time Thresholds Met:

This field returns the slug of each piece of supplemental content, plus the slug of each session the attendee viewed, but only if the time threshold was met. The slug can be controlled for supplemental content in the Content Library, and is determined for the session within the Session Setup. Similarly the time threshold for supplemental content is determined in the Content Library, and is determined for the session within the Session Setup. The assets and sessions will be represented by their unique URL slugs in this format:
[ContentAsset1][ContentAsset2][ContentAsset3]


Engagement Score:

This field displays the engagement score for an attendee. It is a combination of the score for any asset where the time threshold was met plus the score for any session attended where the time threshold was met.


Query String:

This field returns the full query string that was within the attendees URL including all parameters and values.


Referrer URL:

The first URL that the attendee was on when they entered the VEX event.


These webhook fields can be useful for some VEX events but see more limited use:

Is Known Visitor:

A True/False field indicating whether the attendee has an email address associated with their record inside PathFactory.


Known Visitor Email Domain:

The domain associated with the email address of the attendee.


Browser:

The name of the browser that the attendee used to attend the Event – Chrome, FireFox, etc.


Device Type:

Desktop, Mobile, etc.


Operating System:

Operating system the attendee was on while attending the event – iOS, Windows, etc.


Referrer Source:

We use the Referrer URL and attempt to infer a source name. Typically this will simply be the subdomain of your VEX event.


Referrer Medium:

Every referral to a website also has a medium. Possible medium include: “organic” (unpaid search), “cpc” (cost per click, i.e. paid search), “referral” (referral), “email” (the name of a custom medium you have created), “none” (direct traffic has a medium of “none”).


ISP Domain:

The name of the Internet Service Provider. If your attendee is from a computer that is on a big corporate network – example: Google, the ISP Domain will show “Google” instead of the ISP.


Last Viewed Content Title:

This field returns the public title of the last piece of content viewed or the title of the last session viewed. The content title is set in the Content Library, and the Session Name is set in your VEX authoring environment.


Last Viewed Content Source URL:

This field returns the URL of the last piece of content viewed or the URL of the last session viewed.


Content Types List – Time Thresholds Met:

This field returns the content type (as configured in the Content Library) for each piece of supplemental content and for the live or on demand video which had its time threshold met by the attendee. Note: WebEx and Zoom video content sessions can’t be tagged to an asset type and so will not be included in this field.


Business Units List – Time Thresholds Met:

This field returns the Business Unit (as configured in the Content Library) for each piece of supplemental content and for the live or on demand video which had its time threshold met by the attendee. Note: WebEx and Zoom video content sessions can’t be tagged to a business unit and so will not be included in this field.


Funnel Stages List – Time Thresholds Met:

This field returns the Funnel Stages (as configured in the Content Library) for each piece of supplemental content and for the live or on demand video which had its time threshold met by the attendee. Note: WebEx and Zoom video content sessions can’t be tagged to a funnel stage and so will not be included in this field.


Topics List – Time Thresholds Met:

This field returns the topics (as configured in the Content Library) for each piece of supplemental content and for the live or on demand video which had its time threshold met by the attendee. Note: WebEx and Zoom video content sessions can’t be tagged to a topic and so will not be included in this field.


City:

The name of the city inferred from the IP address associated with the attendee.


Country:

The country name inferred from the IP address associated with the attendee.


Region:

The region name inferred from the IP address associated with the attendee.


Company Name:

This field returns the name of the company of the attendee as determined by 6sense or Demandbase, based on their IP address.


Webhook Name:

This is the name that you give to the webhook event when you create it inside PathFactory.

image


Event Type:

Represents the “type” of the event that triggers the webhook. In this case the “type” is “Session Closed”.


Event Time:

Returns the actual date/time when the visitor finished engaging with your VEX event, based on your PathFactory install time zone. Note: This is not the time of your VEX event.


The following Visitor Session Webhook Fields are not used by PathFactory VEX:

Likes:

Not used in VEX, an event attendee will always have 0 in this field.


Shares:

Not used in VEX, an event attendee will always have 0 in this field.


Captures:

At the time of writing there is no method to capture a form fill during your event (after initial registration). Therefore this field will always be 0.


Session ID:

This field will return a proprietary PathFactory ID for the attendee’s visitor session. Note: the term “Session” being used here is NOT in the context of a VEX Event Session.


Visitor Activity Webhook

While the Visitor Activity Webhook does function for VEX events, it is not often used. VEX customers typically wish to pinpoint the attendees to specific sessions, which can usually be accomplished with the Visitor Activity Webhook. The Specific Content Engagement Visitor Activity may prove useful in some VEX scenarios, however it is limited to supplementary content items from your Content Library, which means it does not apply to any session powered via our Zoom or WebEx integrations. Many of the same fields from the Visitor Session Webhook are available within the Visitor Activity Webhook, and should be expected to return the same values.

To learn more about Visitor Activities see Understanding Visitor Activities.

Views: 2

Updated on April 13, 2023

Was this article helpful?

Need Support?
Can't find the answer you're looking for? Don't worry we're here to help!
CONTACT SUPPORT