Eagle Eye Behavioral Action Trigger¶
Eagle Eye is a loyalty and promotions platform. Its AIR platform manages loyalty wallets that track each customer’s earning and spending activity in a loyalty program.
Reward a member in the Eagle Eye AIR platform as soon as a real-time journey reaches an Activate node, using the Social Behavioral Action trigger endpoint. Each send triggers one Behavioral Action for one member. The member gets whatever that Behavioral Action’s campaign is configured to give: points, a coupon, or stamps.
This connector rewards members who already have a wallet; it does not create wallets or change their identities or state. To create and manage member wallets from a segment on a schedule, use the Eagle Eye destination. Both connectors use the same Eagle Eye credential, so a credential configured for one can be used by the other.
This connector sends from a real-time journey. See Real-time destinations.
Beta
The Eagle Eye Behavioral Action Trigger connector is in beta. Contact your Amperity representative to learn more.
Requirements¶
The Behavioral Action must already exist as a campaign in the Eagle Eye AIR dashboard, with an action reference. This connector triggers a Behavioral Action; it does not create one.
Each member must already have an Eagle Eye wallet with an identity whose value Amperity sends. A member with no wallet, or whose wallet is terminated, suspended, or deleted, is not rewarded.
For a Behavioral Action that rewards points, the member’s wallet must have an account in the points scheme the campaign credits. A send for a member without one fails without another attempt, and enrolling the member in the scheme afterwards does not reward that send. The member’s next entry into the journey is a new send, and is rewarded.
The credential must be allowed to trigger Behavioral Actions. Testing the connection reads a wallet, which confirms the Client ID, Client secret, and API URL but not this permission. A credential that may only read wallets passes the test and then fails on every send.
Credentials¶
This connector uses the “eagle-eye” credential type, the same one that the Eagle Eye destination and the Eagle Eye Audiences destination use, so a credential set up for either of them can be selected here. The credential has a Client ID, a Client secret, and an API URL.
Name and description
The name and description for a credential.
Client ID
The Eagle Eye AIR API client ID, provisioned by your Eagle Eye account manager. It identifies your Amperity integration to Eagle Eye.
Client secret
The Eagle Eye AIR API secret paired with the Client ID, provisioned by your Eagle Eye account manager. Amperity uses it to authenticate each request.
API URL
The Eagle Eye AIR Wallet API base URL for your region and environment. Select the URL that matches your Eagle Eye company unit:
https://wallet.uk.eagleeye.com/2.0/(United Kingdom)https://wallet.sandbox.uk.eagleeye.com/2.0/(United Kingdom sandbox)https://wallet.au.eagleeye.com/2.0/(Australia)https://wallet.us2.eagleeye.com/2.0/(United States, US2)
Confirm the correct URL with your Eagle Eye account manager. Defaults to the Australia URL.
When you save the destination, Amperity tests the connection by looking up a wallet with the Eagle Eye AIR Wallet API at the API URL. The lookup rewards no one. When Eagle Eye answers with 401 or 403, the test reports a credential error and asks you to check the Client ID and Client secret. Any other failure, including no answer, is reported as a failure to reach the Wallet API and asks you to check that the API URL matches your Eagle Eye region and environment.
Settings¶
Name and description
The name and description for a destination.
Business user access
By default a destination is available to all users who have permission to view personally identifiable information (PII).
Enable the Admin only checkbox to restrict access to only users assigned to the Datagrid Operator and Datagrid Administrator policies.
Enable the PII setting checkbox to allow limited access to PII for this destination.
Use the Restrict PII access policy option to prevent users from viewing data marked as PII anywhere in Amperity and from sending data to downstream workflows.
This destination has no settings of its own. Which Behavioral Action to trigger, and for whom, is set on each Activate node.
Activate node settings¶
The rest of the configuration for this connector belongs to the journey that sends to it. Add this destination to an Activate node, then configure the following fields on that node. Two nodes may send to the same destination and trigger different Behavioral Actions.
Behavioral Action reference
Required. The action reference of the Behavioral Action to trigger, as set on its campaign in the Eagle Eye AIR dashboard. The member gets whatever that campaign rewards.
Each node triggers one Behavioral Action. To give a member two rewards at the same point in a journey, use two Activate nodes. A reference that Eagle Eye does not recognize fails the send, and nothing is rewarded.
Identity value attribute
Required. The Amperity attribute that holds an identity value on the member’s Eagle Eye wallet, such as a loyalty card number or customer ID. Eagle Eye finds the wallet from the value alone, so no identity type is needed.
Amperity sends this value as text:
Text is sent with surrounding spaces removed, because Eagle Eye does not match a value that has them.
A whole number, whether stored as an integer or as a decimal with no fractional part, is written out in full. A number has no leading zeros, so store an identity value that can begin with zero, such as some card numbers, as text.
An empty value, a number with a fractional part, a floating-point number, a list, or any other value that is not text or a number is not sent. The send fails without a request to Eagle Eye.
Request body¶
Amperity sends each trigger as a POST to services/trigger under the credential’s API URL, such as https://wallet.uk.eagleeye.com/2.0/services/trigger. The request holds the member’s identity value, the send’s wallet transaction reference (see Failed sends), and one trigger: the node’s Behavioral Action reference.
For example, with Behavioral Action reference set to “WELCOME_BONUS” and an identity value of “4000123456789”, Amperity sends:
{
"identityValue": "4000123456789",
"walletTransaction": {
"reference": "amperity-3f1c9a7e52d84b06e1f7a2c3d9b5e8f4a6c0d2e1"
},
"triggers": [
{
"reference": "WELCOME_BONUS"
}
]
}
Checked before sending¶
Before it sends a trigger, Amperity checks it against the following rules, and no others. When a check fails, Amperity does not send the trigger, and the send fails without another attempt. The failure message names the node field or the attribute to fix. Amperity reports the first of these that applies:
The node has no Behavioral Action reference.
The member has no value for the Identity value attribute.
The identity value is neither text nor a whole number, such as a number with a fractional part or a list.
The first is a problem with the node’s settings, and fails every send from that node until it is fixed. The others are problems with one member’s data, and fail only that member’s send.
A trigger that passes these checks can still be refused by Eagle Eye, as described under Failed sends.
Failed sends¶
Each send carries a wallet transaction reference that Amperity generates for it, starting with “amperity-”, and that stays the same on every attempt at that send. Eagle Eye refuses a wallet transaction reference it has already seen, and rewards nobody when it does, so a send that Amperity attempts more than once rewards the member no more than once.
Amperity makes up to three attempts at a send. Each new attempt is scheduled between 200 and 700 milliseconds after the previous one fails. Amperity does not retry a request within an attempt.
Amperity tries a send again when Eagle Eye rate limits it, times out, returns a server error, answers with its “Unknown error has occurred” error, or does not answer. It does not try again when Eagle Eye refuses the credential, finds no wallet for the identity value, does not recognize the Behavioral Action reference, finds the wallet terminated, suspended, or deleted, finds no account in the points scheme, or refuses the send for any other reason. Each send rewards one member, so a failed send affects only that member.
When an attempt is refused because an earlier attempt at the same send reached Eagle Eye, Amperity looks up the wallet transaction reference. If the earlier attempt rewarded the member, the send succeeds without a second reward. If Eagle Eye has not yet recorded that reward when the last attempt is made, the send is reported as failed, although the member may have been rewarded.
A failed send and its failure message appear in two places:
The Recent failures table on the Profile sends tab of the Destinations page. The tab is available when real-time profiles are enabled for your tenant.
The Activations tab of the customer’s profile, which also shows the send’s Attempt count, such as “3 / max 3”.
Amperity keeps only the failure message from the last attempt. A failed send cannot be retried from Amperity.
Amperity limits how quickly it sends requests to Eagle Eye with each credential.