> For the complete documentation index, see [llms.txt](https://help.openloyalty.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.openloyalty.io/implementation-guide/reference/webhook-events.md).

# Webhook Events

Every Open Loyalty webhook event, grouped by area, with what it's typically used for and which events overlap.

Open Loyalty sends 31 webhook events. This page groups them and says what each is typically used for in an implementation. For exactly which actions fire an event, see the User Guide's [What triggers a webhook](https://help.openloyalty.io/integrations-and-data-exchange/webhooks/what-triggers-a-webhook); for payloads, the [API docs](https://apidocs.openloyalty.io/#tag/Webhook-event). How to receive webhooks reliably is covered in [Webhooks & CRM sync](https://help.openloyalty.io/implementation-guide/module-checklists/webhooks-and-crm-sync.md).

## Members

| Event                                                                                                                                        | Typical use                                                            |
| -------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| [CustomerRegistered](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/CustomerRegistered)                                         | Mark the contact as a loyalty member in CRM; start the welcome journey |
| [CustomerWasRegisteredWithoutActivation](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/CustomerWasRegisteredWithoutActivation) | Self-registration flows that need activation                           |
| [CustomerRequestedSendActivationCode](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/CustomerRequestedSendActivationCode)       | Deliver the activation code by email or SMS                            |
| [CustomerRequestedPasswordReset](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/CustomerRequestedPasswordReset)                 | Deliver the password reset message                                     |
| [CustomerUpdated](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/CustomerUpdated)                                               | Keep the CRM profile in step (ignore echoes of your own changes)       |
| [CustomerEmailWasChanged](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/CustomerEmailWasChanged)                               | Confirm an email change made by the member                             |
| [CustomerPhoneNumberWasChanged](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/CustomerPhoneNumberWasChanged)                   | Confirm a phone change made by the member                              |
| [CustomerDeactivated](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/CustomerDeactivated)                                       | Stop loyalty messaging for the contact                                 |

## Units and transactions

| Event                                                                                                                      | Typical use                                                                                                                                           |
| -------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| [WalletBalanceUpdated](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/WalletBalanceUpdated)                   | Keep the balance in CRM — per wallet, with the balance before and after                                                                               |
| [AvailablePointsAmountChanged](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/AvailablePointsAmountChanged)   | Fired for the same changes as `WalletBalanceUpdated` (see the triggers page) — subscribe to one of the two, not both                                  |
| [UnitsTransferWasAdded](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/UnitsTransferWasAdded)                 | React to individual unit transfers (e.g. audit or finance feeds)                                                                                      |
| [PointsWillExpire](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/PointsWillExpire)                           | Expiry reminders — timing set in [Expiring notifications](https://help.openloyalty.io/integrations-and-data-exchange/webhooks/expiring-notifications) |
| [TransactionRegistered](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/TransactionRegistered)                 | Purchase confirmations; feeding a data platform                                                                                                       |
| [TransactionAssignedToCustomer](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/TransactionAssignedToCustomer) | Tell a member a claimed purchase now counts                                                                                                           |

## Campaigns, challenges and tiers

| Event                                                                                                                                  | Typical use                                                                                                                                                                                                                                 |
| -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [CampaignEffectWasApplied](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/CampaignEffectWasApplied)                       | Earn messages ("you earned…", badges, rewards from campaigns). Not sent for events registered through the [Real-Time API](https://help.openloyalty.io/technical-guide/integration/real-time-api), which returns the effects in its response |
| [MemberChallengeProgressWasChanged](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/MemberChallengeProgressWasChanged)     | Mission progress messages                                                                                                                                                                                                                   |
| [ChallengesWereProcessed](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/ChallengesWereProcessed)                         | Challenge processing results — see the payload in the API docs before relying on it                                                                                                                                                         |
| [CustomerLevelChanged](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/CustomerLevelChanged)                               | Tier on the CRM contact; upgrade and downgrade messages                                                                                                                                                                                     |
| [LevelWillExpire](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/LevelWillExpire)                                         | "Keep your tier" reminders before recalculation                                                                                                                                                                                             |
| [SegmentMembershipDropped](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/SegmentMembershipDropped)                       | Remove the member from a CRM audience built from a segment                                                                                                                                                                                  |
| [MemberAchievementProgressWasChanged](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/MemberAchievementProgressWasChanged) | Legacy achievements — use the challenge events for new work                                                                                                                                                                                 |
| [AchievementsWereProcessed](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/AchievementsWereProcessed)                     | Legacy achievements                                                                                                                                                                                                                         |

## Rewards and coupons

| Event                                                                                                                      | Typical use                                                                 |
| -------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| [CustomerBoughtReward](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/CustomerBoughtReward)                   | Voucher emails with the coupon code; passing physical rewards to fulfilment |
| [RewardRedemptionStatusChanged](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/RewardRedemptionStatusChanged) | Shipping and fulfilment updates to the member                               |
| [CouponWillExpire](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/CouponWillExpire)                           | "Use your voucher" reminders                                                |

## Configuration changes

| Event                                                                                                                                                                                                      | Typical use                               |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| [CampaignCreated](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/CampaignCreated), [CampaignUpdated](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/CampaignUpdated)             | Refresh cached campaign lists in channels |
| [RewardCreated](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/RewardCreated), [RewardUpdated](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/RewardUpdated)                     | Refresh cached catalogues                 |
| [AchievementCreated](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/AchievementCreated), [AchievementUpdated](https://apidocs.openloyalty.io/#tag/Webhook-event/operation/AchievementUpdated) | Legacy achievements                       |

{% hint style="info" %}
Every payload carries a `messageId` (use it to drop duplicates), an `eventName`, the `storeCode` and `createdAt`. Subscribe only to events a downstream system uses.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.openloyalty.io/implementation-guide/reference/webhook-events.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
