Overview

Webhook integration allows you to integrate and send UserGuiding events and metadata to any third-party application that supports webhook URLs.

What do you need to enable Webhook Integration?

  • You need to use a third-party application or a platform that provides a Webhook URL.

  • You need to create a new Webhook URL on your third-party application.

A Webhook URL acts like a phone number that UserGuiding can call when an event happens and talk to the receiving application.

It looks something like this (keep in mind that the domain changes based on the application):

Enabling Webhook Integration

You can enable this integration by using the toggle within the Integrations Tab under the Settings page.

  • Turn the toggle on

  • Enter the Webhook URL from your application into the opening pop-up

  • Click “Complete Integration”, and that's all 🙌

Event Data We're Sending Through Webhook

Listed below are the user events and their metadata that we'll be sending to the third-party application you integrate.

Guide Preview Start

It means that the first step of a Guide is previewed by a user. To see which Guide it is, check under guide started (userguiding).

You'll see the Guide ID, name, the URL of the page on which the user has seen its first step, and the user ID.

Guide Preview Complete

It means that a user has gone through all steps of a Guide and seen its last step. To see which Guide it is, check under guide completed (userguiding).

You'll see the Guide ID, name, the URL of the page on which the user has seen its first step, and the user ID.

NPS Survey Display

It means that your Promoter Survey is seen by a user. To see the URL of the page where the user has seen the survey and the user ID, check under nps survey shown (userguiding).

NPS Score Submit

It means that a user has given you a certain NPS score. To see the NPS score value, check under nps score submit (userguiding).

You'll see the survey question, the URL of the page on which the user has seen the survey, and the user ID.

NPS Feedback Submit

It means that a user has given a written answer to the question of your NPS Survey. To see the answer, check under nps feedback submit (userguiding).

You'll see the feedback question, given feedback, the URL of the page on which the user has seen the survey, and the user ID.

Hotspot Interaction

It means that a user interacted with a hotspot group and saw Hotspot content. Please note that Hotspot groups can have multiple Hotspots as contents.

This event is sent once in one UserGuiding script load (page refresh).

To see which Hotspot it is, check under hotspot interacted (userguiding).

You'll see the Hotspot group ID, interacted Hotspot's ID/title, the name of the Hotspot group, the URL of the page on which the user interacted with the Hotspot, and the user ID.

Checklist Item Trigger

It means that a checklist item is triggered by a user. To see which item is triggered from which Checklist, check under checklist item triggered (userguiding).


You'll see the Checklist name / ID, Guide name / ID, the URL of the page on which the user has triggered the Guide from the Checklist, and the user ID.

Checklist Item URL Click

It means that a user clicks a Checklist URL item. To see which item is triggered from which Checklist, check under checklist item url click (userguiding).


You'll see the Checklist name / ID, the URL of the clicked item, the URL of the page on which the user has clicked the item from the Checklist, and the user ID.

Checklist Complete

It means that a user completes a Checklist. To see which Checklist is completed, check under checklist completed (userguiding).


You'll see the checklist name / ID, the URL of the page on which the user has completed the checklist, and the user ID.

Resource Center Guide Trigger

It means that a Resource Center Guide is triggered by a user. To see which Guide is triggered from which Resource Center, check under resource center guide triggered (userguiding).

You'll see the Resource Center name / ID, Guide name / ID, the URL of the page on which the user has triggered the Guide from the Resource Center, and the user ID.

Resource Center Checklist Guide Trigger

It means that a Guide in a Checklist that is put in a Resource Center as a module is triggered by a user. To see which Guide in which Checklist is triggered from which Resource Center, check under resource center checklist guide triggered (userguiding).

You'll see the Resource Center name / ID, Checklist name / ID, Guide name / ID, the URL of the page on which the user has triggered the Guide from the Resource Center, and the user ID.

Resource Center Checklist Item URL Click

It means that a URL item in a Checklist that is put in a Resource Center as a module is clicked by a user. To see which URL item in which Checklist is clicked from which Resource Center, check under resource center checklist item url click (userguiding).

You'll see the Resource Center name / ID, Checklist name / ID, the URL of the clicked item, the URL of the page on which the user has clicked on the item from the Resource Center.

Resource Center External URL Click

It means that a user clicks an external URL in a Resource Center. To see which external URL is clicked from which resource center, check under resource center external URL clicked (userguiding).

You'll see the resource center name / ID, the external URL, the URL of the page on which the user has clicked the external link from the Resource Center, and the user ID.

Resource Center Search Article Click

It means that a user clicks a search article in a Resource Center. To see which search article is clicked from which Resource Center, check under resource center article clicked (userguiding).


You'll see the resource center name / ID, the article link, the URL of the page on which the user has clicked the article link from the Resource Center, and the user ID.

Disabling Webhook Integration

You can disable this integration by turning off the toggle within the Integrations Tab under the Settings page.

Did this answer your question?