What are webhooks?

A webhook is a way for one website to send information to another website automatically. Think of it like a "phone call" between two websites. One website "calls" the other website by sending a message, and the other website "answers" by receiving the message and doing something with the information it contains. This allows one website to "talk" to another website and perform tasks automatically. 

How to send data from Usetiful to other apps using a webhook?

Client-side webhooks in the Trigger Event step

Usetiful supports calling other applications via webhooks and sending selected data stored in Usetiful tags or collected while using the tour. Client-side webhooks send data from the client (user's browser) to the selected Webhook URL.

To set up a webhook call within your product tour, follow these steps:

  • Add a step of the "Trigger event" to your product tour.
  • Modify the trigger type to "Send data to webhook".
  • Specify the webhook URL and the data you intended to send.

When this step is reached in the tour, Usetiful immediately sends the entered data to the given webhook URL.

In addition to the above, Usetiful supports advanced settings to configure requests:

  • Type of request: You can choose between Post and Get requests.
  • Parameters for URL: You can include additional parameters in the URL such as port, username, and password, to enhance the configurability of your webhook.
  • Parameters for Request Headers: You can include unlimited pairs of key-value parameters in the request headers.

With enabling advanced settings, you can easily customize your webhook requests to fit your integration needs.

Server-side webhooks

This method involves secure server-to-server communication, offering an enhanced level of security for data exchanges.

To configure a back-end webhook, navigate to Admin > Developers > Webhooks in Usetiful account, and select the "Create webhook" option to initiate the setup.

In the setup dialog, you can specify properties similar to those for client-side webhooks. Additionally, you can choose which Usetiful event will trigger the data transmission to your webhook URL.

These events include:

  • tour_completed: Triggered when a user completes any tour.
  • checklist_item_completed: Activated when a checklist item is marked as completed.
  • checklist_completed: Occurs when all items on a checklist are marked as completed.
  • checklist_dismissed: Triggered when a user dismisses a checklist.
  • banner_seen: Initiated when a banner is displayed to the user.
  • banner_closed: Occurs when a user closes a banner.

For each specified event, the system dispatches the following data:

  • name: The name assigned to the webhook.
  • userId: The unique identifier of the user involved in the event.
  • events: An array detailing events pertinent to the user. Each entry within this array includes the event's name and the associated content's ID.

This structure ensures a comprehensive tracking mechanism, enabling precise user engagement monitoring and tailored responses.