Spotler Integration
Synchronise shopper profile data and mailing-list subscription preferences from Spaaza to Spotler (formerly MailPlus). When a shopper opts in, opts out, or updates their profile in Spaaza, the integration automatically creates or updates the corresponding contact and subscription permissions in Spotler.
Contents
- About Spotler
- What the Integration Does
- Supported Event Types
- Contact Data Sent to Spotler
- Subscription Permissions Sent to Spotler
- How the Sync Works
- Setting Up the Integration in Spaaza
- Configuring Spotler
- Practical Notes
About Spotler
Spotler is a marketing automation platform used for email marketing, campaign management, and customer communication. Spotler was previously known as MailPlus and the integration uses the Spotler MailPlus REST API.
Useful Spotler resources:
What the Integration Does
The Spaaza Spotler integration keeps shopper contact information and mailing-list subscription preferences synchronised between Spaaza and Spotler. Specifically, when a relevant event occurs in Spaaza the integration:
- Syncs contact data — creates or updates a contact in Spotler with the shopper's profile information (name, email, address, phone number, etc.).
- Syncs subscription preferences — updates the contact's newsletter and marketing permission settings in Spotler based on the shopper's opt-in preferences in Spaaza.
The integration is one-directional: data flows from Spaaza to Spotler. Changes made directly in Spotler are not synchronised back to Spaaza.
Supported Event Types
The following Spaaza event types trigger the Spotler integration:
| Spaaza event type | Description |
|---|---|
shopper.opted-in | A shopper opts in to the loyalty programme |
shopper.opted-out | A shopper opts out of the loyalty programme |
shopper.altered | A shopper's profile is updated (e.g. name, address, or preferences change) |
For all three event types the integration sends the same pair of requests to Spotler: a contact upsert followed by a subscription update.
The integration only processes events for shoppers who have opted in to the programme or have a join date. Events for shoppers who have never opted in are skipped.
Contact Data Sent to Spotler
When a supported event fires, the integration sends the following shopper profile fields to Spotler as contact properties. For a full list of Spaaza user fields, see the add-user and alter-user endpoint documentation.
| Spotler contact field | Spaaza user field | Notes |
|---|---|---|
externalId | id | The Spaaza user ID, used to link the shopper across both platforms |
email | username | The shopper's email address |
initials | first_name (first character) | Derived from the first character of first_name, uppercased |
firstName | first_name | |
lastName | last_name | |
gender | gender | Sent as null when empty in Spaaza |
street | address_streetname | |
houseNumber | address_housenumber | |
postalCode | address_postalcode | Sent as null when empty in Spaaza |
city | address_towncity | |
phoneNumber | phone_number | |
birthday | birthday | |
taal | language | The shopper's language preference (e.g. nl) |
country | country_code | Two-letter country code (e.g. NL) |
The externalId field links the Spaaza shopper to their Spotler contact record. This is used to identify and update the correct contact on subsequent events.
Subscription Permissions Sent to Spotler
Alongside the contact data, the integration sends the shopper's mailing-list subscription preferences to Spotler. These are mapped to Spotler permission bits:
| Spotler permission bit | Spotler description | Spaaza user field | Notes |
|---|---|---|---|
| 1 | Nieuwsbrief (Newsletter) | mailing_list_subscribed | Subscribe to mailing list opt-in |
| 2 | Persoonlijke aanbiedingen en aanbevelingen (Personal offers and recommendations) | printed_mailing_list_subscribed | Direct mail opt-in |
These permissions control which types of marketing communications the shopper receives in Spotler.
How the Sync Works
When a supported event occurs in Spaaza, the integration performs the following steps:
- Search — looks up the shopper's email in Spotler to determine whether the contact already exists.
- Create or update contact:
- If the contact does not exist, it is created with the shopper's profile data and Spaaza user ID as the
externalId. - If the contact exists and has an
externalId, its profile data is updated. - If the contact exists but has no
externalId, the contact update is skipped (because the Spotler API requires anexternalIdfor updates), but subscription preferences are still synchronised.
- If the contact does not exist, it is created with the shopper's profile data and Spaaza user ID as the
- Update subscriptions — the shopper's newsletter and direct-mail preferences are sent to Spotler regardless of whether the contact was created, updated, or skipped.
Setting Up the Integration in Spaaza
The Spotler integration is configured as a webhook in Spaaza. To set it up:
- Obtain Spotler API credentials — you will need your Spotler MailPlus API consumer key and consumer secret. These are used for OAuth 1.0 authentication when Spaaza communicates with the Spotler API. Refer to the Spotler MailPlus REST API documentation for instructions on obtaining these credentials.
- Configure the webhook in Spaaza — the Spotler integration can be configured in one of two ways:
- Via the Spaaza Console: go to Settings in the Spaaza Console, navigate to Integrations, click "Add an integration", and select Spotler. Enter your Spotler consumer key and consumer secret, then click Save.
- Via the Spaaza API: use the Spaaza webhook configuration endpoints to create a webhook of type
spotler. Set theusernamefield to your Spotler consumer key and thepasswordfield to your consumer secret. See the Webhooks and Events documentation for more information on configuring webhooks via the API.
Once configured, Spaaza will automatically send contact and subscription data to Spotler whenever a supported event occurs.
Configuring Spotler
On the Spotler side, you should ensure the following:
- API access is enabled — confirm that REST API access is enabled on your Spotler account and that you have generated consumer key and consumer secret credentials. See the Spotler MailPlus REST API documentation for details.
- Contact properties are configured — the integration sends profile fields such as
firstName,lastName,email,street,postalCode, etc. Ensure these fields exist as contact properties in your Spotler account so that incoming data is stored correctly. - Subscription permissions are set up — the integration sends permission bits for newsletter and personal offers. Make sure the corresponding permission entries are configured in your Spotler account:
- Permission bit 1: Newsletter
- Permission bit 2: Personal offers and recommendations
Practical Notes
- The integration uses OAuth 1.0 to authenticate with the Spotler MailPlus REST API. The consumer key and consumer secret provided during setup are used to sign each request.
- The Spotler API base URL used by the integration is
https://restapi.mailplus.nl/integrationservice. - Internal Spaaza test accounts (email addresses ending in
@*.spaaza.com) are automatically filtered out and not sent to Spotler. - The integration does not currently support transaction, voucher, or loyalty-level events — it is focused on profile and subscription synchronisation. For richer event-based marketing automation, consider using the Klaviyo or Mailchimp integrations which support a wider range of event types.