Webhooks
In this section, you will learn about webhook integrations and notifications in Open Loyalty.
Webhooks Overview
Webhooks is a mechanism allowing us to send HTTP requests to the URL configured by Admin, triggered by an Event, such as customer registration, transaction creation, customer data edit, etc. The new webhook mechanism is based on subscriptions to individual events occurring in the system. The following webhooks are accessible using the subscription method:
TransactionRegistered
PointsWillExpire
LevelWillExpire
AvailablePointsAmountChanged
TransactionAssignedToCustomer
RewardRedemptionStatusChanged
CampaignEffectWasApplied
CustomerWasRegisteredWithoutActivation
CustomerUpdated
CustomerRequestedSendActivationCode
CustomerRequestedPasswordReset
CustomerRegistered
CustomerPhoneNumberWasChanged
CustomerLevelChanged
CustomerEmailWasChanged
CustomerDeactivated
CustomerBoughtReward
CouponWillExpire
To enable gradual migration to the new mechanism, we have prepared a legacy mode, thanks to which the data sent in webhooks are in the same format as in the earlier version of the system.
How to configure the webhooks?
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:
log in to the app as an Administrator
Go to Webhooks
Click the ADD NEW WEBHOOK button
Fill in the required fields
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:
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.
Webhook can be used as a trigger to execute an action on the user side of the application.
Webhooks trigger actions
In this section, you can review the actions that trigger specific webhooks. This will help you choose the best options for your marketing automation.
Webhook Name | Trigger Actions |
---|---|
TransactionRegistered | Transaction registered when creating transactions:
|
PointsWillExpire | Webhook is triggered X days before the units expire depending on the setup in the Expiring Notifications -> Expiring units notifications. |
LevelWillExpire | Webhook is triggered X days before the tier recalculation depending on the setup in the Expiring Notifications -> Tier recalculation notification |
AvailablePointsAmountChanged |
|
TransactionAssignedToCustomer |
|
RewardRedemptionStatusChanged |
|
CampaignEffectWasApplied | The member receives points/ rewards or member custom attributes from the campaign. Example flow here. |
CustomerWasRegisteredWithoutActivation | Member created without activation using the endpoint: POST/api/{storeCode}/member/register |
CustomerUpdated |
The above actions can be taken in the Admin Panel or via API. |
CustomerRequestedSendActivationCode |
|
CustomerRequestedPasswordReset | An active member who has been created within the endpoint: POST/api/{storeCode}/member/register requests a password reset using POST/api/{storeCode}/member/password/reset/reque |
CustomerRegistered |
|
CustomerPhoneNumberWasChanged |
|
CustomerLevelChanged |
The above actions can be taken in the Admin Panel or via API. |
CustomerEmailWasChanged |
|
CustomerDeactivated |
|
CustomerBoughtReward |
The above actions can be taken in the Admin Panel or via API. |
CouponWillExpire |
|
Expiring Notifications
Available in Webhooks -> EXPIRING NOTIFICATIONS in the upper right corner.
Set when the system will send messages to Members regarding their Units, coupons, and Tier recalculating.
Days before expiring Units to notify the user
Days before expiring coupons to notify the user
Days before Tier recalculation to notify the user
Just set the number of days that suit you and click the 'Save Settings' button.
Last updated