Setting Up webhooks

There are three types of PathFactory webhooks:

  • form capture webhook
  • visitor session webhook
  • visitor activity webhook

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

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

    Webhooks main screen
  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.

    Add Webhook dialog
  4. Once created it shows in the list below and the webhook configuration appears on the right hand side of the screen.

    Webhooks main screen
  5. Set up the Event Fields and click Save.

    Event setup dialog
  6. Configure any custom fields (optional) and click Save.

    Webhook event fields dialog
  7. Edit the Webhook custom fields as desired.

    Webhook custom fields dialog
  8. 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.
    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.

    Delimiter values
  10. 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 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

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.

Updated on November 10, 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