Unlock the full power of your customer data by integrating SoftSwiss, a leading iGaming software provider, with Optimove's Real-Time Customer Data Platform. This integration connects your batch and real-time data streams and lets your Optimove campaigns grant SoftSwiss bonuses, enabling sophisticated personalization, automated campaign orchestration, and immediate customer engagement.
This guide provides setup instructions for each supported capability.
Integration Capabilities
The integration supports three primary capabilities:
- Batch Data Integration: Securely transfers comprehensive customer and transactional data via SFTP for in-depth segmentation and analysis.
- Real-Time Event Streaming: Instantly streams customer actions via Kafka to trigger real-time campaigns and marketing automation flows.
- Promotions (formerly OptiPromo) via the Bonus API: Grants SoftSwiss cash bonuses, free spins, and lootboxes to players directly from Optimove campaigns.
Please note: The customer ID of the SoftSwiss integration is the following: (client_name)_(user_id). To ensure a smooth integration, please make sure to follow the same structure across all integrations:
- Batch: The CID will be shared in the required format by SoftSwiss.
- Streaming data via Kafka: The stitching will be done by Optimove.
- Front-end streaming data integration (via SDK): The CID must be sent in the format outlined above. When the client owns the front-end implementation, it is the client's responsibility to ensure that the CID is implemented correctly.
Batch Data Integration
The batch data integration allows SoftSwiss to deliver customer and transactional data files to Optimove using a secure SFTP connection. Once received, the data is validated and processed through our ETL to power rich segmentation, personalization, and campaign targeting.
Key Benefits:
- Enables deep, data-driven campaign targeting and segmentation.
- Automates file delivery, validation, and ingestion.
- Supports scalable and repeatable data flows for consistent insights.
Data Delivery Method:
Files delivered via Optimove’s SFTP server.
Expected Schema:
Please refer to the detailed schema guide here: SoftSwiss Data Schema Document
Integration Steps
-
Request SFTP Credentials
- Action: Contact your Optimove Project Manager or Customer Success Manager (CSM).
- Result: Optimove will create your secure SFTP location and provide you with the necessary access credentials.
-
Automate Data Delivery & QA
- Action (SoftSwiss): SoftSwiss will configure the automated delivery of the required data files to the SFTP location.
- Action (Optimove): Optimove will retrieve the initial files and begin the data quality assurance (QA) process to ensure all data is correctly structured.
-
Activate ETL
- Action (Optimove): Once the data is validated, Optimove will complete the ETL setup.
- Result: Your SoftSwiss data will be automatically ingested and made available within Optimove for segmentation and campaign use.
For detailed timelines, please consult your project manager.
Real-Time Streaming Integration
This integration enables customer events from SoftSwiss to flow into Optimove in real-time using Kafka. These events are immediately available for use in dynamic segmentation, analytics, and triggering real-time campaigns based on customer behavior.
Key Benefits:
- Activate campaigns instantly based on user actions (e.g., registration, deposit).
- Dynamically update customer profiles with the latest engagement data.
- Improve targeting precision with live behavioral information.
How It Works:
SoftSwiss publishes real-time events to dedicated Kafka topics. Optimove listens to these topics, maps the incoming data to your Optimove site, and makes it immediately available.
Supported Events:
ootb_registrationootb_loginootb_depositootb_deposit_cancellationootb_withdrawalootb_withdrawal_cancellation
Integration Steps
-
Enable Kafka Topics
Action: Ask your SoftSwiss account manager to enable the following Kafka topics for your brand(s):
es.{brand_name}.useres.{brand_name}.user_sessiones.{brand_name}.payment
-
Provide Connection Details to Optimove
Action: Share the following information with your Optimove onboarding contact:
- Brand name(s) used in the Kafka topic names.
- Confirmation that the topics are live and streaming data.
- A list of Optimove's production IPs to be whitelisted by SoftSwiss (your Optimove contact will provide these IPs).
- Kafka connection details:
- Kafka Hostname
Broker.list- Port
- A zip file containing any additional credentials required for connection.
-
Optimove Configuration & Activation
- Action (Optimove): Optimove will use the provided details to set up Kafka listeners, validate the event structures, and activate the real-time data ingestion.
- Result: Live events from SoftSwiss will begin flowing into Optimove, ready for use in your marketing activities.
Promotions Integration (Bonus API)
This integration lets your Optimove campaigns grant SoftSwiss bonuses. You set up each bonus once as a promotion in Optimove Promotions and add it to a campaign. Optimove decides which players qualify and calls the SoftSwiss Bonus API to issue the bonus. Scheduled and real-time campaigns are both supported.
Key Benefits:
- Grant cash bonuses, free spins, and lootboxes from Optimove campaigns, scheduled or real-time.
- Bonus rules live in Optimove. You create a promotion once and reuse it in any campaign.
- Players receive the campaign message only after SoftSwiss confirms the bonus was granted.
How It Works:
- You create one promotion in Optimove per bonus variation and set its bonus type and brand.
- You add the promotion to a scheduled or real-time campaign (see Allocating Promotions in Your Campaigns).
- When the campaign runs, Optimove decides which players qualify for the promotion.
- Optimove builds the bonus request from the promotion settings and sends it, signed, to the Bonus API of the player's brand.
- SoftSwiss issues the bonus and reports which players received it. Issued bonuses appear in the SoftSwiss backoffice under Issued Bonuses, with the strategy API Manual.
- Only players who received the bonus get the campaign message.
Integration Steps
-
Enable the Bonus API with SoftSwiss
- Action: Ask your SoftSwiss account manager to enable the Bonus API for each brand and to provide the API signing key for each brand.
-
Provide Connection Details to Optimove
-
Action: Share the following with your Optimove onboarding contact, through a secure channel:
- The brand names. These become the options in the
brandlist on your promotions. - The Bonus API base URL per brand.
- The signing key per brand.
- The brand names. These become the options in the
-
Action: Share the following with your Optimove onboarding contact, through a secure channel:
-
Optimove Configuration & Activation
- Action (Optimove): Optimove configures the SoftSwiss bonus channel for your site and adds the promotion property set.
- Result: You can create promotions and use them in campaigns.
Supported Bonus Types:
| Bonus type | Value resolved per player (promotion tiers) | Fixed on the promotion (metadata) |
|---|---|---|
| Cash Bonus |
amount, sent in one currency |
Wager, currencies, duration, max win, bet limits, games category, and all other settings |
| Free Spins | None | Number of spins, games, free-spin result rules, and all other settings |
| Lootbox | None | Display items and the prize table |
Setting Up Promotions in Optimove:
Optimove adds the SoftSwiss property set to your site. In the promotion wizard you enter these properties in the Meta Data step, and for a cash bonus you set the amount in the Rewards step. Every promotion needs two properties: bonus_type (cash, freespins, or lootbox) and brand (the brand that issues the bonus). The other properties depend on the bonus type:
| Bonus type | Required | Optional |
|---|---|---|
| Cash Bonus |
amount (set in the Rewards step), wager, ss_currencies
|
title, internal_title, ss_group, duration, activation_duration, total_duration, email_template, max_win, bonus_bet_limits, games_category, sticky, growing_lock
|
| Free Spins |
freespins_count, ss_games, freespins_result (must include wager) |
title, internal_title, ss_group, ss_currencies, duration, activation_duration, total_duration, email_template, provider, bet_level, external_result, freespins_max_win
|
| Lootbox |
display_items, issues (the prize table) |
title, internal_title, ss_group, activation_duration, total_duration, email_template
|
- For a cash bonus, the amount is sent in the currency of the tier that matched the player. The promotion's
ss_currencieslist must include that currency. - Durations are in seconds. A bonus with no
activation_durationis issued already active.
max_win, bonus_bet_limits, freespins_result, freespins_max_win, and issues are entered as JSON text, in exactly the format SoftSwiss expects. Optimove passes the text to SoftSwiss as it is, so a formatting mistake makes the bonus fail. The examples below show the format for each bonus type.Examples per Bonus Type:
Create the promotion in Optimove Promotions as described in Getting Started with Promotions and Attributes: Mastering Your Promotional Data. Then fill in the SoftSwiss properties as in the examples below.
Cash Bonus
Example values for a three-day reload bonus:
| Property | Value to enter | What it means |
|---|---|---|
bonus_type |
cash |
The bonus type |
brand |
brand_one |
The brand that issues the bonus, picked from the list Optimove set up for you |
title |
Weekly Reload |
The bonus name the player sees in SoftSwiss |
internal_title |
opti_wk_reload_t2 |
Internal name in SoftSwiss |
ss_group |
optimove_cash |
Bonus group in SoftSwiss |
wager |
40 |
Wagering requirement |
ss_currencies |
EUR, USD
|
Currencies the bonus supports |
duration |
259200 |
Seconds the bonus stays valid (3 days) |
activation_duration |
86400 |
Seconds the player has to activate the bonus (1 day) |
max_win |
{"EUR": 500, "USD": 550} |
Maximum win per currency, JSON text |
bonus_bet_limits |
{"EUR": 5, "USD": 5} |
Maximum bet while the bonus is active, per currency, JSON text |
games_category |
slots |
Game category the bonus applies to |
sticky |
false |
Whether the bonus amount is withdrawable after wagering |
growing_lock |
true |
Whether winnings are locked until wagering is complete |
In the Rewards step, choose Tiered Reward and set the amount as tiers, one tier per currency, using the player's currency attribute as the condition:
| Tier | Condition | Reward | Value |
|---|---|---|---|
| 1 | Currency equals EUR | Amount (EUR) | 50 |
| 2 | Currency equals USD | Amount (USD) | 55 |
A player whose currency is EUR receives 50 EUR with a maximum win of 500 EUR. Optimove sends only that player's currency to SoftSwiss.
Free Spins
Example values for 25 birthday spins. Every player gets the same number of spins, so there are no tiers:
| Property | Value to enter | What it means |
|---|---|---|
bonus_type |
freespins |
The bonus type |
brand |
brand_one |
The brand that issues the bonus, picked from the list Optimove set up for you |
title |
Birthday Spins |
The bonus name the player sees in SoftSwiss |
internal_title |
opti_birthday_fs |
Internal name in SoftSwiss |
freespins_count |
25 |
Number of free spins |
ss_games |
softswiss:MissCherryFruits |
The games the spins apply to, in the format provider:game, with the game IDs SoftSwiss gives you |
provider |
SOFTSWISS |
The game provider |
bet_level |
1 |
Bet level of the spins |
ss_currencies |
EUR |
Currencies the bonus supports |
duration |
604800 |
Seconds the spins stay valid (7 days) |
activation_duration |
86400 |
Seconds the player has to activate the spins (1 day) |
freespins_max_win |
{"EUR": 150} |
Maximum win from the spins per currency, JSON text |
freespins_result |
JSON text, see the example below the table | The cash bonus the winnings are credited as |
external_result |
false |
Leave false so SoftSwiss credits the winnings automatically |
Example of the freespins_result property:
{"title": "Spin Winnings", "wager": 40, "max_win": {"EUR": 500}}Lootbox
Example values for a lootbox with three prizes. The prize table is fixed on the promotion, so there are no tiers:
| Property | Value to enter | What it means |
|---|---|---|
bonus_type |
lootbox |
The bonus type |
brand |
brand_one |
The brand that issues the bonus, picked from the list Optimove set up for you |
title |
Pirate box |
The lootbox name the player sees in SoftSwiss |
internal_title |
opti_pirate_box |
Internal name in SoftSwiss |
ss_group |
optimove_lootbox |
Bonus group in SoftSwiss |
display_items |
3 |
Number of prizes shown to the player to pick from |
activation_duration |
172800 |
Seconds the player has to open the lootbox (2 days) |
issues |
The prize table, JSON text | The prizes and their chances, see the full example below |
Full example of the issues property. weight sets each prize's chance relative to the others, and game IDs are the ones SoftSwiss gives you:
[
{"weight": 70, "title": "10 EUR Cash",
"bonuses": [{"title": "10 EUR Cash", "currencies": ["EUR", "USD"], "amount": {"EUR": 10, "USD": 11}, "wager": 40, "duration": 259200}]},
{"weight": 25, "title": "25 Free Spins",
"freespins": [{"title": "25 Free Spins", "freespins_count": 25, "games": ["softswiss:MissCherryFruits"], "duration": 259200, "freespins_result": {"wager": 40}}]},
{"weight": 5, "title": "Empty",
"empty_bonuses": [{"title": "Better luck next time"}]}
]Campaign Behavior and Limits:
- Cover every player currency with a tier: A cash amount is always sent in one currency, the one of the tier that matched the player. A player whose currency has no matching tier does not get the bonus and does not get the campaign message. In real-time campaigns the player's currency attribute must also match the tier currency.
- Up to 100 players per request: Larger audiences are split into several requests automatically.
- Partial grants: If SoftSwiss skips some players, for example because the player already received this bonus, those players do not get the campaign message. The other players are not affected.
-
Customer ID: The Optimove customer ID is
(client_name)_(user_id). Optimove sends only the numericuser_idto SoftSwiss.
Key Considerations
-
Multi-Brand Support: If your operation includes multiple brands, ensure each brand's Kafka topic namespace is correctly configured (e.g.,
es.brand_one.user_session,es.brand_two.user_session). Communicate all brand names clearly to your Optimove contact. -
Multi-Brand Bonuses: SoftSwiss issues separate Bonus API credentials per brand. Every promotion carries a
brandproperty, picked from the list Optimove set up for you, and Optimove sends the bonus with that brand's credentials.
Getting Started
To enable the SoftSwiss integration for your brand, please contact your Optimove Project Manager or CSM. They will guide you through the process and coordinate with all parties to ensure a smooth and successful setup.