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.

get

Authorizations

Path parameters

storeCodestringRequired

Store code

Responses

200

List of webhook events

application/json

401Error

application/json

403

Forbidden.

application/json

get

HTTPcURLJavaScriptPython

GET /api/{storeCode}/webhook/event HTTP/1.1
Host: openloyalty.localhost
Authorization: YOUR_API_KEY
Accept: */*

{
  "items": [
    "text"
  ]
}

Create a new webhook subscription

post

Authorizations

Path parameters

storeCodestringRequired

Store code

Body

Responses

200

Return created webhook subscription ID.

application/json

400

Bad request.

application/json

401Error

application/json

403

Forbidden.

application/json

post

HTTPcURLJavaScriptPython

POST /api/{storeCode}/webhook/subscription HTTP/1.1
Host: openloyalty.localhost
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "webhookSubscription": {
    "eventName": "text",
    "url": "text",
    "headers": [
      {
        "headerName": "text",
        "headerValue": "text"
      }
    ]
  }
}

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

---

More resources

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

WebhooksIn this section, you will learn about webhook integrations and notifications in Open Loyalty.