Form Capture Webhook
This captures data from submissions using native PathFactory standard forms. It sends the information entered by the visitor, along with additional details about where the form was submitted.
Benefits: This webhook captures valuable information about your visitors, such as their name, position, and contact information, which can be used to enhance your marketing strategies.
Trigger: The form capture webhook is triggered when a native PathFactory standard form submission occurs. This event will not trigger if an external form is used without setting up a corresponding standard PathFactory form.
|
Note
|
Please note that for form capture webhooks to successfully send data to an external system, a form must be set up on the external system. When you create a form capture webhook, you will be asked to provide the URL of the form. |
Visitor Session Webhook
The visitor session webhook is triggered by session data. A visitor session begins when a visitor arrives on a PathFactory Experience and ends when the visitor has stopped engaging with content for thirty minutes.
Benefits: The data sent through this webhook provides an overview of the level of engagement the visitor had with your PathFactory Experience and the content assets inside them during the session. This helps you understand visitor behavior and improve content strategy.
Trigger: This webhook is triggered when a visitor session ends. The webhook will send data to the external system thirty minutes after the visitor has finished engaging with content.
Visitor Activity Webhook
The visitor activity webhook is triggered when a visitor to a PathFactory Experience meets one or more of the predefined activities set in the Visitor Activities Configuration. To use this webhook, you must first set up your visitor activities in the Visitor Activities library.
Benefits: The data sent through this webhook depends on the visitor activity that you set up. It provides insights into specific visitor behaviors and interactions, helping you tailor your marketing efforts more effectively.
Trigger: The visitor activity webhook is triggered when a visitor to a PathFactory Experience, a Web Property, or a Specific Collection meets one or more of the predefined activities set in the Visitor Activities Configuration. The data from this event is sent thirty minutes after a visitor last engaged with a content asset.
Virtual Event Webhook
The virtual event (VEX) webhook captures visitor consumption data for your Virtual Events. This data helps summarize session engagement and can be used by marketers to update campaigns and communicate engagement to sales.
Benefits: The data sent through this webhook provides deep insights into how your attendees are engaging with the supplemental content, for how long, and their level of interest based on funnel stage and assets viewed. This helps you gauge attendee engagement, determine which experiences are performing well, and categorize attendees (e.g., Registered, Attended Live, Attended On-Demand).
Trigger: This webhook triggers 30 minutes after a visitor leaves a Virtual Event Session. You can select which visitor activities you want your webhook to capture by hovering over Event Fields and clicking the pencil icon that appears to select the fields needed to capture exactly the visitor data you require.
For a list of VEX webhook definitions, read here.
Webhook Fields for Templated Experiences and Website Tools
This section lists the fields available for configuring webhooks within Templated Experiences and Website Tools. These fields help capture detailed visitor interaction data, allowing you to better understand and engage with your audience
Templated Experiences
The webhook service is triggered once the visitor session is completed and will contain some of the following configured fields, depending on the form capture or visitor engagement thresholds you have set up for your webhook.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Website Tools Configured Fields
These fields are available to use for your Website Tools webhooks.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
How to Create a Webhook
To create a webhook, follow these steps.
- Click on the gear icon at the top right of the page, and select Webhooks from the drop-down menu
Webhooks menu item - Once you are in our Webhooks Configuration page, you can click on the Add Webhook button on the top right.
Add Webhook - The Add Webhook menu opens for you to add details for your new webhook. If your organization uses multiple MAPs (Marketing Automation Platforms), you will see two radio buttons to specify how the webhook should be configured, as described below.
Note: If you do not have radio buttons on the Add Webhook menu, that means your Administrator hasn’t enabled this feature. In that case, skip this step and move on to Step 4.
- Domain: Choose this option if you want the webhook to trigger based on the domain from which the data originates. This helps direct data from specific domains to the appropriate MAP instance.
Conditional Webhook Domain - Folder: Choose this option if you want the webhook to trigger based on the folder where the data is stored. This helps route data from specific folders to the correct MAP instance.
Conditional Webhook Folders
- Domain: Choose this option if you want the webhook to trigger based on the domain from which the data originates. This helps direct data from specific domains to the appropriate MAP instance.
- Enter a name for your new webhook.
- Click on the Event Type menu and select an option from the list: Visitor Session, Form Capture, Website Tools Session, Visitor Activity, or Virtual Event Session.
List of Webhook Types - By default the webhook triggers for only known visitors. If you want it to fire for all visitors toggle the Fire For Known Visitors Only to off.
- Click Add Webhook to create.
Add Webhook popup menu - Once created, the webhook is displayed in the list of webhooks. To view and adjust the configuration of a webhook, select it. A right side panel appears and displays its details. Edit as needed.
Webhook Configuration details - Select Event Fields.
Event Fields menu item - Configure any custom fields (optional) and click Save.
Configure Webhook Event Fields popup menu - Edit the webhook custom fields as desired.
Webhook custom fields dialog - The default setting for separating multiple values in a single field are square brackets. If you want to change this to another format, you can enter a custom delimiter such as a comma, colon, or semicolon.
Delimiter values - Enable the webhook to activate it.
Enable toggle
How to Test a Webhook
When you have finished configuring your webhook, you can test it to make sure it’s working as you expected. See this document for instructions on how to test the following webhooks.
- form captures
- visitor activity
- session activity