MailChimp

Integrate Pelcro with MailChimp to control and send automated emails based on live events occurring on Pelcro.

What is Mailchimp integration?

The integration allows you to easily send automated emails based on events happening on Pelcro. It allows you to leverage the power of both Pelcro and MailChimp without requiring any code. You can control the copy, branding, and call-to-actions while leveraging data fed from the integration. Below are all the steps required to get you started.

Create a MailChimp account

To use the integration you'll need an active Mailchimp account. To get started or to know more about the Mailchimp sign up process, please click here

Note: If you're already on Mailchimp you can just use your existing account.

Create a Mailchimp Audience


The first step to getting started with Mailchimp is setting up your audience. According to Mailchimp, your audience is where you’ll store and manage all your contact data. It's the bedrock of our integration.

Required Audience fields

Audience fields and MERGE tags MUST have the following three fields:
1- field first name and field merge tag is: FNAME
2- field last name and field merge tag is: LNAME
3- field token and field merge tag is: TOKEN
fields and merge tags in details

Can I use my existing Mailchimp Audience?

We recommend using a fresh new audience, however, you can use any Audience list in your Mailchimp account.

Get your Audience list ID

We'll need the Audience list ID from your MailChimp account. You can easily get it in five steps by clicking this link. After getting your list ID please save it in a secured place as we're going to use it in the integration.

Note the following requirements:

1- The selected audience list must have the three fields mentioned above.
2- The integration will overwrite any existing member's first name and last name.

More information:

1- Create a Mailchimp Audience
2- Getting started with Mailchimp merge tags

Generate a Mailchimp API key

Using your managerial permissions on your Mailchimp account, please generate a new API key for the integration. Go to Account > Extras > API key.

For more details, please check out the link below:

1- Generate a new API key.

What's next?

Once you generate the API key, we recommend saving it in a secure place so we can use it later.

Now, log in to your Pelcro


Pelcro Dashboard

Within your Pelcro's Dashboard, please find the "integration" icon on the left side menu.

click on integrations

Integrations

Click the Mailchimp icon

click on the mailchimp integration

Mailchimp Integration

What's next?

Just add the API key and the Audience List-ID that we've created earlier in this documentation, and click the ADD NEW green button.

Please note:

1- You'll not be able to restore or read the full API key string after clicking 'ADD NEW' As we masked it following our security protocols.
2- We'll show the last four characters of the API key unmasked so you can recognize it.
3- If you clicked 'DELETE KEYS', this will deactivate the integration immediately.
4- To reactivate the integration one more time you'll have to add your API key and Audience List ID as described above.

Before we go back to MailChimp

Now, we assume/hope that everything went well so far till this point. Before we get back to Mailchimp please use your Pelcro account to create a test customer. This way we can walk you through the next steps of using the best of the integration features.

Now it's the Time to get back to Mailchimp


Go to your Mailchimp account and open the Audience List that you used with our integration. You'll find that MR. John has been magically added to your LIST.

Breakdown of the process

Mailchimp API custom events

We're using the most up to date Mailchimp Technology called API CUSTOM EVENTS. With this technology, we're not just adding your Pelcro's customers to your Mailchimp Audience but also we're continuously updating their Mailchimp profiles with "Events activity'.

What exactly are Events Activities?

Each time any of your customers do something on Pelcro, we add a new Event activity to his profile on Mailchimp. Activity data will be handy and you can build emails, statistics and different feedbacks on top of it.

Mr.john updated his first name to be Johnson.

The integration will update Mr.John's Mailchimp profile and adds a new Event activity called customer_updated to his Activity Feed.

Mr.Johnson created his first subscription

The integration will add a new Event activity called subscription_created to Mr.Johnson's Mailchimp profile. Inside this activity, you'll find all the necessary information that's related to the new subscription that Mr.Johnson created. In addition, you'll see below all the details of the subscription.

Now, Let's map out our Events


CUSTOMER CREATED

event name: customer_created
usage: This means this customer has been created with the following event data.
attached event data:

[
  'first_name',
  'last_name',
   'email'
];

CUSTOMER UPDATED

event name: customer_updated
usage: This means this customer has been updated with the following event data.
attached event data:

[
  'first_name',
  'last_name',
   'email'
];

CUSTOMER PASSWORD RESET

event name: customer_reset_password
usage: This means that the customer has requested a password reset and you need to send him a link that contains the password token. Below is an example of how you should build the link based on the user email and the password token.
example: https://www.yourdomain.com?view=password-reset&email=*|EMAIL|*&token=*|TOKEN|*
attached event data:

[
   'password_token'
];

SUBSCRIPTION CREATED

event name: subscription_created
usage: This means this customer has created a subscription

SUBSCRIPTION GIFT DONOR

event name: subscription_gift_donor
usage: This means this customer has donated a gift subscription

SUBSCRIPTION GIFT RECIPIENT

event name: subscription_gift_recipient
usage: This means this customer has received a gift subscription

SUBSCRIPTION UPDATED

event name: subscription_updated
usage: This means that the customer has updated a subscription

SUBSCRIPTION CANCELED

event name: subscription_canceled
usage: This means this customer has canceled a subscription

SUBSCRIPTION TRIAL WILL END

event name: subscription_trialwillend
usage: This means the subscription's trial period will end in three days, or when a trial is ended immediately.

SUBSCRIPTION RENEWED

