Configure destinations for Eagle Eye

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.

The Eagle Eye connector sends loyalty identities from Amperity into loyalty wallets in the Eagle Eye AIR platform, performing one wallet operation for each person on every run.

Each row in the query results is one wallet operation, addressed by the person’s loyalty identity. There is no audience or list concept: Amperity does not keep a list in sync on the Eagle Eye side, it performs the configured operation for each person each time it runs. Amperity sends every row in the query results on each run; there is no incremental sync.

Two columns are sent. The identity_value column (required) is the person’s loyalty identity in Eagle Eye — a loyalty card number, email, or whatever identity type your company unit is configured for — and is the value every operation is addressed by. The friendly_name column (optional) is a human-readable label for the wallet: the create operation applies it to a new wallet when it is present, and the update operation exists to change it and requires it. Column names are matched without regard to capitalization, and values are sent to Eagle Eye as they appear in the query results.

Note

This destination uses the Eagle Eye AIR Wallet API .

Beta

The Eagle Eye connector is currently in beta. Contact your Amperity representative to learn more.

Important

Eagle Eye provisions your API credentials and configures each company unit. Before you configure the destination, get the Client ID, Client secret, and regional API URL from your Eagle Eye account manager, and confirm the Identity type name your unit uses and the behavioral state values your unit accepts. A state value your unit does not recognize is rejected.

Note

The Eagle Eye Wallet API has no bulk endpoint, so Amperity sends one request per person. Amperity paces requests at about five requests per second — an Amperity-side default, not a limit published by Eagle Eye — so a large send can take a long time (for example, a send of 100,000 people runs for several hours).

Wallet operations

The Wallet operation setting selects what each row does, and a send performs a single operation for the entire run. You choose the operation, and the state used by state-change, when you configure the orchestration that sends to this destination.

Operation	What it does
create	Provisions a wallet for each person and attaches their loyalty identity. This is the default. If the friendly_name column is present, its value is set as the new wallet’s label. A person who already has a wallet is recovered rather than duplicated, so re-sending the same query results is safe.
update	Changes a wallet’s friendly name. Requires the friendly_name column.
state-change	Changes a wallet’s behavioral state. Requires the Wallet state setting.
suspend	Temporarily halts a wallet’s activity. Reversible with activate.
activate	Returns a suspended or inactive wallet to service.
terminate	Permanently closes a wallet. It cannot be undone, and Eagle Eye rejects any later change to a terminated wallet. It is the recommended operation for a consent-driven hard opt-out.
delete	A soft delete on Eagle Eye’s side: removes the wallet from active use but does not erase it. Intended for cleaning up test data, not for consent or data-subject requests — use terminate for those.

Every operation other than create first looks up the person’s existing wallet by their identity value. A person with no wallet yet is reported as a failed row and the run continues.

Get details

Review the following details before configuring credentials for Eagle Eye and before configuring Amperity to send loyalty identities to loyalty wallets in the Eagle Eye AIR platform.

	Credential settings Required All three credential fields are required. No call can be made without them. 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.
	Required configuration setting Identity type The name your Eagle Eye company unit uses for the loyalty identity carried in the identity_value column — for example CUSTOMER_ID or a loyalty card type. This is configured in Eagle Eye and differs by company unit, so confirm the exact name with your Eagle Eye account manager. Every wallet operation is addressed by this identity.
	Optional destination settings Wallet type The Eagle Eye wallet type created for new wallets by the create operation. Defaults to CONSUMER, Eagle Eye’s standard consumer wallet type. Change it only if your Eagle Eye company unit uses a different wallet type. Wallet state (new wallets) The behavioral state applied to each wallet created by the create operation and to the identity attached to it. State values are configured per Eagle Eye company unit and differ from unit to unit, so set this only to a value your Eagle Eye account manager has confirmed for your unit; a value your unit does not recognize is rejected. Leave it unset to let Eagle Eye apply your unit’s default state — the safest choice.
	Orchestration settings These are chosen for each orchestration that sends to this destination, not on the destination itself. Wallet operation The wallet operation performed for every row in the send. A send performs a single operation for the entire run: create (the default) provisions a wallet for each person and attaches their loyalty identity, and sets the wallet’s label from the friendly_name column when it is present. A person who already has a wallet is recovered rather than duplicated, so re-sending the same query results is safe. update changes a wallet’s friendly name, and requires the friendly_name column. state-change changes a wallet’s behavioral state, and requires the Wallet state setting below. suspend temporarily halts a wallet’s activity, and activate returns a suspended or inactive wallet to service. terminate permanently closes a wallet — it cannot be undone, and Eagle Eye rejects any later change to a terminated wallet. It is the recommended operation for a consent-driven hard opt-out. delete is a soft delete on Eagle Eye’s side: it removes the wallet from active use but does not erase it. Intended for cleaning up test data, not for consent or data-subject requests — use terminate for those. Every operation other than create first looks up the person’s existing wallet by their identity value; a person with no wallet yet is reported as a failed row and the run continues. You choose this operation when you configure the orchestration that sends to this destination. Wallet state (state change) The behavioral state applied by the state-change operation. State values are configured per Eagle Eye company unit and differ from unit to unit, so use only a value your Eagle Eye account manager has confirmed for your unit. Required when the operation is state-change; Amperity stops the run with a message if it is missing. You choose this when you configure the orchestration that sends to this destination.

