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

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. 1. Sign into your Insights account (both old and new Insights are supported):
      
      
   2. Click Webhooks in the left-sidebar:
      
      
   3. Click CREATE NEW INTEGRATION:
      
      
      • This will initiate the webhook creation wizard.
   4. Give your webhook a name you will be able to identify it by later:
      
   5. Click CONTINUE.
   6. Complete the webhook wizard’s first step—Define Event:
      1. Enter a name in the Event Name field. This name should be specific enough to identify which event you are registering to:
         
      2. Click the dropdown menu under the Definition section and select a WalkMe Event whose occurrence you would like to trigger a notification:
         
      3.  After selecting the WalkMe Event, select a statement condition and input if applicable:
         
      4.  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.
   7. Complete the webhook wizard’s second step—Set 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. Enter an authentication key and value (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:
         
         • Note: You can manage your destinations in the DESTINATIONS settings screen in the Webhooks Integrations section in Insights:
           
   8. Publish your webhook (ONLY IF IT’S YOUR FIRST WEBHOOK):
      1. Sign into your WalkMe Editor account.
      2. Click Publish 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.
   9. 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.