Using Webhooks

Use webhooks to be notified of changes in the Limio application.

You can use webhooks within the Limio application to be notified anytime a specific event occurs. Limio can be configured to make a call to a webhook whenever any significant event occurs, which can then be handled by a designated endpoint in your application. You just need to specify the URL that needs to receive the data within the settings of the Limio application. Every time that event occurs in Limio, Limio will going to make a call to that endpoint sending the JSON object involved in the action.

Here is an example of the URL you have to set in the Webhooks fields: https://your-domain.com/your-endpoint

Why webhooks?

Webhooks are intended to be used for background tasks and asynchronous changes. A key use case is to notify a third-party application such as a billing or entitlement that a new order has been created or a subscription has been changed, and needs to be added to the third-party systems.

List of events that will trigger a webhook

Below you will find all the Webhooks that Limio offers you to configure and a brief description of each one.

Customer

Customer Created / Updated

This webhook is used to receive the Customer object after a Cusotmer gets created or updated when a new Subscription is created through the Limio Shop or the Limio Checkout for Salesforce.

Subscription

Subscription Created

This webhook is used to receive the Subscription object after a Subscription gets created using the Limio Shop, Manage My Account functionalities, or the Limio Checkout for Salesforce.

Order

The Order object has five Webhooks that get activated for different reasons.

Address Change

This webhook is used to receive the Order object after the Address gets updated using the Limio Shop or Manage My Account functionalities.

Payment Method Change

This webhook is used to receive the Order object after the Payment Method gets updated using the Limio Shop, or Manage My Account functionalities, or the Limio Checkout for Salesforce.

Subscription Offer Change

This webhook is used to receive the Order object after the Subscription Offer gets updated using the Limio Shop or Manage My Account functionalities.

Subscription Offer Addition

This webhook is used to receive the Order object after a new Subscription Offer is added using the Limio Shop or Manage My Account functionalities.

Subscription Cancellation

This webhook is used to receive the Order object after the Subscription is cancelled using the Limio Shop or Manage My Account functionalities.

Order Submitted

This webhook is used to receive the Order object after the Order is submitted by the customer using the Limio Shop.

Events

There are four types of events that trigger a Webhook:

Checkout Initiated

This webhook is used to receive the Event object after the Checkout is initiated by the customer using the Limio Shop.

Cancel Attempted

This webhook is used to receive the Event object after the Customer attempted to cancel the subscription.

Payment Method Added

This webhook is used to receive the Event object after a Payment Method is added by the customer using the Limio Shop.

Address Added

This webhook is used to receive the Event object after an Address is added by the customer using the Limio Shop.

Webhook event format

The body will have the body of the edited item. Here is an example of a Subscription Object being sent after a Subscription Created event:

{
"name": "string",
"tracking": {
"offers": [
"string"
],
"campaign": "string",
"tag": "string"
},
"offer": {
"name": "string",
"path": "string",
"parent_path": "string",
"id": "string",
"data": {
"created": "datetime",
"description": "string",
"team": "string",
"validFrom": "datetime",
"duplicatedFrom": "string",
"type": "string",
"record_type": "string",
"tags": [
"string"
],
"segments": [
"string"
],
"products": [
"string"
],
"baseTemplate": "string",
"childSorting": {
"offer-path": "number"
},
"familyName": "string",
"name": "string",
"modified": "datetime",
"attributes": {
"offer's attributes"
},
"headline": "string",
"user": "string",
"status": "string",
"validTo": "datetime",
"subline": "string"
},
"type": "item"
},
"quantity": "number",
"termEndDate": "datetime",
"price": {
"summary": {
"headline": "string"
},
"currency": "string",
"amount": "number"
},
"selectedProducts": {},
"details": null,
"id": "string",
"purchaseCountry": "string",
"startDate": "datetime",
"products": []
}