Configure credentials

Configure credentials for Eagle Eye before adding a destination.

An individual with access to Eagle Eye should use SnapPass to securely share “Client ID”, “Client secret”, and “API URL” details with the individual who configures Amperity.

To configure credentials for Eagle Eye

	From the Settings page, select the Credentials tab, and then click the Add credential button.
	In the Credentials settings dialog box, do the following: From the Plugin dropdown, select Eagle Eye. Assign the credential a name and description that ensures other users of Amperity can recognize when to use this destination.
	The settings that are available for a credential vary by credential type. For the “eagle-eye” credential type, configure settings, and then click Save. Required All three credential fields are required. 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.

Add destination

Use a sandbox to configure a destination for Eagle Eye. Before promoting your changes, send a sample audience, and then verify the results in Eagle Eye. After verifying the end-to-end workflow, push the destination from the sandbox to production.

To add a destination for Eagle Eye

	Open the Destinations page, select the New destinations button, and then select Orchestration. To configure a destination for Eagle Eye, do one of the following: Click the row in which Eagle Eye is located. Destinations list alphabetically and you can scroll up and down the list. Search for Eagle Eye. Start typing “eag”. The list filters to show only matching destinations. Select “Eagle Eye”.
	Select the credential for Eagle Eye from the Credential dropdown, and then click Continue. Tip Amperity validates the connection when the destination is saved. If the connection cannot be validated, an error is shown and the destination is not saved.
	In the “Destination settings” dialog box, assign the destination a name and description that ensures other users of Amperity can recognize when to use this destination. Configure 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.
	Configure the following settings, and then click “Save”. Identity type The name your Eagle Eye company unit uses for the loyalty identity carried in the identity_value column — for example CUSTOMER_ID or a loyalty card type. This is configured in Eagle Eye and differs by company unit, so confirm the exact name with your Eagle Eye account manager. Every wallet operation is addressed by this identity. Wallet type The Eagle Eye wallet type created for new wallets by the create operation. Defaults to CONSUMER, Eagle Eye’s standard consumer wallet type. Change it only if your Eagle Eye company unit uses a different wallet type. Wallet state (new wallets) The behavioral state applied to each wallet created by the create operation and to the identity attached to it. State values are configured per Eagle Eye company unit and differ from unit to unit, so set this only to a value your Eagle Eye account manager has confirmed for your unit; a value your unit does not recognize is rejected. Leave it unset to let Eagle Eye apply your unit’s default state — the safest choice.
	After configuring this destination users may use orchestrations to send query results Eagle Eye.
	Validate the audience with Eagle Eye by using a sample audience with a very small membership. For example: 10 or 100 members or the minimum audience size recommended by Eagle Eye. Send the sample audience to Eagle Eye and verify the sample audience is correct in Eagle Eye. Make adjustments if necessary. Only send full audiences after validation is complete.

Data validation

Amperity performs the configured operation for every row in the query results, except for rows it cannot process. A row is reported as failed, and the run continues, when any of the following is true:

• The identity_value column is empty for that row.

• The operation is update and the friendly_name column is empty for that row.

• The operation is anything other than create and Eagle Eye has no wallet for that row’s identity value.

• Eagle Eye rejects that row’s wallet payload, or the row targets a wallet that has already been terminated.

• Eagle Eye reports a conflict, or a locked wallet, for that row’s operation.

Failed rows are reported in the destination’s run details. Some conditions stop the entire run instead of failing individual rows: an unknown wallet operation, or a state-change send with no Wallet state set (both caught before any data is sent), and a rejected credential or Eagle Eye being unavailable.