Form Capture Webhook
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. If you are using an Eloqua, Marketo, Pardot or any other external form in your PathFactory Experiences, you will not be able to trigger a webhook. If you would like to create a Form Capture Webhook you must use the PathFactory standard form. For instructions on how to create a PathFactory standard form click here.
The data that the visitor entered in the form can be sent with this webhook as well as some additional information on where the form was submitted. For more details on the data that can be sent in the form capture webhook check out the Webhook Event Field Cheat Sheet.
Create a Form Capture Webhook
|
Note
|
Please note that for webhooks to successfully send data to an external system a form must be set up on the external system. In this set up you will be asked to provide the URL of this form. If you have not set up a form in your external system you will not be able to set up a webhook. |
- Click on the gear icon at the top right of the page, and select Webhooks from the drop-down menu
Webhooks menu - Once you are in our Webhooks Configuration page, you can click on the Add Webhook button on the top right.
Webhooks main screen - Click on the Event Type menu to see a list of webhook types available.
List of Webhooks - Give your webhook a name, enter in the destination URL and choose Form Capture for Event Type. Click Add Webhook to create.
Add Webhook popup menu - Once created it shows in the list below and the webhook configuration appears on the right hand side of the screen.
Webhooks main screen - Set up the Event Fields and click Save.
Event setup dialog - Configure any custom fields (optional) and click Save.
Webhook event fields dialog - Edit the Webhook custom fields as desired.
Webhook custom fields dialog - 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.
- 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
Visitor Session Webhook
|
Note
|
Please note that for webhooks to successfully send data to an external system a form must be set up on the external system. In this set up you will be asked to provide the URL of this form. If you have not set up a form in your external system you will not be able to set up a webhook. |
The visitor session webhook is triggered off of session data. A visitor session begins when a visitor arrives on a PathFactory Experience and ends when that visitor has stopped engaging with content for thirty minutes. This webhook is triggered when a visitor session ends. This means that the webhook will trigger and send data to the external system thirty minutes after the visitor has finished engaging with content. The data sent though 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.
For more details on the data that can be sent in the visitor session webhook check out the Webhook Event Field Cheat Sheet
Visitor Activity Webhook
The visitor activity webhook is triggered when a visitor to a PathFactory Experience has met 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. The data from this event is sent thirty minutes after a visitor last engaged with a content asset.
The data sent though this webhook depends on the visitor activity that you set up. For more details on the data that can be sent in the visitor activity session webhook check out the Webhook Event Field Cheat Sheet.
This article explains how to create a webhook, the benefits of each webhook type,and the description and trigger of each of these webhooks. For all webhook creation and modification, there is a common procedure to begin.
Note: To learn more about webhooks, click here.
How to Create a Webhook for Visitors and Virtual Events
These instructions describe where the Webhooks menu item resides, and how to begin to create a webhook for a Visitor Session, a Visitor Activity, or a Virtual Event.
- Click on the gear icon at the top right of the page, and select Webhooks from the drop-down menu.
- Once you are on the Webhooks Configuration page, you can click on the Add Webhook button on the top right.
- Click on the Event Type menu to see a list of webhook types available.
- Give your webhook a name and select a webhook type. Click Add Webhook to create.
You can activate or deactivate Fire for known visitors later on. If you aren’t basing your new webhook on an Eloqua form, you must enter a destination URL here.Note: Enter the URL you used in your request to the web service. Not sure what this is? Ask your administrator.
- Once created, the new webhook is displayed in the list of created webhooks, ready for you to configure its fields. If you select it in the list, the webhook configuration appears on the right hand side of the screen.
- 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. To capture activity from Known Visitors, turn toggle on.
- 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.
- Toggle on the webhook to activate it.
Form capture Webhook
Benefits: You will gain valuable information about your visitors when you have them fill in their name, position, contact information and more.
Description: The data that the visitor entered in the form is sent via this webhook as well as some additional information on where the form was submitted. For more details on the data that can be sent in the form capture webhook check out the Webhook Event Field Cheat Sheet.
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.
Visitor Session Webhook
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. For more details on the data that can be sent in the visitor session webhook check out the Webhook Event Field Cheat Sheet. If you are planning to use a Visitor Activity webhook you must set up the Visitor Session webhook first.
Description: A visitor session begins when a visitor arrives on a PathFactory Experience and ends when that visitor has stopped engaging with content for thirty minutes. This means that the webhook will trigger and send data to the external system thirty minutes after the visitor has finished engaging with content.
Trigger: This webhook is triggered when a visitor session ends.
Visitor Activity Webhook
Benefits: The data sent through this webhook depends on the visitor activity that you set up. For more details on the data that can be sent in the visitor activity session webhook check out the Webhook Event Field Cheat Sheet.
Description: The data from this event is sent thirty minutes after a visitor last engaged with a content asset. To use this webhook you must first set up the Visitor Activities webhook.
Trigger: The visitor activity webhook is triggered when a visitor to a PathFactory Experience, a Web Property or a Specific Collection has met one or more of the predefined activities set in the Visitor Activities Configuration.
Templated Experiences Webhook Configured Fields
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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Virtual Event Webhook
Benefits: As you can imagine, this insight for your Virtual Events is very valuable! You can see how your attendees are engaging with the supplemental content, for how long, gauge interest based on funnel stage, assets viewed, and be able to see which Experiences are performing well with your audience.
You will also see which category your attendees belong to:
- Registered
- Attended Live
- Attended On-Demand.
Here you configure which information you want your webhook to capture, same as you would do to configure a webhook for a PathFactory Experience.
Description: You can configure VEX webhooks to capture visitor consumption data for your Virtual Events. This activity helps summarize the session engagement and can be leveraged by marketers to make relevant campaign updates and communicate engagement to sales. Click-through rates (CTR) only let you know that visitors click a button or link, but they don’t tell you anything about how visitors are actually interacting with your content.
Trigger: This webhook triggers 30 minutes after a visitor leaves a Virtual Event Session.
To select which visitor activities you want your webhook to act on, hover over Event Fields and click the pencil icon that appears. Now you see all of the fields you can select, to capture exactly the visitor data you want.
Note: To add a field here that doesn’t already exist, click Custom Fields as shown below.
The following fields are available to select for your VEX webhook. For a list of VEX webhook definitions, read here.
Available Webhooks Fields for Virtual Events
Most of the fields will look familiar if you have used webhooks before. A few definitions of note are as follows:
- Virtual Event Session Start Time – the first start time configured for the session.
- Virtual Event Start Time – the start time configured for the virtual event.
- Virtual Event Session Engagement Time – this is expressed as minutes instead of seconds, and will be displayed as a fraction. i.e 1.5 instead of 1 minute 30 seconds.
To save your selections, click Save. Otherwise, click Cancel.
How to Test your 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