Event Definitions
AIR can trigger the following Event Notifications as part of each API's endpoints being called.
Please refer to the API reference for further endpoint details, and please note that this list does not cover our client-specific extensions (API Composites).
| Event Name | Description | Triggered By API Endpoint | AtomicOperationArrayItem(s) Object Type |
|---|---|---|---|
| CAMPAIGN.CREATE | A new Campaign was created | POST /campaigns | campaignEntity: CREATE |
| CAMPAIGN.UPDATE | An existing Campaign was updated. | campaignEntity: UPDATE | |
| CAMPAIGN.DELETE | An existing Campaign was deleted. | DELETE /campaigns/{campaignId} | campaignEntity: DELETE |
| PLAN.CREATE | A new Plan was created. | Dashboard Action | planEntity: CREATE |
| PLAN.UPDATE | An existing Plan was updated. | Dashboard Action | planEntity: UPdate |
| PLAN.DELETE | An existing Plan was deleted. | Dashboard Action | planEntity: DELETE |
| SCHEME.CREATE | A new Scheme was created. | POST /schemes | schemeEntity: CREATE |
| SCHEME.UPDATE | An existing Scheme was updated. | PUT /schemes/{schemeId} | schemeEntity: UPDATE |
| SCHEME.DELETE | An existing Scheme was deleted. | Dashboard action | schemeEntity: DELETE |
| ACCOUNT.MOVE.TO.WALLET | An Account that existed outside a wallet was moved in to a Wallet. | PATCH /account/{accountId}/move/to/wallet/{walletId} | walletAccountEntity: UPDATE walletAccountTransactionEntity: CREATE |
| FUND.CREATE | A new Fund was created. | Dashboard Action | fundEntity: CREATE |
| FUND.CREDIT | An existing Fund was credited. | Dashboard Action | fundTransactionEntity: CREATE |
| FUND.DEBIT | An existing Fund was debited. | Dashboard Action | fundTransactionEntity: CREATE |
| FUND.DELETE | An existing Fund was deleted. | Dashboard Action | fundEntity: DELETE |
| FUND.LOAD | An existing Fund was loaded. | Dashboard Action | fundTransactionEntity: CREATE |
| FUND.UNLOAD | An existing Fund was un-loaded. | Dashboard Action | fundTransactionEntity: CREATE |
| FUND.UPDATE | An existing Fund was amended. | Dashboard Action | fundEntity: UPDATE |
| POINTSREWARD.BANK.CREATE | A new Reward Bank was created. | POST /banks/pointsreward | pointsRewardBankEntity: CREATE |
| POINTSREWARD.BANK.UPDATE | An existing Reward Bank was updated. | PATCH /banks/pointsreward | pointsRewardBankEntity: UPDATE |
| POINTSREWARD.BANK.DELETE | An existing Reward Bank was deleted. | DELETE /banks/pointsreward | pointsRewardBankEntity: DELETE |
| POINTSREWARD.BANK.REWARD.CREATE | A new Reward for an existing Reward Bank was created. | POST /banks/pointsreward/reward | pointsRewardBankRewardEntity: CREATE |
| POINTSREWARD.BANK.REWARD.UPDATE | An existing Reward for an existing Reward Bank was updated. | PATCH /banks/pointsreward/reward | pointsRewardBankRewardEntity: UPDATE |
| POINTSREWARD.BANK.REWARD.DELETE | An existing Reward for an existing Reward Bank was deleted. | DELETE /banks/pointsreward/reward | pointsRewardBankRewardEntity: DELETE |
| POINTSREWARD.BANK.WALLET.LINK.CREATE | A new targeted link between a Wallet and Reward Bank was created. | POST /wallet/{walletId}/link/bank/pointsreward/{pointsRewardBankId} | pointsrewardBankWalletLinkEntity: CREATE |
| POINTSREWARD.BANK.WALLET.LINK.DELETE | An existing link between a Wallet and Reward Bank was deleted. | DELETE /wallet/{walletId}/link/bank/pointsreward/{pointsRewardBankId} | pointsrewardBankWalletLinkEntity: DELETE |
| POINTSREWARD.BANK.WALLET.LINK.UPDATE | An existing link between a Wallet and Reward Bank was updated. | PATCH /wallet/{walletId}/link/bank/pointsreward/link/{pointsRewardBankWalletLinkId} | pointsrewardBankWalletLinkEntity: UPDATE |
| POSCONNECT.MESSAGEATTILL.CREATE | Accounts were created and sent to be used in Message At Till | POST /connect/messages/create | walletAccountTransactionEntity: CREATE |
| POSCONNECT.MESSAGEATTILL.REPORT | Accounts were either activated or cancelled in Message At Till | POST /connect/messages/report | |
| POSCONNECT.WALLET.OPEN | Create a new POS transaction with or without adjudication. | POST /connect/wallet/open | walletTransactionEntity: CREATE walletAccountTransactionEntity: CREATE |
| POSCONNECT.WALLET.SETTLE | Settle a POS transaction. | POST /connect/wallet/settle POST /connect/wallet/opensettle | walletTransactionEntity: CREATE walletAccountTransactionEntity: CREATE walletAccountEntity: CREATE tierMembershipEntity: UPDATE tierMembershipTransactionEntity: CREATE |
| POSCONNECT.WALLET.REFUND | Refund an existing settled transaction. | POST /connect/wallet/refund | walletTransactionEntity: CREATE walletAccountTransactionEntity: UPDATE tierMembershipEntity: UPDATE tierMembershipTransactionEntity: CREATE |
| POSCONNECT.WALLET.SPEND | Spend points from a Points Account in your wallet. | POST /connect/wallet/spend | walletTransactionEntity: CREATE/UPDATE walletAccountTransactionEntity: UPDATE |
| POSCONNECT.WALLET.SPEND.VOID | Void a transaction where points have been spent. | POST /connect/wallet/spend/void | walletTransactionEntity: UPDATE |
| POSCONNECT.WALLET.FULFIL | Fulfil individual items within an ecommerce transaction. | POST /connect/wallet/fulfil | walletTransactionEntity: CREATE walletAccountTransactionEntity: UPDATE tierMembershipEntity: UPDATE tierMembershipTransactionEntity: CREATE |
| POSCONNECT.WALLET.PRODUCTEXCHANGE | Calculate loyalty changes when a product is exchanged | POST /connect/wallet/productExchange | |
| SERVICE.RECOMMENDATION.ACCEPT | An existing Recommendation was accepted and accounts have been created. | POST /services/wallet/{walletId}/catalogue/{catalogueGuid}/recommendation/{recommendationGuid}/accept | walletAccountEntity: CREATE walletAccountTransactionEntity: CREATE tierMembershipEntity: UPDATE tierMembershipTransactionEntity: CREATE |
| SERVICE.TRIGGER | A Behavioural Action has been triggered. | POST /services/trigger | walletAccountTransactionEntity: CREATE (One for the Create action and one for Redeem) walletAccountTransactionEntity: CREATE walletTransactionEntity: CREATE |
| SERVICE.WALLET.CREATE | Create a Wallet with one or more Identities within single API call | POST /services/wallet | walletEntity: CREATE walletEntity: UPDATE walletIdentityEntity: CREATE |
| SERVICE.WALLET.DELETE | Delete a Wallet and its contents. Wallet Consumer and Identities are deleted and Wallet Accounts are cancelled | DELETE /services/wallet/{walletId} | walletEntity: DELETE walletIdentityEntity: DELETE (One item for each identity) walletConsumerEntity: DELETE walletAccountEntity: UPDATE walletAccountTransactionEntity: UPDATE |
| SERVICE.WALLET.MERGE | Two Wallets were merged together. | PATCH /services/wallet/{victimWalletId}/merge/{survivorWalletId} | walletEntity: UPDATE walletAccountEntity: UPDATE walletAccountEntity: CREATE walletIdentityEntity: UPDATE walletIdentityEntity: CREATE walletAccountTransactionEntity: CREATE walletTransactionEntity: CREATE |
| SERVICE.WALLET.ACCOUNTS.CREATE | A new Wallet was created, along with one or more identities, one or more coupon accounts, one or more scheme accounts, and a consumer object. | POST /services/wallet/accounts | walletEntity: CREATE walletIdentityEntity: CREATE walletAccountTransactionEntity: CREATE walletConsumerEntity: CREATE tierMembershipEntity: CREATE |
| SERVICE.WALLET.BACKENDPOINTS | Update the balance of an existing Wallet Points Account. | POST /services/wallet/backendpoints | walletTransactionEntity: CREATE walletAccountTransactionEntity: UPDATE |
| SERVICE.WALLET.POINTS.EXPIRE | Expire points within a Wallet Points Account. | System Action | walletTransactionEntity: CREATE walletAccountTransactionEntity: UPDATE |
| SERVICE.WALLET.TRANSACTION.CREDIT | A Credit Wallet Transaction was created and points awarded to a points account in a wallet. | POST /services/wallet/{walletId}/transaction/credit | walletAccountEntit: UPDATE walletAccountTransactionEntity: CREATE walletTransactionEntity: CREATE |
| SERVICE.WALLET.TRANSACTION.DEBIT | A Debit Wallet Transaction was created and points removed from a points account in a wallet. | POST /services/wallet/{walletId}/transaction/debit | walletAccountEntity: UPDATE walletAccountTransactionEntity: CREATE walletTransactionEntity: CREATE |
| SERVICE.WALLET.TRANSACTION.GOODWILL | A Goodwill Wallet Transaction was created and points put into a points account with a good will transaction. | POST /services/wallet/{walletId}/transaction/goodwill | walletAccountEntity: CREATE walletAccountTransactionEntity: CREATE walletTransactionEntity: CREATE |
| WALLET.ACCOUNT.TRANSACTION.SPEND | A Spend Wallet Transaction was created and points spent from a points account in a wallet. | POST /services/wallet/{walletId}/transaction/spend | walletAccountEntity: UPDATE walletAccountTransactionEntity: CREATE walletTransactionEntity: CREATE |
| SERVICE.WALLET.TRANSACTION.REDEEM.CREDIT | A new Redeem_Credit Wallet Transaction was created. | POST /services/wallet/{walletId}/transaction/redeemCredit | walletTransactionEntity: CREATE walletAccountTransactionEntity: UPDATE walletTransactionEntity: UPDATE |
| WALLET.TRANSACTION.DONATE | A new Donate Wallet Transaction was created. | POST /services/wallet/{walletId}/transaction/donate | walletTransactionEntity: CREATE walletAccountTransactionEntity: CREATE |
| SERVICES.WALLET.TRANSACTION.EXCHANGE | An Exchange Wallet Transaction was created and points were taken from a points account in a wallet and a coupon created. | POST /services/wallet/{walletId}/transaction/exchange/pointsreward | walletTransactionEntity: CREATE walletAccountTransactionEntity: CREATE |
| SERVICE.WALLET.TRANSACTION.UNREDEEM | A wallet account was unredeemed and an UNREDEEM wallet transaction was created using a specific walletId and accountId. | POST /services/wallet/{walletId}/transaction/unredeem | walletAccountEntity: UPDATE walletAccountTransactionEntity: CREATE walletTransactionEntity: CREATE |
| SERVICE.WALLET.TRANSACTION.UPDATE | Update a transaction using the transaction reference if it has already been released, and at the same time will lock the specified Accounts in preparation for the given Account transactions. | walletTransactionEntity: UPDATE walletAccountEntity: UPDATE | |
| SUPPLIERUNIT.CREATE | A new Supplier Unit was created. | Dashboard Action | SupplierUnitEntity: CREATE |
| SUPPLIERUNIT.DELETE | An existing Supplier Unit was deleted. | Dashboard Action | SupplierUnitEntity: DELETE |
| SUPPLIERUNIT.UPDATE | An existing Supplier Unit was updated. | Dashboard Action | SupplierUnitEntity: UPDATE |
| WALLET.ACCOUNT.UPDATE | An Account in a wallet was updated. | PATCH /wallet/{walletId}/account/{accountId}/activate PATCH /wallet/{walletId}/account/{accountId}/update PATCH /wallet/{walletId}/account/{accountId}/block PATCH /wallet/{walletId}/account/{accountId}/inactivate PATCH /wallet/{walletId}/account/{accountId}/cancel PATCH /wallet/{walletId}/account/{accountId} | walletAccountTransactionEntity: UPDATE |
| WALLET.ACCOUNT.CREATE.CAMPAIGN | Create a Coupon Account and place into the corresponding Wallet. | POST /wallet/{walletId}/campaign/{campaignId}/account | walletAccountTransactionEntity: CREATE |
| WALLET.ACCOUNT.CREATE.CAMPAIGN | Create an entitlement account and attach it to an existing Plan Account in a wallet. | POST /wallet/{walletId}/account/{parentAccountId}/campaign/{campaignId}/account | walletAccountTransactionEntity: CREATE |
| WALLET.ACCOUNT.CREATE.PLAN | Create a Subscription Account with Entitlement Accounts (arisen from suplied Plan definition) and place them into the corresponding Wallet. | POST /wallet/{walletId}/plan/{planId}/account | walletAccountEntity: CREATE walletAccountTransactionEntity: CREATE |
| WALLET.ACCOUNT.CREATE.PROGRAMME | Create a Programme Account and place into the corresponding wallet | POST /wallet/{walletId}/programme/{programmeId}/account | walletAccountTransactionEntity: CREATE |
| WALLET.ACCOUNT.CREATE.SCHEME | Create a Loyalty Scheme Account and place into the corresponding wallet | POST /wallet/{walletId}/scheme/{schemeId}/account | walletAccountTransactionEntity: CREATE tierMembershipEntity: CREATE |
| WALLET.ACCOUNT.REFRESH | Refresh a Subscription Account for a corresponding Wallet. | PATCH /wallet/{walletId}/account/{accountId}/refresh | walletAccountEntity: UPDATE walletAccountTransactionEntity: UPDATE walletAccountEntity: CREATE walletAccountTransactionEntity: CREATE |
| WALLET.ACCOUNT.TRANSACTION.CREDIT | Credit a Wallet Account. Currently available for POINTS and CONTINUITY Accounts, along with all Stored Value Accounts. | PATCH /wallet/{walletId}/account/{accountId}/credit | walletAccountTransactionEntity: CREATE |
| WALLET.ACCOUNT.TRANSACTION.CREDIT.GOODWILL | Credit a Goodwill Points to a points Wallet Account. Please note Goodwill rules has to be defined for a Scheme. | PATCH /wallet/{walletId}/account/{accountId}/goodwill | walletAccountTransactionEntity: CREATE |
| WALLET.ACCOUNT.TRANSACTION.DEBIT | Debit a Wallet Account and create appropriate Account Transaction. Currently available for POINTS and CONTINUITY Accounts, along with all Stored Value Accounts. Please note: by default for Loyalty Points Accounts, EES AIR allows debits of an amount larger than the Account's available balance, which would result in a negative balance. This could be mitigated by EES Scheme settings:
| PATCH /wallet/{walletId}/account/{accountId}/debit | walletAccountTransactionEntity: CREATE |
| WALLET.ACCOUNT.TRANSACTION.EARN | Credit Points into Wallet Account and create a Wallet Account Transaction (with event=EARN) within EES AIR. Currently available for POINTS Accounts only. Please note: this endpoint accepts one of two mutualy exclusive Request Payload structures: one with explicit balance structure (the calling application need to provids explicit balance names and amounts), second one for instructing AIR to credit Points for an Account with the amounts calculated by EES AIR (referenced Point Schema Earn definitions(s) would be the base for this calclulation) | PATCH /wallet/{walletId}/account/{accountId}/earn | walletAccountTransactionEntity: CREATE |
| WALLET.ACCOUNT.TRANSACTION.LOAD | Load a Wallet Account. Currently available for Stored Value Account types. If the Account is INACTIVE, the load will activate it by default. | PATCH /wallet/{walletId}/account/{accountId}/load | walletAccountTransactionEntity: CREATE |
| WALLET.ACCOUNT.TRANSACTION.REDEEM | Redeem a Coupon using a Wallet Account. Currently available for ECOUPON and CONTINUITY Accounts. | PATCH /wallet/{walletId}/account/{accountId}/redeem | walletAccountTransactionEntity: UPDATE |
| WALLET.ACCOUNT.TRANSACTION.REFUND | Refund a Wallet Account. Currently available for Stored Value. | PATCH /wallet/{walletId}/account/{accountId}/refund | walletAccountTransactionEntity: UPDATE |
| WALLET.ACCOUNT.TRANSACTION.SPEND | Spend accumulated points. Please note a) this endpoint could be used only for Point Accounts b) this endpoint also allows to adjust other than current balance (i.e. lifetimeSpend or lifetimeSpendValue). | PATCH /wallet/{walletId}/account/{accountId}/spend | walletAccountTransactionEntity: CREATE |
| WALLET.ACCOUNT.TRANSACTION.TOPUP | Topup a Stored Value Wallet Account. A request to topup an INACTIVE Account will fail. A request to topup with a value of zero will be accepted. The value will be compared with programme rules. | PATCH /wallet/{walletId}/account/{accountId}/topup | walletAccountTransactionEntity: CREATE |
| WALLET.ACCOUNT.TRANSACTION.UNREDEEM | Unredeem a Wallet Account. Currently available for ECOUPON and CONTINUITY Accounts. | PATCH /wallet/{walletId}/account/{accountId}/unredeem | walletAccountTransactionEntity: CREATE |
| WALLET.ACCOUNT.TRANSACTION.VERIFY | Verify a transaction against the specified Wallet Account. | POST /wallet/{walletId}/account/{accountId}/verify | walletAccountTransactionEntity: UPDATE |
| WALLET.ACCOUNT.TRANSACTION.VOID | Void the specified Wallet Account Transaction. Currently only applicable for CONTINUITY and POINTS Accounts, along with all stored value Accounts. | PATCH /wallet/{walletId}/account/{accountId}/transaction/{accountTransactionId}/void | walletAccountTransactionEntity: CREATE |
| WALLET.ACCOUNT.UNBLOCK | Change the status of a Wallet Account from BLOCKED to ACTIVE. | PATCH /wallet/{walletId}/account/{accountId}/unblock | walletAccountTransactionEntity: CREATE walletAccountEntity: UPDATE |
| WALLET.CONSUMER.CREATE | A new Consumer record was created on an existing wallet. | POST /wallet/{walletId}/consumer | walletConsumerEntity: CREATE |
| WALLET.CONSUMER.DELETE | An existing Consumer was deleted from a wallet. | DELETE /wallet/{walletId}/consumer/{consumerId} | walletConsumerEntity: DELETE |
| WALLET.CONSUMER.UPDATE | Amend the Wallet Consumer details for a Wallet Consumer. | PATCH /wallet/{walletId}/consumer/{consumerId} | walletConsumerEntity: UPDATE |
| WALLET.CREATE | A new Wallet was created. | POST /wallet | walletEntity: CREATE |
| WALLET.DELETE | An existing Wallet was deleted. | DELETE /wallet/{walletId} | walletEntity: DELETE |
| WALLET.UPDATE | An existing Wallet was updated. | PATCH /wallet/{walletId}/activate | walletEntity: UPDATE |
| WALLET.IDENTITY.CREATE | A new Identity was created for the corresponding Wallet. | POST /wallet/{walletId}/identity | walletIdentityEntity: CREATE |
| WALLET.IDENTITY.DELETE | An existing Identity was deleted for the corresponding Wallet. | DELETE /wallet/{walletId}/identity/{identityId} | walletIdentityEntity: DELETE |
| WALLET.IDENTITY.UPDATE | An existing Identity was updated for the corresponding Wallet. | PATCH /wallet/{walletId}/identity/{identityId} PATCH /wallet/{walletId}/identity/{identityId}/suspend PATCH /wallet/{walletId}/identity/{identityId}/activate PATCH /wallet/{walletId}/identity/{identityId}/lost PATCH /wallet/{walletId}/identity/{identityId}/stolen | walletIdentityEntity: UPDATE |
| WALLET.INVITE.ACCEPT | A Wallet Invite has been accepted. | PATCH /wallet/{walletId}/invite/{walletInviteId}/accept | walletInviteEntity: UPDATE |
| WALLET.INVITE.CANCEL | A Wallet Invite has been cancelled. | PATCH /wallet/{walletId}/invite/{walletInviteId}/cancel | walletInviteEntity: UPDATE |
| WALLET.INVITE.CREATE | A new Wallet Invite has been created. | POST /wallet/{walletId}/invite | walletInviteEntity: CREATE |
| WALLET.INVITE.REJECT | A Wallet Invite has been rejected. | PATCH /wallet/{walletId}/invite/{walletInviteId}/reject | walletInviteEntity: UPDATE |
| WALLET.INVITE.UPDATE | A Wallet Invite has been updated. | walletInviteEntity: UPDATE | |
| WALLET.INVITE.VERIFY | A Wallet Invite has been verified. | GET /wallet/invite/verify | walletInviteEntity: READ |
| WALLET.RELATION | A new relationship was created between two Wallets. | PATCH /wallet/{walletId}/join/{relationshipWalletId}/child PATCH /wallet/{walletId}/join/{relationshipWalletId}/associate | walletEntity: UPDATE |
| WALLET.TRANSACTION.CANCEL | An existing Wallet Transactions status was changed to cancelled. | PATCH /wallet/{walletId}/transaction/{transactionId}/cancel | walletTransactionEntity: DELETE |
| WALLET.TRANSACTION.CREATE | A new Wallet Transaction was created. | POST /wallet/{walletId}/transaction | walletTransactionEntity: CREATE |
| WALLET.TRANSACTION.DELETE | An existing Wallet Transaction was deleted. | DELETE /wallet/{walletId}/transaction/{transactionId} | walletTransactionEntity: DELETE |
| WALLET.TRANSACTION.EXPIRE | An existing Wallet Transactions status was updated to expired. | PATCH /wallet/{walletId}/transaction/{transactionId}/expire | walletTransactionEntity: UPDATE |
| WALLET.TRANSACTION.GIFT | A new Gift Wallet Transaction was created. | POST /services/wallet/{{walletId}}/transaction/gift | walletTransactionEntity: CREATE walletTransactionEntity: UPDATE walletAccountTransactionEntity: UPDATE |
| WALLET.TRANSACTION.SETTLE | An existing Wallet Transactions status was updated to settled. | PATCH /wallet/{walletId}/transaction/{transactionId}/settle | walletTransactionEntity: UPDATE |
| WALLET.TRANSACTION.UPDATE | An existing Wallet Transaction was updated. | walletTransactionEntity: UPDATE | |
| TIER.MEMBERSHIP.ADJUST | An existing Tier Membership was adjusted. | PATCH /wallet/{walletId}/tier/membership/{tierMembershipId}/adjust | tierMembershipEntity: UPDATE tierMembershipTransactionEntity: CREATE |
| TIER.MEMBERSHIP.CREATE | A new Tier Membership was created. | POST /wallet/{walletId}/tier/{tierId}/membership | tierMembershipEntity: CREATE |
| TIER.MEMBERSHIP.CREDIT | An existing Tier Membership was credited. | PATCH /wallet/{walletId}/tier/membership/{tierMembershipId}/credit | walletEntity: READ tierMembershipEntity: UPDATE tierMembershipTransactionEntity: CREATE |
| TIER.MEMBERSHIP.DEBIT | An existing Tier Membership was debited. | PATCH /wallet/{walletId}/tier/membership/{tierMembershipId}/debit | tierMembershipEntity: UPDATE tierMembershipTransactionEntity: CREATE |
| TIER.MEMBERSHIP.MOVE | An existing Tier Membership was moved to another Tier. | PATCH /wallet/{walletId}/tier/membership/{tierMembershipId}/move | tierMembershipEntity: UPDATE tierMembershipTransactionEntity: CREATE |