Configuring a Webhook

With webhooks, users can receive real-time event notifications associated with demo engagement. Receiving alerts about users who viewed your demo enables you to employ this data for lead generation, CRM reporting, or internal analysis. 

Adding a Webhook

Navigate to the Webhooks tab within your company page. 

Select to setup the endpoint URL to receive notification requests. 

Hit save once you've entered your URL endpoint and ensure that your webhook was successfully created without any error. You can there share your key, and send a test event. 

You can always return to the webhooks tab within the settings page to create a new setup. Additionally, from here you can also edit your live webhook, test the connection, delete or disable it. 

Important to Note 📝

• Walnut sends a webhook notification as soon as all the data from the payload is available. In case of demo play, which contains calculated analytical data, it can take up to two hours to receive the notification.
• The payload example will contain the following parameters: 

{
  "data": {
    "demo": {
      "id": "",
      "name": " ",
      "template_id": "",
      "template_name": ",
      "url": ""
    },
    "demo_engagement": {
      "fab_clicks": ,
      "guides_completion_rate": ,
      "last_guide_shown":,
      "last_section_viewed":,
      "screen_completion_rate": ,
      "session_duration": 
    },
    "session_id": "",
    "session_started": "",
    "user": {
      "email": "",
      "user_agent": ""
    }
  },
  "event": "demo_session_finished",
  "timestamp": ""
}