Webhook

    Webhook


    Article summary

    A webhook is a callback to an application or a web service that is triggered when a specific event occurs (e.g., campaign start/end) in the Shoplive service. A webhook delivers data to your applications as it happens, meaning you get data immediately, unlike typical APIs where you would need to poll for data very frequently to get it in real-time. A webhook will make an HTTPS request to your app (POST only), and you will then be charged with interpreting it.

    Webhook needs to be configured by Shoplive, so please contact ask@shoplive.cloud to configure the webhook endpoint on your platform. Currently, only the following events are available for webhook, but we will add more events in the near future.

    • Campaign start: returns Campaign object when any customer's campaign starts.

    • Campaign end: returns Campaign object when any customer's campaign ends.


    What's Next