Brief Overview
Make data-driven decisions in real-time or trigger experiences on the spot by creating and customizing 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?
Use Cases
- Integrate WalkMe Event data into your analytics BI tool
- Add users to an email list directly when a user engages with WalkMe
- Instantly send notifications directly to Slack channels after users take action
Steps For Sending WalkMe Data Using Webhooks
-
- Sign into your Insights account;
- Click Integrations in the left sidebar:
- Click Webhooks:
- Click + NEW WEBHOOK:
- This will initiate the webhook creation wizard.
- Give your webhook a name you will be able to identify it by later:
- Click CONTINUE.
- Complete the webhook wizard’s first step—Select Event:
- Select a WalkMe Event from the Event dropdown menu:
- After selecting the WalkMe Event, select a statement condition and input if applicable:
- 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.
- 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.
- Select a WalkMe Event from the Event dropdown menu:
- Complete the webhook wizard’s second step—Select Destination:
- 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.):
- 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.
- Select an authentication type and enter values (OPTIONAL);
- Consult to the destination system’s API documentation to understand if this is necessary.
- WalkMe supports the following authentication methods:
- No Auth
- Bearer Token- requires a token
- Basic Auth – requires user name and password
- OAuth 2.0
- 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.
- Review your information, and click the SAVE button.
- You will now receive a popup telling you you need to blank publish in the Editor. Please do so:
- 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.):
- Sign into your Insights account;
Pro-Tip: You can manage your destinations in the DESTINATIONS settings screen in the Webhooks Integrations section in Insights:
-
- Publish your webhook (ONLY IF IT’S YOUR FIRST WEBHOOK):
- Sign in to your WalkMe Editor account.
- Click Menu in the blue Admin Bar:
- Select the environment to which you want to publish the webhook.
- Uncheck all items, and click the Publish button.
- This is called a “blank publish,” since you haven’t published any WalkMe items.
- This is called a “blank publish,” since you haven’t published any WalkMe items.
- Verify that you’ve successfully configured the webhook as follows:
- Enter your application.
- Perform the event the webhook is tracking.
- Check that the destination system you’ve configured receives the webhook call and executes the desired outcome.
- Publish your webhook (ONLY IF IT’S YOUR FIRST WEBHOOK):
List of Available Events
The below table displays all options available for creating webhook events:
Group | Name | Description |
Smart Walk-Thru |
Smart Walk-Thru Step Played | Receive Events with a specific Smart Walk-Thru Step |
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 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 Submitted | Receive events where a user submitted a survey | |
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 | |
Shuttle |
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 events where a resource goal was reached | |
TeachMe
|
TeachMe was visible | Receive events when a TeachMe course was visible |
TeachMe step started | Receive events when a TeachMe step started | |
TeachMe Course started |
Receive events when a TeachMe course started | |
TeachMe course completion | Receive events when a TeachMe course was completed | |
Quiz played | Receive events when a quiz was played | |
Quiz submitted | Receive events when a quiz was submitted | |
Quiz passed | Receive events when a quiz was submitted and passed | |
Quiz failed | Receive events when a quiz was submitted and failed | |
Digital Experience Analytics (DXA) (previously known as UBT) |
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 |