How to Configure a Webhook

The subscription method means that you can decide which webhooks are active - you do not receive data from the ones you are not interested in.

You can subscribe to the webhook in two ways.

One way is to use the admin panel, which will allow you to configure webhooks using a graphical interface, and the second is to use the endpoint.

To get to Webhooks in the admin panel head to Webhooks

• Webhook name - Webhook name in the system

• Active from - Date of webhook activation

• Legacy - Information is webhook is working in the Legacy mode

• URL - Address to which the webhook is sent

To make it easier to search for a specific webhook, you can use filtering based on the headers or use a search table in the upper right corner:

Adding a new webhook subscription

To add a new webhook subscription:

1. log in to the app as an Administrator

2. Go to Webhooks

3. Click the ADD NEW WEBHOOK button

4. Fill in the required fields

5. Click ADD WEBHOOK

From the dropdown list choose the webhook you'd like to subscribe to. Enter the address to which the webhooks will be sent. In addition, you can add multiple headers to the webhook however, it is not required by the system.

After saving, when the correct event is executed, the webhook will be sent to the previously entered address.

You can also subscribe to the webhook by using the endpoint:

/api/{storeCode}/webhook/subscription

Get all webhook subscriptions.

If sorting is not chosen, the rows will be returned in an unspecified order.
To sort a result, use an _orderBy parameter in query.

get

/api/{storeCode}/webhook/subscription

Authorizations

Path parameters

storeCodestringrequired

Store code

Query parameters

urlstring

legacyboolean

eventNamestring

createdAtstring · date-time

_pageinteger

_itemsOnPageinteger

_orderBystring

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://openloyalty.localhost/api/{storeCode}/webhook/subscription' \
  --header 'Authorization: YOUR_API_KEY'

200

401

403

200

{
  "total": {
    "all": 1,
    "filtered": 1
  },
  "items": [
    {
      "webhookSubscriptionId": "text",
      "eventName": "text",
      "url": "text",
      "headerName": "text",
      "headerValue": "text",
      "legacy": true,
      "createdAt": "2025-02-28T12:05:07.684Z"
    }
  ]
}

List of webhook subscriptions

Create a new webhook subscription

post

/api/{storeCode}/webhook/subscription

Authorizations

Path parameters

storeCodestringrequired

Store code

Body

webhookSubscriptionobject

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://openloyalty.localhost/api/{storeCode}/webhook/subscription' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "webhookSubscription": {
      "eventName": "text",
      "url": "text",
      "headerName": "text",
      "headerValue": "text",
      "headers": [
        {
          "headerName": "text",
          "headerValue": "text"
        }
      ]
    }
  }'

200

400

401

403

200

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

Return created webhook subscription ID.

In the body request, put the name of the webhook in eventName and the address of the service you want the data to be sent to in the URL

Webhook body example

Webhook 'account.available_points_amount_changed' automatically informs whenever the number of available points in a user's account changes. The update information is presented in the form of a body containing the following information.

{
"eventName": "string",
"storeCode": "string",
"createdAt": "2019-08-24T14:15:22Z",
"data": {
"customer": {},
"accountId": "string",
"amount": null,
"amountChange": null,
"amountChangeType": "string",
"wallet": {}
}

Webhook can be used as a trigger to execute an action on the user side of the application.