Webhooks allow session analytics data to be automatically sent to your applications and systems when a session ends.
There are many ways you can push the data into your systems so you can process it in the way that you want. For example, you could use the data flows to replicate Zuko's reporting in your custom dashboard or 3rd party tool. Or, you could set up a webhook that feeds in Zuko Analytics metrics in to predictive model training data automatically as Zuko tracks and analyses your forms. If you have an idea on how you'd like to use the Zuko user behaviour data but are not sure if it will work, feel free to contact the team using email@example.com.
It doesn’t matter what programming language your systems use; pretty much any system can be extended to support receiving webhooks if it doesn’t already support them.
How to setup a webhook
From the Zuko App app, then choose your form.
Option the form settings by clicking the settings button at the top of the reports.
Select the Integrations tab at the top.
Enter your webhook endpoint in the Webhook section.
Save the change.
Now, when a session ends (abandons or completes), it will automatically be sent to the configured endpoint.
Points to note
Zuko Analytics will issue a standard HTTP POST request to your configured endpoint.
The request body will contain a JSON document containing the analytics data which Zuko has computed for the session.
The schema of this JSON document is explored in our Sessions API documentation here.
It’s imperative that your webhook endpoint is always up and running, ready to receive calls from Zuko Form Builder.
As soon as a session is completed or abandoned, we will send this event to your configured webhook endpoint. There may be events belonging to this session which arrive after the session is completed. If this happens, we will send an updated copy of the session to your webhook. Webhook consumers should therefore expect to receive each session at least once. Sessions can be identified by its id attribute.