1. Home
  2. Analytics and Business Intelligence
  3. Data Integration Center
  4. Webhooks
  5. How To Send WalkMe Event Data To 3rd Party Systems Using Webhooks

How To Send WalkMe Event Data To 3rd Party Systems Using Webhooks

Updated on September 12, 2019 Download PDFDownload as PDF
Download PDF

Brief Overview

This article explains how to create and customize webhooks (AKA callbacks) to send WalkMe Event data to 3rd party systems you use to trigger specific outcomes.

Webhooks deliver real-time WalkMe Event information to your system of choice, triggered by the event itself. This means you receive information with no delay,  so your teams can take immediate action on time-sensitive information.

Webhooks can be used to add WalkMe Event data into your analytics / BI tool, or to trigger 3rd party APIs. Now when a user clicks on a ShoutOut, you can add them to an email list in your email marketing system, or when they respond to an NPS survey you can have an instant notification sent to a Slack channel. With webhooks, WalkMe can be built directly into your workflows, with no R&D effort.

To learn more about what webhooks are, visit our article What Are Webhooks?

Steps For Sending WalkMe Data Using Webhooks

    1. Sign into your Insights account;
    2. Click Integrations in the left-sidebar:
    3. Click Webhooks:
    4. Click + NEW WEBHOOK:

      • This will initiate the webhook creation wizard.
    5. Give your webhook a name you will be able to identify it by later:

    6. Click CONTINUE.
    7. Complete the webhook wizard’s first step—Select Event:
      1. Select a WalkMe Event from the Event dropdown menu:

        To view the entire list of available event options, see the table at the bottom of this article.

      2.  After selecting the WalkMe Event, select a statement condition and input if applicable:
      3.  Click on the Advanced section dropdown triangle (OPTIONAL) if you wish to specify which properties of your chosen Event you wish to receive in the webhook call:

        •  If needed, you can rename the properties to match the destination system’s expected attributes. If you do not rename them, these are the values you will receive in the webhook call.
          • No spaces are allowed in the property name.
          • We recommend separating words using “_” or camelCase.
        • You can also set additional static properties to send alongside the webhook call.
          • Click the + ADD PROPERTY button.
          • No spaces are allowed in the key or value.
          • We recommend separating words using “_” or camelCase.
    8. Complete the webhook wizard’s second step—Select Destination:
      1. Enter the name of the 3rd party platform (destination system) to which you want the event data sent (e.g., Heap Analytics, Mixpanel, Google Analytics, etc.):
      2.  Configure the request type and destination URL:

        • These specify how to perform the webhook call and to where;
        • These details can be found in the destination system’s API documentation.
      3. Select an authentication type and enter values (OPTIONAL);
        • Consult to the destination system’s API documentation to understand if this is necessary.
      4. Enter any Header values required to perform the webhook call (OPTIONAL);
        • Consult to the destination system’s API documentation to understand if this is necessary.
      5. Review your information, and click the SAVE button.
      6. You will now receive a popup telling you you need to blank publish in the Editor. Please do so:

Pro-Tip: You can manage your destinations in the DESTINATIONS settings screen in the Webhooks Integrations section in Insights:

    1. Publish your webhook (ONLY IF IT’S YOUR FIRST WEBHOOK):
      1. Sign in to your WalkMe Editor account.
      2. Click Menu in the blue Admin Bar:
      3. Select the environment to which you want to publish the webhook.
      4. Uncheck all items, and click the Publish button.
        • This is called a “blank publish,” since you haven’t published any WalkMe items. 
    2. Verify that you’ve successfully configured the webhook as follows:
      1. Enter your application.
      2. Perform the event the webhook is tracking.
      3. Check that the destination system you’ve configured receives the webhook call and executes the desired outcome.

List of Available Events

The below table displays all options available for creating webhook events:

Group Name Description
Walk-Thru Walk-Thru Goal Reached Receive Events with Goals you’ve set to a Walk-Thru
Walk-Thru Started Receive Events where a Walk-Thru was shown to the User
Walk-Thru Failed Receive Events for Walk-Thrus that failed to start
Smart Walk-Thru Smart Walk-Thru Goal Reached Receive events with Goals you’ve set to a Smart Walk-Thru
Smart Walk-Thru Started Receive events where a Smart Walk-Thru was shown to the User
Smart Walk-Thru Failed Receive events for Smart Walk-Thrus that failed to start

Launcher

Launcher Clicked Receive events where a user clicked on a Launcher

Onboarding

Onboarding Task Started Receive events where a specific Onboarding Task started
Onboarding Task Completed Receive events where a specific Onboarding Task was completed

ShoutOut

Shoutout Action Clicked Receive events where a user clicked on a Shoutout
Shoutout Dismissed Receive events when Shoutout Dismissed
Shoutout Goal Reached Receive events when Goals you’ve set to a Shoutout
Shoutout Shown Receive events where a Shoutout was shown to the User

SmartTip

SmartTip Message Shown Receive events where a SmartTip message was shown to the user
SmartTip Validation Error Receive events where a SmartTip Validation rule was triggered

Survey

Survey Question Answered Receive events where a user answered a specific question
Survey Dismissed Receive events where a user started a survey but didn’t submit it
Survey Started Receive events where a user started a survey
Survey Submitted Receive events where a user submitted a survey

Help Desk

Help Desk Clicked Receive evetns where a user clicked on the Help Desk Integration initiator

Menu

Menu Opened Receive events where WalkMe’s menu was opened
Menu Search Receive events where the search bar was used
Menu Item Selected Receive events where a search result was selected by the user

Live Chat

Live Chat Clicked Receive events where a user clicked on the Live Chat Integration initiator

Shuttle

Shuttle Clicked Receive events where a Shuttle was used
Shuttle Goal Reached Receive events where a shuttle goal was reached

Resource

Resource Clicked Receive events where a Resource was used
Resource Goal Reached Receive evetns where a resource goal was reached

WalkMe

WalkMe content was visible Receive a daily event when user had WalkMe content visible (once in 24H)

UBT

(User behaviour tracking)

Click/Tap Receive events when an element of the site was clicked or tapped
User Input Receive events when an input field was interacted with.
Page View Receive events when a page of the site was viewed

 

Was this article helpful?

Related Articles