https://github.com/hubot-archive/hubot-mailchimp
Mailchimp hubot script as an NPM package
https://github.com/hubot-archive/hubot-mailchimp
Last synced: 2 months ago
JSON representation
Mailchimp hubot script as an NPM package
- Host: GitHub
- URL: https://github.com/hubot-archive/hubot-mailchimp
- Owner: hubot-archive
- License: mit
- Created: 2014-06-23T16:08:53.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2025-02-21T21:52:26.000Z (4 months ago)
- Last Synced: 2025-03-24T15:21:51.268Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 967 KB
- Stars: 8
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mailchimp for Hubot
[](http://badge.fury.io/js/hubot-mailchimp) [](https://github.com/hubot-archive/hubot-mailchimp/actions/workflows/nodejs.yml)
Use Hubot to add or remove members to a mailing list and get a report of your latest sent campaign.
## Installation
In the Hubot project repo, run:
```bash
npm install hubot-mailchimp --save
```
Then add `hubot-mailchimp` to your `external-scripts.json`:
```json
[
"hubot-mailchimp"
]
```
## Configuration
| Configuration Variable | Required | Description |
| ------------------------- | -------- | ------------------------------------------ |
| `MAILCHIMP_API_KEY` | **Yes** | API key for your Hubot integration |
| `MAILCHIMP_LIST_ID` | **Yes** | The unique identifier for the desired list |
| `MAILCHIMP_SERVER_PREFIX` | **Yes** | Server identifier, e.g. `us10` |
## Sample Interaction
### Add a member to the list by email
```
User> @hubot subscribe [email protected]
Hubot> @user Attempting to subscribe [email protected]...
Hubot> You successfully subscribed [email protected].
```
### Remove a member from the list by email
```
User> @hubot unsubscribe [email protected]
Hubot> @user Attempting to unsubscribe [email protected]...
Hubot> You successfully unsubscribed [email protected].
```
### Get the report from your latest sent campaign
```
User> @hubot mailchimp
Hubot> Last campaign "My Awesome Campaign" was sent to 431 subscribers (310 opened, 225 clicked)
```