Integrating Wishlist Plus and/ or Swym Back in Stock Alerts with Braze allows you to send personalized retargeting and engagement marketing campaigns to your customers via email/ SMS. This guide walks you through the steps to successfully set up and use this integration.
Prerequisites
Before you begin, ensure the following:
You are on the Enterprise plan on Wishlist Plus or Swym Back in Stock Alerts app.
You have an active Braze account
Successfully connecting your Wishlist Plus or Swym Back in Stock Alerts app to Braze involves three key steps. It’s important to complete all of them to ensure that your shoppers actually receive the notifications you intend to send.
Connect your Swym app to Braze
Establish the connection so that your Wishlist Plus or Back in Stock Alerts app can securely communicate with Braze.
Subscribe to events you want to send
Choose which Swym events (e.g., price drop, back in stock, wishlist reminder) should be sent to Braze. Without selecting events, no triggers will reach Braze.
Create Canvas(es) in Braze
Set up Canvas(es) that use these events to send personalized emails/ SMS to your shoppers. This is what ensures that the right communication goes out when an event occurs.
⚠️ Note: We often see merchants stop at just connecting the apps, without subscribing to events or building Canvases. Make sure you complete all three steps for the integration to work as intended.
Step 1: Connect your Swym app to Braze
At present, the Braze integration with Swym is not self-serve—it’s a managed integration. To get started, please reach out to us at [email protected] and provide the following details so we can set up the integration on your behalf:
a. API key: Generate an API key in your Braze dashboard:
Settings > APIs and Identifiers > Create API Key
While creating the key, make sure to enable the users.track permission under User Data.
For step-by-step guidance, you can refer to the Braze API Guide.
Important: Please share credentials securely using OneTimeSecret (a one-time, self-destructive link tool) to keep your API keys protected.
b. Instance URL: Braze manages a number of different instances for our dashboard and REST endpoints. Please share the correct REST endpoint based on which instance you are provisioned to. You can refer to this API guide from Braze for further help.
Once the API key and Instance URL has been shared with our Support team, we will set up the integration for you and respond with a confirmation.
After the setup is completed, the custom events from Swym will be automatically registered in Braze. You can verify the integration by checking the Custom Events section in the Braze dashboard.
In the dashboard open Data Settings > Custom Events to view the list of Swym events registered.
The properties of each Swym event can be viewed by choosing Manage properties against each custom event.
These properties hold the values of the events that we send out which can be rendered in the Email/ SMS templates.
If the custom events appear, it confirms that your Swym app is successfully communicating with your Braze account.
Step 2: Subscribe to events you want to send
From your Wishlist Plus app, head over to the Marketing tab and scroll to the “Automations” section. Here, you will notice various events that you can subscribe to. Enable the desired events.
Below are the list of events we support:
Swym Wishlist Plus App Events:
Event Name | When this event is triggered |
Share Wishlist | When a shopper shares a wishlist with someone else |
Add to Wishlist | When a shopper adds an item to their wishlist |
Wishlist Reminder | Reminder about items in a shopper’s wishlist |
Saved for Later Reminder | Reminder about a shopper’s Saved for Later items |
Price Drop alert | Product on a wishlist goes on sale |
Low Stock alert | Product on a wishlist is running low on stock |
Back in Stock alert | Product on a wishlist is restocked |
Swym Back in Stock Alerts App Events:
Event Name | When this event is triggered |
Back in Stock Acknowledgement | Shopper subscribes to be notified when a product is back in stock |
Restock Alert | Product a shopper requested a back-in-stock alert for is restocked |
Restock Reminder | Follow-up alert (usually ~24 hrs after the first restock alert, configurable) |
Step 3: Build Canvas in Braze
You will have to build a separate Canvas for each of the events you subscribed to in order to automate sending out personalised emails to your shoppers.
Navigate to Braze Dashboard > Messaging > Canvas and start creating a new Canvas.
In the Trigger section, select Custom Event as the trigger for your flow.
Choose Swym events for which you would like to build the Canvas.
To send out an email/ SMS, drag and drop the Message component from the sidebar into the Canvas and select Email/ SMS channel as per your need.
Customizing the message:
In Canvas, custom event properties can be used in Liquid in any Message step that follows an Action Paths step. For example, when referencing event_properties, use this Liquid snippet: {{event_properties.${property_name}}}.
Below, you can find the properties associated with each of the Swym event:
1. Properties available in the Share Wishlist event:
Custom event name: swym_shareWishlist
Variable | Details |
senderName | Name of the shopper that is sharing their wishlist |
senderEmail | Email ID of the shopper that is sharing their wishlist |
sendURL | URL that points to the shared wishlist |
productCount | Number of products in the wishlist being shared |
products[] | List of products. Each element in the products list has the following fields. |
imageURL | URL of product’s image |
variantInfo | Variant info or name if the product has any variants |
productCurrentPrice | Product’s price |
productBrand | Brand name of the product (if any) |
productQuantity | Number of units available in the inventory |
productName | Name of the product added to wishlist |
productCategory | Category of the product |
productURL | URL directing to the PDP |
2. Variables available in the Wishlist Reminder event:
Custom event name: swym_addedToWishlist
Variable | Details |
productCount | Number of products in the current wishlist reminder event |
products[] | List of products. Each element in the products list has the following fields. |
imageURL | URL of product’s image |
variantInfo | Variant info or name if the product has any variants |
productCurrentPrice | Product’s price |
productBrand | Brand name of the product (if any) |
productQuantity | Number of units available in the inventory |
productName | Name of the product added to wishlist |
productCategory | Category of the product |
productURL | URL directing to the PDP |
3. Variables available in the Saved for Later Reminder event
Custom event name: swym_addedtosfl
Variable | Details |
productCount | Number of products in the current reminder event |
products[] | List of products. Each element in the products list has the following fields |
imageURL | URL of product’s image |
variantInfo | Variant info or name if the product has any variants |
productCurrentPrice | Product’s price |
productBrand | Brand name of the product (if any) |
productQuantity | Number of units available in the inventory |
productName | Name of the product added to wishlist |
productCategory | Category of the product |
productURL | URL directing to the PDP |
4. Variables available in the Low Stock Alert
Custom event name: swym_lowstock
Variable | Details |
imageURL | URL of product’s image |
productName | Name of the product added to wishlist |
variantInfo | Variant info or name if the product has any variants |
productCurrentPrice | Product’s price |
productURL | URL directing to the PDP |
productCategory | Category of the product |
productQuantity | Number of units available in the inventory |
productBrand | Brand name of the product (if any) |
5. Variables available in the Price Drop Alert
Custom event name: swym_pricedrop
Variable | Details |
imageURL | URL of product’s image |
productName | Name of the product added to wishlist |
variantInfo | Variant info or name if the product has any variants |
productOriginalPrice | Product’s initial price before drop (compare at price) |
productCurrentPrice | Product’s current price |
productURL | URL directing to the PDP |
productCategory | Category of the product |
productQuantity | Number of units available in the inventory |
productBrand | Brand name of the product (if any) |
6. Variables available in the Back in Stock Alert
Custom event name: swym_backinstock
Variable | Details |
imageURL | URL of product’s image |
productName | Name of the product added to wishlist |
variantInfo | Variant info or name if the product has any variants |
productCurrentPrice | Product’s price |
productURL | URL directing to the PDP |
productCategory | Category of the product |
productQuantity | Number of units available in the inventory |
productBrand | Brand name of the product (if any) |
7. Variables available in the Restock Second Alert / Reminder
Custom event name: swym_backinstockReminder
Variable | Details |
imageURL | URL of product’s image |
productName | Name of the product added to wishlist |
variantInfo | Variant info or name if the product has any variants |
productCurrentPrice | Product’s price |
productURL | URL directing to the PDP |
productCategory | Category of the product |
productQuantity | Number of units available in the inventory |
productBrand | Brand name of the product (if any) |
8. Variables available in the Reminder Acknowledgement
Custom event name: swym_remindMe
Variable | Details |
imageURL | URL of product’s image |
productName | Name of the product subscribed to |
variantInfo | Variant info or name if the product has any variants |
productCurrentPrice | Product’s price |
productURL | URL directing to the PDP |
productCategory | Category of the product |
productQuantity | Number of units available in the inventory |
productBrand | Brand name of the product (if any) |