event name: subscription_renewed
usage: This means this customer has renewed his subscription..

SUBSCRIPTION EXPIRED

event name: subscription_expired
usage: This means this customer's subscription was expired.

subscription events' data:

[
  'id',
  'site_id',
  'address_id',
  'backdate_start_date',
  'billing',
  'billing_cycle_anchor',
  'cancel_at',
  'cancel_at_period_end',
  'canceled_at',
  'cancel_reason',
  'created',
  'current_period_end',
  'current_period_start',
  'days_until_due',
  'ended_at',
  'quantity',
  'shipments_remaining',
  'source',
  'status',
  'trial_end',
  'trial_start',
  'shipments_undeliverable',
  'shipments_suspended_until',
  'is_gift_donor',
  'is_gift_recipient',
  'gift_code',
  'is_redeemed',
  'gift_recipient_email',
  'gift_recipient_first_name',
  'gift_recipient_last_name',
  'gift_start_date',
  'gift_donor_subscription_id',
  'agency_id',
  'updated_at',
  'latest_invoice_id',
  'subscription_plan', // Plan name
  'subscription_product', // Product name
];

INVOICE CREATED

event name: invoice_created
usage: This means this customer has a new invoice

INVOICE PAYMENT SUCCEEDED

event name: invoice_payment_succeeded
usage: This means the customer's attempt to pay an invoice was succeeded.

INVOICE PAYMENT FAILED

event name: invoice_payment_failed
usage: This means the customer's attempt to pay an invoice was FAILED.

invoice events' data:

[
  'id',
  'amount_due',
  'amount_paid',
  'amount_remaining',
  'billing',
  'billing_reason',
  'currency',
  'created',
  'ending_balance',
  'finalized_at',
  'invoice_pdf',
  'marked_uncollectible_at',
  'paid_at',
  'period_end',
  'period_start',
  'post_payment_credit_notes_amount',
  'pre_payment_credit_notes_amount',
  'starting_balance',
  'status',
  'total',
  'voided_at',
  'updated_at',
  'number',
];

CHARGE SUCCEEDED

event name: charge_succeeded
usage: This means the attempt of charging the customer succeeded and a charge is created.

CHARGE FAILED

event name: charge_failed
usage: This means the attempt of charging the customer failed.

CHARGE REFUNDED

event name: charge_refunded
usage: This means the attempt of refunding a charge to the customer was succeeded. And the customer was refunded.

charge events' data:

[
  'id',
  'user_id',
  'invoice_id',
  'payment_intent_id',
  'source_id',
  'amount',
  'amount_refunded',
  'created',
  'currency',
  'disputed',
  'failure_code',
  'failure_message',
  'offline',
  'offline_entered_by',
  'order',
  'origin',
  'paid',
  'reference',
  'refunded',
  'status',
  'refunded_at',
  'origin',
  'deleted_at',
  'remit_rate',
  'remit_rate_amount'
];

SOURCE EXPIRING

event name: source_expiring
usage: This means the customer's payment source or his card will expire at the end of the month.

SOURCE CANCELED

event name: source_canceled
usage: This means the customer's payment source or his card is canceled.

source events' data:

[
  'exp_month',
  'exp_year',
  'address_zip_check',
  'brand',
  'country',
  'cvc_check',
  'funding',
  'last4',
  'name',
  'address_line1_check',
  'dynamic_last4',
];

ADDRESS CREATED

event name: address_created
usage: This means this customer has added a new address

ADDRESS UPDATED

event name: address_updated
usage: This means this customer has updated his address
address events' data:

[
  'id',
  'type',
  'first_name',
  'last_name',
  'line1',
  'line2',
  'city',
  'state',
  'country',
  'postal_code',
  'created_at',
  'updated_at'
];

Finally, Let's send a notification


Let's use what we learned so far to send a subscription confirmation email. It will be sent automatically once he/she - the member - created his new subscription on Pelcro.

Go to automate and click on the Email link

Now, select API, and then Event API

Name your email campaign

Click edit the trigger

Now copy the event "subscription_created" and add it as the event name and click update trigger

please note

1- You must copy the event's name from this document.
2- Note that you have all the events and their data properties
3- You must paste the custom event name in the event name field as shown below.

Then, click next to add a subject and sender information. Afterward, fill out all the Mailchimp requirements until you reach the Email Message Body.

Customize your email using merge tags and event merge tags

To access any of the subscription created event data (which we listed above), you can easily use it inside the Email body as shown in the picture below. "|EVENT:subscription_plan|"

Email will look like this:

Use merge tags to make personalized links

Email template

Prepare your email message in your template

Add link

Use the button link from your Mailchimp toolbox on the right side of the screen

Select Web Address

In the web address (URL) input, please add your website link.

EX: http://example.com/?view=password-reset&email=*|EMAIL|*&token=*|TOKEN|*

Click insert and the link will be ready

More information

Please click here

Mailchimp API Custom event video tutorial

If you couldn't apply the previous example or for any reason you want more information, we recommend visiting the Mailchimp API custom event video tutorial. It's a great help in learning how to use and implement automated emails using API custom events.

For the Mailchimp API CUSTOM EVENT please click here

Limitations

Maximum number of members in the audience list

If you exceed your MailChimp account limit without upgrading, the integration will automatically be de-activated.


Updated 9 days ago

MailChimp


Integrate Pelcro with MailChimp to control and send automated emails based on live events occurring on Pelcro.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.