Setting Up Webhooks

Summary

There are three types of PathFactory Webhooks:

  • Form Capture Webhooks

  • Visitor Session Webhooks

  • Visitor Activity Webhooks

This article explains the difference between these webhooks and outlines the steps for creating each webhook type.

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 Content Tracks 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. 
  1. Click on the gear icon at the top right of the page, and select Webhooks from the drop-down menu
    image

  2. Once you are in our Webhooks Configuration page, you can click on the Add Webhook button.
    image

  3. Click on the Event Type menu to see a list of webhook types available. Give your webhook a name, enter in the destination URL and choose Form Capture for Event Type.  Click Add Webhook to create.
    image

  4. Once created it will show in the table below and the webhook configuration will appear on the right hand side of the screen.
    image

  5. Set up the Event Fields and click Save.
    image

  6. Configure any custom fields (optional) and click Save.
    image

  7. Return to the Webhook Configuration.
    image

  8. By default the webhook will trigger for only known visitors.  If you want it to fire for all visitors turn the Fire For Known Visitors Only to off.
    image

  9. 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.
    image

  10. Enable the webhook to activate it.
    image

Visitor Session Webhook

The Visitor session Webhook is triggered off of session data.  A visitor session begins when a visitor arrives on a Content Track 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 Content Track 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

Create a 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. 
  1. Click on the gear icon at the top right of the page, and select Webhooks from the drop-down menu
    image

  2. Once you are in our Webhooks Configuration page, click on the Add Webhook button.
    image

  3. Click on the Event Type menu to see a list of webhook types available. Give your webhook a name, enter in the destination URL and choose Session Closed for Event Type.  Click Add Webhook to create.
    image

  4. Once created it will show in the table below and the webhook configuration will appear on the right hand side of the screen.
    image

  5. Set up the Event Fields and click Save.
    image

  6. Configure any custom fields (optional) and click Save.
    image

  7. Return to the Webhook Configuration.
    image

  8. If you want it to fire for all visitors turn the Fire For Known Visitors Only to off, if you only want it to fire for known visitors turn it on.
    image

  9. 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.
    image

  10. Enable the webhook to activate it.
    image

Visitor Activity Webhook

The Visitor Activity Webhook is triggered when a visitor to a Content Track 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.

Create a Visitor Activity 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. 
  1. Click on the gear icon at the top right of the page, and select Webhooks from the drop-down menu
    image

  2. Once you are in our Webhooks Configuration page, you can click on the Add Webhook button.
    image

  3. Click on the Event Type menu to see a list of webhook types available. Give your webhook a name, enter in the destination URL and choose Visitor Activity for Event Type.  Click Add Webhook to create.
    image

  4. Once created it will show in the table below and the webhook configuration will appear on the right hand side of the screen.
    image

  5. Set up the Event Fields and click Save.
    image

  6. Configure any custom fields (optional) and click Save.
    image

  7. Return to the Webhook Configuration.
    image

  8. If you want it to fire for all visitors turn the Fire For Known Visitors Only to off, if you only want it to fire for known visitors turn it on.
    image

  9. 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.
    image

  10. Enable the webhook to activate it.
    image

Updated on July 7, 2022

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