Mailchimp
The Mailchimp source allows you to send email events to Freshpaint, and send those events to your destinations.
Setup
Freshpaint uses Mailchimp webhooks to track email deliveries, opens, and more. You'll need to set up this webhook in Mailchimp with the following steps:
Navigate to Webhooks and click Add a Webhook at the top of the page
Choose the events you want to listen for in the “Trigger on Events” section.
In the “Post To URL” field, input the url you can find on Freshpaint Sources page. It will follow the format
https://api.perfalytics.com/mailchimp/<env-id>
Click Create Webhook
Event Schema
Freshpaint supports tracking the following events for the Mailchimp source:
Email: send
Email: deferral
Email: hard_bounce
Email: soft_bounce
Email: open
Email: click
The following properties are attached (when available) to the properties:
Property name
Description
event
The "Email: send"
The recipient's email
mailchimp_msg_id
The mailchimp internal id of the message
sender
The sender's email
state
The state of the message (sent, rejected, spam, unsub, bounced, or soft-bounced)
subaccount
The subaccount from which the message originated; if no subaccount was used, the value will be null
subject
The subject line of the message
url
The URL clicked (if the event is a click event)
diag
For bounced and soft-bounced messages, provides the specific SMTP response code and bounce description, if any, received from the remote server
bounce_description
For bounced and soft-bounced messages, a short description of the bounce reason, such as bad_mailbox or invalid_domain
template
The slug of the template used, if any. If no template was used, the value will be null
metadata
An array of the metadata key–value pairs that were applied to the message, if any
tags
A list of tags attached to the message
clicks
A list of click objects (see below)
opens
A list of open objects (see below)
Opens & Clicks:
For open and click events only, a parsed version of the user agent detected for the event. The following properties will be attached if a UA was captured:
Property Name
Description
user_agent_parsed__mobile
Whether the user agent is a mobile agent
user_agent_parsed__os_company
The operating system company
user_agent_parsed__os_company_url
URL of the operating system company
user_agent_parsed__os_family
The operating system family (i.e., Linux, Mac, or Windows)
user_agent_parsed__os_icon
URL for an icon for the operating system
user_agent_parsed__os_name
The name of the operating system used for the event
user_agent_parsed__os_url
URL for the operating system
user_agent_parsed__type
The type of user agent (e.g., "browser", "email client", "robot"); these may be updated, so string values may be added
user_agent_parsed__ua_company
Company for the user agent (specifically the browser or email client)
user_agent_parsed__ua_company_url
URL for the user agent company
user_agent_parsed__ua_family
Family for the user agent (e.g., Firefox, Chrome, Safari)
user_agent_parsed__ua_icon
URL for an icon for the user agent
user_agent_parsed__ua_name
Name of the user agent
user_agent_parsed__ua_url
URL for the user agent
user_agent_parsed_ua_version
Version of the user agent
For open and click events only, a parsed location based on the IP may be detected for the event. The following properties will be attached if a location was captured:
Property Name
Description
location__country_short
The abbreviated country name
location__country_long
The full country name
location__region
location__city
location__postal_code
location__timezone
location__latitude
The latitude of the user
location__longitude
The longitude of the user
Click Object
Attribute name
Description
ts
The timestamp of the click
url
The url that was clicked
Open Object
Attribute name
Description
ts
The timestamp the email was opened
ip
The IP address where the open occurred
location
The approximate geolocation of the IP where the open occurred
Last updated