Developer Guides
A technical reference for developers, architects, and integration engineers connecting external platforms to the ES Loyalty ecosystem.
What are Developer Guides?
Developer Guides are the technical counterpart to Business Guides. Where a Business Guide explains what an integration makes possible, a Developer Guide explains how to build, configure, and maintain it.
Each guide in this section covers one integration and includes the API endpoints, authentication requirements, data formats, connector architecture, event triggers, and configuration details needed to implement the integration end to end. Guides are written to be standalone references. You do not need to read them in sequence.
All integrations in this section are built on or routed through the Data Integration Gateway (DIG), ES Loyalty's core integration module. Understanding the DIG architecture is recommended before implementing any of the integrations below.
Looking for non-technical guidance on what these integrations enable for your loyalty program? See the corresponding [Business Guides] for each integration instead.
The Data Integration Gateway
The Data Integration Gateway (DIG) is the central routing layer between ES Loyalty and external platforms. It decouples integration logic from the core loyalty engine, allowing ES Loyalty to emit generic events that the DIG then filters, transforms, and forwards to the appropriate connector.
The DIG is made up of three sub-modules:
- DIG API module -- an API Gateway, AWS Lambda, and EventBus layer that exposes a REST interface for ES Loyalty to exchange data with integrated providers. It handles synchronous, asynchronous, and batch file flows.
- Connector modules -- Lambda functions and EventBus rules that contain the logic for each specific external platform. Connectors can be built by Exchange Solutions, by clients, or by System Integrators.
- Database module -- stores configuration and message data for auditing and replay.
All integrations documented in this section are implemented as DIG connectors.
Technical integrations
Optimove
Covers the bidirectional data sync between ES Loyalty and Optimove's CDP. Includes loyalty data point synchronization, aggregation feeds, issuance and voucher sync, and event-triggered member communications via Optimove's OptiMail engine. Documents batch and real-time sync flows, REST API calls, and the connector configuration required to activate each data channel.
CataBoom
Covers the gamification integration that rewards loyalty program members with CataBoom gameplay experiences, including scratch cards, spin-the-wheel, and slot-style games. Documents the JWT-based authentication flow, game configuration via the Console API, the event triggers that initiate gameplay, and how bonus points earned through gameplay are returned to ES Loyalty automatically.
Tipalti
Covers the global payments integration for loyalty reward fulfillment via Tipalti. Documents the data feeds, payout event triggers, payment method configuration, and reconciliation flows required to route redemption payouts through Tipalti's disbursement infrastructure. Relevant for programs that issue cash, prepaid card, or direct deposit rewards to members at scale.
Adobe Marketo Engage
Covers the Marketo connector, which transforms generic ES Loyalty events into Marketo-compatible data structures and calls the corresponding Marketo REST APIs. Documents the three supported trigger events (member registration, badge award, and redemption), the connector transformation logic, API authentication, and the Marketo Technical Setup requirements. A separate setup guide covers initial Marketo environment configuration.
Salesforce Marketing Cloud (SFMC)
Covers the SFMC integration across both native DIG connector flows and direct ESP data sync. Documents triggered email sends, ESP data synchronization, aggregation and issuance/voucher sync to SFMC data extensions, and SMS delivery via the DIG SMS connector. Includes configuration for both email-native and SMS-native integration paths.
What the guides cover
Each integration guide is structured around the following content areas:
| Section | What it covers |
|---|---|
| Architecture overview | How the integration fits within the DIG and ES Loyalty data flow |
| Authentication | API keys, JWT secrets, AWS Signature V4, or bearer token requirements per integration |
| API reference | Endpoints, request and response formats, and supported operations |
| Event triggers | Which ES Loyalty member events initiate data sends or connector calls |
| Data formats | Field mappings, payload structures, and type conventions |
| Configuration | Connector setup, environment variables, and Console configuration steps |
| Data feeds | Operational and DWH feeds relevant to the integration |
| Troubleshooting | Common errors, connector failure patterns, and diagnostic steps |
Deriving value from the Developer Guides
| Goal | How the guides help |
|---|---|
| Faster onboarding | Step-by-step implementation paths reduce time spent interpreting raw API specs or reverse-engineering existing connectors |
| Fewer integration failures | Documented event triggers, payload schemas, and error handling patterns reduce guesswork during build and test |
| Confident architecture decisions | Integration architecture diagrams and DIG module breakdowns support informed decisions before build begins |
| Reduced support dependency | Comprehensive troubleshooting sections allow teams to self-diagnose connector and data feed issues |
| Consistent implementations | Reference configurations and code-level examples help System Integrators and client developers align with Exchange Solutions standards |
Who should use these guides
Developer Guides are written for anyone responsible for implementing, maintaining, or evaluating a technical integration with the ES Loyalty platform.
Backend developers
Client or SI engineering teams
Implementing connector logic, consuming DIG APIs, configuring event triggers, and handling authentication flows.
Solutions architects
Client, SI, or Exchange Solutions
Evaluating integration patterns, designing data flows, and validating that connector architecture meets program requirements before build begins.
Technical leads
Client-side implementation teams
Scoping integration work, reviewing API and feed specifications, and making decisions about build vs. configure tradeoffs.
Integration engineers
System Integrators (SIs)
Building custom DIG connectors or extending existing ones to support client-specific data partner requirements.
IT and platform admins
Client infrastructure teams
Configuring environments, managing credentials, setting up data feeds, and maintaining operational integrations post-launch.
Technical project managers
Client or SI delivery teams
Scoping integration milestones, identifying dependencies, and using the guides as a source of truth for implementation scope and acceptance criteria.