Overview
Wunderkind is able to integrate with your systems in order to power our email program. We achieve this by passing data files between our systems, which you can then take and import into any relevant CRMs on your side. All files will follow the specifications outlined in this document; any deviations are considered non-standard and will need to be scoped by Wunderkind.
Table of Contents
- Hosting Options
- Available Functionality
- New Subscribers
- Set Unsubscribe Status
- Get Unsubscribe Status
- Checking Customer Status
- URL Appending
- Build & Test Process
- Integration Architecture, example
Hosting Options
Wunderkind requires that any servers used for integration purposes are hosted on the client end. We support SFTP or Amazon S3 Buckets.
Please provide your Wunderkind contact with your server’s appropriate access information. For example, if you plan to use an SFTP, we’ll need:
- SFTP host name
- Username and password
- Port
If you require that Wunderkind servers be authenticated in order to access, please let us know and we’ll provide a list of IPs.
Available Functionality
File transfers may be used to achieve the following functionality:
-
Create new subscribers: collecting and sending a new email address to your system.
- Wunderkind sends file via Report Scheduler
-
Set unsubscribe status: updating users’ status, should they unsubscribe from a Wunderkind email.
-
- Wunderkind sends file via Report Scheduler
-
-
Get unsubscribe status: looking up users’ unsubscribe status before sending an email, to make sure that they are not unsubscribed.
- Client sends file
-
Checking Customer status: looking up whether a user is a previous customer for email segmentation purposes.
- Client sends file
-
URL Appending: method to identify users returning to your site from email marketing messages.
- Client sends file
New Subscribers
Wunderkind will send a daily file with email addresses and additional information collected through our onsite email capture campaigns.
Wunderkind will provide the file in .csv format and with the columns outlined in our Report Scheduler.
Please provide us with the following information for the upload:
- Filepath
- Time for Wunderkind to post file (eg daily at 07:00am EST)
Set Unsubscribe Status
When a user unsubscribes from a Wunderkind email, we will unsubscribe them from our system, as well as pass you a file with these unsubscribed addresses. Wunderkind will send a daily file of email addresses that have unsubscribed from our emails.
Wunderkind will provide the file in .csv format and with the columns outlined in our Report Scheduler.
Please provide us with the following information for the upload:
- Filepath
- Time for Wunderkind to post file (eg daily at 07:00am EST)
Get Unsubscribe Status
In order to accurately check unsubscribe status, we’ll need you to upload the following:
- One-time upload of all email addresses that you consider unsubscribed.
- Ongoing, daily upload of any new unsubscribes (anyone who unsubscribes from your marketing emails)
One-time upload of unsubscribes, information needed:
- Filepath (eg /uploads/wknd/unsubscribers)
- Date when file will be available
Ongoing, daily upload of unsubscribes, information needed:
- Filepath (eg /uploads/wknd/unsubscribers_daily)
- Daily time file will be placed
- Note that this file should contain deltas from the previous day only, not your full unsubscribe list
Format for both files: .csv file with single column of data, "email"
Checking Customer Status
This will be used to look up whether a user is a previous customer for example for email segmentation purposes.
One-time upload of customers, information needed:
- Filepath (eg /uploads/wknd/customers)
- Date when file will be available
Ongoing, daily upload of new customers, information needed:
- Filepath (eg /uploads/wknd/customers_daily)
- Daily time file will be placed
- Note that this file should contain deltas from the previous day only, not your full customer list
Format for both files: .csv file with single column of data, "email"
URL Appending
URL Appending is one of Wunderkind’s most impactful identification methods. It allows us to identify users returning to your site from marketing messages (non-WKND marketing emails). It is a reverse lookup that we're able to do using a key (unique identifier) that maps to a plaintext email address and appended to all clickout email links.
Steps to enable URL appending:
- Assign a key to each email address that can be appended as a URL parameter
- All records must contain a value for this key, the key itself is not important but it should not contain PII.
- Many clients set this to the sha256 email hash to ensure it’s a unique, PII-safe value - but it could be any system generated id that’s unique to an email address.
- Send a file of your full subscriber list and recurring daily deltas
- The files require an explicit format with the first column being the email addresses and column header of "email". The second column should be the PII-safe value that corresponds to that email address, and the column header should be the key you're using in the URL.
- For example, if you're appending bxid={hashed email} to all email links; the file headers would look like this:
One-time upload of email addresses and identifiers, information needed:
- Filepath (eg /uploads/wknd/urlappend)
- Date when file will be available
Ongoing, daily upload of new email addresses and identifiers, information needed:
- Filepath (eg /uploads/wknd/urlappend_daily)
- Daily time file will be placed
- Note that this file should contain deltas from the previous day only, not your full email list
Format for both files: .csv file
Build & Test Process
After providing file transfer details per the specs above, the Wunderkind team will review and reach out with any follow-up questions.
From there, Wunderkind will set up jobs to put and pull files from your servers, based on the file names and folder paths provided. At the same time, we ask that you place your files on the server and set up the relevant jobs on your end. You can do this right away; there are no dependencies on the Wunderkind end outside of confirming the file structure and path.
We will place test files on the server during the integration period and ask you to confirm that they look good on your end before setting live.