Behavioral Action Trigger
š Purpose
Behavioral action offers allow you to reward a customer with points or a coupon for completing an action. Once the behavioral action campaign is setup, the trigger API is called to issue the reward to the customer's wallet. This API will use a customer's identity value and the action's reference to identify which behavioral action to issue. You can find additional details on this API reference: Create Behavioral Action Trigger.
š¼ Recipe Overview
This recipe covers how to:
- Trigger a points reward behavioral action using a reference as postTransactionSurvey
- Trigger a coupon reward behavioral action using a reference as productReviewSubmit
Once complete, your customer will have a reward coupon issued and a points reward added to their wallet.
š Prerequisites
- Eagle Eye API credentials
- An active company unit with 3-level hierarchy
- A wallet with an active loyalty points account
- Active behavioral action campaigns to issue points and a coupon from
š¤ Outputs
After completing this recipe, capture the following output:
| Output Name | Purpose |
|---|---|
| accountId | Used to make account specific API calls, such as crediting points |
š Steps
Step 1: Setup the triggers API call
The triggers.reference in this API call refers to the offer.actions.reference from the behavioral action campaign. In this recipe we will use the references from these two campaign ingredients:
- Behavioral Action Points Reward
- Behavioral Action Coupon Reward
- 1.1 Set an identity from the wallet as the indentityValue
- 1.2 Insert the appropriate campaign actions reference as the trigger.reference for this API call.
Step 2: Call POST /services/trigger for the points reward
reference as productReviewSubmit
{
"walletTransaction": {
"reference": "{{uniqueReference}}"
},
"identityValue": "{{identityValue}}",
"triggers": [
{
"reference": "postTransactionSurvey"
}
]
}{
"walletTransactionId": "583782697",
"parentWalletTransactionId": "0",
"walletId": "258079427",
"reference": "546e18cc-1ac9-4df6-830d-54c1f037d780",
"transactionDateTime": "2026-05-01T17:56:57+00:00",
"transactionDateTimeOffset": "+00:00",
"identityId": "210871487",
"identity": null,
"type": "BEHAVIOURAL_ACTION_POINTS",
"status": "SETTLED",
"meta": null,
"state": "ORIGINAL",
"expiryDate": null,
"accounts": [
{
"accountTransactionId": "10051229877",
"parentAccountTransactionId": "",
"accountId": "5005705323",
"account": {
"accountId": "5005705323",
"walletId": "258079427",
"campaignId": "102607166",
"type": "BEHAVIOURAL_ACTION",
"clientType": "BEHAVIOURAL_ACTION",
"status": "ACTIVE",
"state": "LOADED",
"dates": {
"start": "2026-05-01T17:56:57+00:00",
"end": "2038-01-19T03:14:07+00:00"
},
"meta": [],
"dateCreated": "2026-05-01T17:56:57+00:00",
"lastUpdated": "2026-05-01T17:56:57+00:00",
"overrides": [],
"balances": {
"available": 0,
"refundable": 0
},
"relationships": [],
"mobileWallet": "https://sb.uk.mypass.is/a/5005705323/66a05eceb84342c"
},
"event": "CREATE",
"value": 0,
"source": 1,
"balancesBefore": {
"available": 0,
"refundable": 0
},
"balancesAfter": {
"available": 0,
"refundable": 0
},
"transactionDetails": [],
"properties": [],
"dateCreated": "2026-05-01T17:56:57+00:00",
"lastUpdated": "2026-05-01T17:56:57+00:00"
},
{
"accountTransactionId": "10051229878",
"parentAccountTransactionId": "",
"accountId": "5005705323",
"account": {
"accountId": "5005705323",
"walletId": "258079427",
"campaignId": "102607166",
"type": "BEHAVIOURAL_ACTION",
"clientType": "BEHAVIOURAL_ACTION",
"status": "USED",
"state": "LOADED",
"dates": {
"start": "2026-05-01T17:56:57+00:00",
"end": "2038-01-19T03:14:07+00:00"
},
"meta": [],
"dateCreated": "2026-05-01T17:56:57+00:00",
"lastUpdated": "2026-05-01T17:56:57+00:00",
"overrides": [],
"balances": {
"available": 0,
"refundable": 0
},
"relationships": [],
"mobileWallet": "https://sb.uk.mypass.is/a/5005705323/66a05eceb84342c"
},
"event": "REDEEM",
"value": 250,
"source": 1,
"balancesBefore": {
"available": 0,
"refundable": 0
},
"balancesAfter": {
"available": 0,
"refundable": 0
},
"transactionDetails": [],
"properties": [],
"dateCreated": "2026-05-01T17:56:57+00:00",
"lastUpdated": "2026-05-01T17:56:57+00:00"
},
{
"accountTransactionId": "10051229879",
"parentAccountTransactionId": "",
"accountId": "4997791003",
"account": {
"accountId": "4997791003",
"walletId": "258079427",
"campaignId": "102511482",
"type": "POINTS",
"clientType": "RETAILPOINTS",
"status": "ACTIVE",
"state": "EARNBURN",
"dates": {
"start": "2026-04-21T14:41:06+00:00",
"end": "2038-01-19T03:14:07+00:00"
},
"meta": [],
"dateCreated": "2026-04-21T14:41:06+00:00",
"lastUpdated": "2026-05-01T17:56:57+00:00",
"overrides": [],
"balances": {
"current": 11550,
"usable": 11550,
"locked": 0,
"lifetime": 12250,
"lifetimeSpend": 700,
"lifetimeSpendValue": 700,
"pending": 0
},
"relationships": [],
"mobileWallet": "https://sb.uk.mypass.is/a/4997791003/dd36d9cf03339af"
},
"event": "CREDIT",
"value": 250,
"source": 1,
"balancesBefore": {
"current": 11300,
"lifetime": 0
},
"balancesAfter": {
"current": 11550,
"lifetime": 0
},
"transactionDetails": [],
"properties": [],
"dateCreated": "2026-05-01T17:56:57+00:00",
"lastUpdated": "2026-05-01T17:56:57+00:00"
}
],
"basket": {
"contents": null,
"summary": {
"points": {
"spend": 0,
"debit": 0,
"refund": 0,
"totalPointsTaken": 0,
"earn": 0,
"credit": 250,
"totalPointsGiven": 250,
"totalMonetaryValue": 0
}
},
"payment": null
},
"channel": "api",
"location": {
"storeId": null,
"storeParentId": null
},
"dateCreated": "2026-05-01T17:56:57+00:00",
"lastUpdated": "2026-05-01T17:56:57+00:00"
}Step 3: Call POST /services/trigger for the coupon reward
Set the triggers.reference as productReviewSubmit.
{
"walletTransaction": {
"reference": "{{uniqueReference}}"
},
"identityValue": "{{identityValue}}",
"triggers": [
{
"reference": "productReviewSubmit"
}
]
}{
"walletTransactionId": "583782689",
"parentWalletTransactionId": "0",
"walletId": "258079427",
"reference": "0f9ceb4c-6db1-4ed7-b631-7c2288611a6c",
"transactionDateTime": "2026-05-01T17:51:33+00:00",
"transactionDateTimeOffset": "+00:00",
"identityId": "210871487",
"identity": null,
"type": "BEHAVIOURAL_ACTION_COUPON",
"status": "SETTLED",
"meta": null,
"state": "ORIGINAL",
"expiryDate": null,
"accounts": [
{
"accountTransactionId": "10051229826",
"parentAccountTransactionId": "",
"accountId": "5005705296",
"account": {
"accountId": "5005705296",
"walletId": "258079427",
"campaignId": "102685537",
"type": "BEHAVIOURAL_ACTION",
"clientType": "BEHAVIOURAL_ACTION",
"status": "ACTIVE",
"state": "LOADED",
"dates": {
"start": "2026-05-01T17:51:33+00:00",
"end": "2038-01-19T03:14:07+00:00"
},
"meta": [],
"dateCreated": "2026-05-01T17:51:33+00:00",
"lastUpdated": "2026-05-01T17:51:33+00:00",
"overrides": [],
"balances": {
"available": 0,
"refundable": 0
},
"relationships": {
"BEHAVIOURAL_ACTION_REWARD": {
"ECOUPON": [
{
"accountId": "5005705297",
"dateCreated": "2026-05-01T17:51:33+00:00"
}
]
}
},
"mobileWallet": "https://sb.uk.mypass.is/a/5005705296/f330d8864403807"
},
"event": "CREATE",
"value": 0,
"source": 1,
"balancesBefore": {
"available": 0,
"refundable": 0
},
"balancesAfter": {
"available": 0,
"refundable": 0
},
"transactionDetails": [],
"properties": [],
"dateCreated": "2026-05-01T17:51:33+00:00",
"lastUpdated": "2026-05-01T17:51:33+00:00"
},
{
"accountTransactionId": "10051229827",
"parentAccountTransactionId": "",
"accountId": "5005705296",
"account": {
"accountId": "5005705296",
"walletId": "258079427",
"campaignId": "102685537",
"type": "BEHAVIOURAL_ACTION",
"clientType": "BEHAVIOURAL_ACTION",
"status": "USED",
"state": "LOADED",
"dates": {
"start": "2026-05-01T17:51:33+00:00",
"end": "2038-01-19T03:14:07+00:00"
},
"meta": [],
"dateCreated": "2026-05-01T17:51:33+00:00",
"lastUpdated": "2026-05-01T17:51:33+00:00",
"overrides": [],
"balances": {
"available": 0,
"refundable": 0
},
"relationships": {
"BEHAVIOURAL_ACTION_REWARD": {
"ECOUPON": [
{
"accountId": "5005705297",
"dateCreated": "2026-05-01T17:51:33+00:00"
}
]
}
},
"mobileWallet": "https://sb.uk.mypass.is/a/5005705296/f330d8864403807"
},
"event": "REDEEM",
"value": 0,
"source": 1,
"balancesBefore": {
"available": 0,
"refundable": 0
},
"balancesAfter": {
"available": 0,
"refundable": 0
},
"transactionDetails": [],
"properties": [],
"dateCreated": "2026-05-01T17:51:33+00:00",
"lastUpdated": "2026-05-01T17:51:33+00:00"
},
{
"accountTransactionId": "10051229828",
"parentAccountTransactionId": "",
"accountId": "5005705297",
"account": {
"accountId": "5005705297",
"walletId": "258079427",
"campaignId": "102685536",
"type": "ECOUPON",
"clientType": "OFFER",
"status": "ACTIVE",
"state": "LOADED",
"dates": {
"start": "2026-05-01 17:51:33",
"end": "2026-12-31 23:59:00"
},
"meta": [],
"dateCreated": "2026-05-01T17:51:33+00:00",
"lastUpdated": "2026-05-01T17:51:33+00:00",
"overrides": {
"campaign": {
"rules": {
"useLocalTime": true
}
}
},
"balances": {
"available": 0,
"refundable": 0
},
"relationships": {
"BEHAVIOURAL_ACTION_REWARD_OF": {
"BEHAVIOURAL_ACTION": [
{
"accountId": "5005705296",
"dateCreated": "2026-05-01T17:51:33+00:00"
}
]
}
},
"mobileWallet": "https://sb.uk.mypass.is/a/5005705297/0fc7322be5ee577"
},
"event": "CREATE",
"value": 0,
"source": 1,
"balancesBefore": {
"available": 0,
"refundable": 0
},
"balancesAfter": {
"available": 0,
"refundable": 0
},
"transactionDetails": [],
"properties": [],
"dateCreated": "2026-05-01T17:51:33+00:00",
"lastUpdated": "2026-05-01T17:51:33+00:00"
}
],
"basket": {
"contents": null,
"summary": null,
"payment": null
},
"channel": "api",
"location": {
"storeId": null,
"storeParentId": null
},
"dateCreated": "2026-05-01T17:51:33+00:00",
"lastUpdated": "2026-05-01T17:51:33+00:00"
}ā
Business Readiness Checklist
Use these steps to validate the setup of your wallet and accounts:
- Call GET Get Account Transactions By Id to check for the points reward in the points account.
- Confirm the coupon account was created using GET wallet/{walletId}/account/{accountId}.
š§ Troubleshooting Tips
| Issue | Possible Cause & Resolution |
|---|---|
| Coupon not issued | Ensure the campaign is active |
| Invalid trigger action reference | Confirm that the behavioral action campaign is active and the triggers.reference is valid |
Updated 8 days ago