Overview

Webhook integration allows you to integrate and send UserGuiding events or metadata to any third-party application that supports webhook URLs. You can also send your user and company attributes and user events from those applications to UserGuiding.

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):

https://hooks.userguiding.com/TzLC60L/BoRJQ7hT9J3/o1kA2SDFUEFzzB9ig3PX

Enabling Webhook Integration

You can activate this integration within the Integrations tab on the Settings page.

UserGuiding As a Source

Outgoing Webhooks allow you to send UserGuiding data to external tools when specific events occur. You can customize which events trigger these webhooks by selecting Events to Trigger Webhooks.

Event Tracking

UserGuiding pushes out real-time event notifications to Webhooks when it is enabled as a Source.

You can view these events on your contact’s timeline.

Event Format

{
	"account_id": string,
	"event_type": <EVENT_NAME>,
	"event_properties": <EVENT_PROPERTIES>
}

Example Event

{
	"account_id": "9845",
	"event_type": "banner button click (userguiding)",
	"event_properties": {
		"bannerId": "36",
		"bannerName": "Banner Name",
		"buttonId": "0910f959-f611-4f42-9337-3964d7f9e005",
		"ctaText": "Explore Now",
		"userId": "USER-ID",
		"pageUrl": "https://panel.userguiding.com/dashboard"
	}
}

Find the list of all events UserGuiding emits to integrated tools in this article.

Testing Webhook Integration

UserGuiding sends data in JSON format, and the Webhook messages are being sent from the client side, meaning we are unable to check if the process is successful or not.

You can use this site to test the integration. While testing on there, make sure the CORS Headers checkbox is checked.
​

After completing the integration, you need to activate a material (Guide, Hotspot, etc.) and interact with it to trigger an event to be sent through.

You can also check if the HTTP POST messages are being sent to the Webhook URL you are using through the Network tab on the browser console.

UserGuiding as Destination

• UserGuiding generates a unique Webhook URL for your account.
• This URL includes an authentication token to ensure secure data transfer.
• When enabled, you can send user attributes, company attributes, and user events from third-party apps to UserGuiding.
• To integrate with the third-party tools, you need to copy your unique Webhook URL and paste it into your preferred third-party service (e.g., HubSpot, Marketo, Zapier).
• Note that adding UserGuiding as a destination is available for Growth and Enterprise plans.

Disabling Webhook Integration

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

IP Addresses for Whitelisting

If your infrastructure requires IP whitelisting to receive incoming webhook requests from UserGuiding, you can allow the following static IP addresses.

US Region (Default)

Most UserGuiding accounts are hosted in the US region. Whitelist the following IPs:

• 18.116.58.166
• 3.143.149.155
• 18.220.171.235

EU Region

If your account is hosted in the EU region, whitelist the following IPs instead:

• 3.67.20.59
• 3.66.186.236
• 3.65.188.196

We recommend whitelisting all IPs for your region, as traffic may come from any of them. These IPs are static and will not change under normal circumstances. If we ever need to update them, we will notify affected customers in advance.

If you are unsure which region your account is hosted in, please contact our support team.