Integration Testing guide
- Balázs Árva
Setup
So you installed the plugin and wondering how can you test the synchronization. Make sure that you check this too: shopifypluginv2
log in to maileon
After the initial login you’re greeted by this site. Navigate to settings (upper right corner)
create or grab an api key
Navigate to ‘API KEYS’ (on the left)
Grab the api-key (I already created this for you)
set the api key in your shop/integration ui
Make sure you validate the key AND save your configuration
create the webhooks in maileon (via the url’s in your shop/integration ui)
Navigate to ‘WEBHOOKS’
Click on ‘create new Webhook’
Choose unsubscribe. Make sure you check ‘email_address' and ‘external_id'
Copy paste your webhook URL from your shop/integration UI ( under Webhooks/unsubscription) then create it
Choose DOI. Make sure you check ‘email_address’ and ‘external_id’
Copy paste your webhook URL from your shop/integration UI ( under Webhooks/double opt-in confirmation) then create it
save your maileon settings after you’re satisfied with your settings
you can start the testing process
Test cases
Shopify shop tests
Customer
In your shop create/update and delete a customer (after your setup) Most of these api calls may take some time.
Accepts Marketing | update | delete |
|---|---|---|
true | updates a customer in maileon with the defined settings | unsubscribes a customer from maileon |
false | unsubscribes a customer from maileon | unsubscribes a customer from maileon |
You can check the newly created/updated customer in Maileon under ‘Lists & Contacts’.
For more info you can click on the customer (check the synchronized fields)
Order
In your shop create an order then mark it as pending (with or without a customer, after your setup) Most of these api calls may take some time.
buyers_accepts_marketing | customer | create |
|---|---|---|
true | customer entity (https://shopify.dev/docs/admin-api/rest/reference/customers/customer/ ) | creates a transaction with the order |
false | customer entity | creates a contact in maileon with permission:NONE and creates a transaction with the checkout |
You can check the newly created transaction in Maileon under ‘Lists & Contacts/Contact Events'
For more info you can click on the contact event’s event data
Maileon tests
Unsubscribe an existing customer (exists in Shopify and Maileon) either via accepts_marketing or in Maileon.
The selected customer’s ‘accepts_marketing’ field is set to false.
UI tests
Maileon Settings
Play with the settings, you can check the created/updated contacts in maileon. MAKE SURE YOU SAVE THE SETTINGS.
Shopify Settings
Check or unset the webhooks. After that you can test them with the given entity like in ‘Shopify Tests’ paragraph. MAKE SURE YOU SAVE THE SETTINGS.
Gifs to help to understand the testing process better.
Guest user accepts marketing
Guest user subscribes
How to configurate your Maileon account
How to test the unsubscribe process from Maileon
Initial setup with app-bridge