wbb-mailchimp v0.0.5
WBB MailChimp Integration
With this integration you can collect users details and either add them to a mailing list, or remove them from it.
Setup
In order to complete the setup for MailChimp you will need three things - a list id, a server prefix and an audience id. To find the listId you'll need to go to Audience Dashboard under the Audience Menu and then from the Manage Audience button in the top right select Settings. You'll find the ID for the list at the bottom of this page.
The server prefix is the first part of the URL after you log in. For example, if your browser shows https://us12.admin.mailchimp.com/audience/ then your server prefix is us12.
To create an API key, click on the profile icon in the bottom left of the screen. From here, go to Account and Billing. Under the Extras menu you'll find, API keys and from here you'll be able to create an API key.
Blocks Provided
- Add to mailchimp
- Remove from mailchimp
- Mailchimp missing parameters
- Mailchimp signup complete
- Mailchimp removal successful
Handler Names
The following handler names and their functions are available :
| Handler Name | Purpose |
|---|---|
| add-contact | Collects name and email address from the user, and adds them to a list. |
| remove-contact | Removes a user from a mailing list when provided with an email address. |
Configuration Options
Within the function there are a number of options that can be set to configure the behaviour of the integration. The tables below show the settings that are available for each handler.
handler-one
| Property | Required | Description |
|---|---|---|
| listId | true | Represents the list, or audience that you'd like to add this contact to. |
| api_key | true | The API key that has access to the list above. |
| server_prefix | true | The server used for API calls. Note, this is only the first part, ie, us12. |