Add Webhook

See the sample example how webhooks can be configured. Links to more detailed instructions can be found at the end of the article.

How this example works

Webhooks in Open Loyalty enable automated interactions by sending HTTP requests to specified URLs when certain events occur within the system. This feature allows for real-time notifications and integrations with external systems. For example, when a customer registers or a transaction is created, a webhook can notify a designated URL, triggering predefined actions such as updating records or sending notifications.

To receive webhooks for the following steps, we are going to set up two webhooks in this example.

---

Try yourself

• Input the previous saved token and storeCode in the request header

• Retrieve a list of available webhook events Endpoint: GET /api/{storeCode}/webhook/event

• Get the URL, where the webhooks are supposed to be sent to.

• Add these three webhooks Endpoint: POST /api/{storeCode}/webhook/subscription

  {
    "webhookSubscription": {
      "eventName": "CustomerRegistered",
      "url": "string" // your specified URL
    }
  }

  {
    "webhookSubscription": {
      "eventName": "CustomerRegistered",
      "url": "string" // your specified URL
    }
  }

  {
    "webhookSubscription": {
      "eventName": "MemberAchievementProgressWasChanged",
      "url": "string" // your specified URL
    }
  }

---

Endpoints used

Get all webhook events.

GEThttp://openloyalty.localhost/api/{storeCode}/webhook/event

Path parameters

storeCode*string

Store code

Response

200401403

List of webhook events

Body

application/json

itemsarray of string

Request

JavaScriptCurlPython

const response = await fetch('http://openloyalty.localhost/api/{storeCode}/webhook/event', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401403

{
  "items": [
    "text"
  ]
}

Create a new webhook subscription

POSThttp://openloyalty.localhost/api/{storeCode}/webhook/subscription

Path parameters

storeCode*string

Store code

Body

application/json

webhookSubscriptionCreateWebhookSubscriptionFormType (object)

Response

200400401403

Return created webhook subscription ID.

Body

application/json

webhookSubscriptionIdstring (uuid)

Example: "00000000-0000-0000-0000-000000000000"

Request

JavaScriptCurlPython

const response = await fetch('http://openloyalty.localhost/api/{storeCode}/webhook/subscription', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403

{
  "webhookSubscriptionId": "00000000-0000-0000-0000-000000000000"
}

---

More resources

For a detailed overview and description of the webhooks, please refer to this article:

WebhooksUser Guide