https://github.com/stephenyeargin/hubot-createsend
📧🤖 Manage your Campaign Monitor lists and campaigns
https://github.com/stephenyeargin/hubot-createsend
campaign-monitor createsend email-marketing hacktoberfest hubot hubot-scripts
Last synced: about 1 year ago
JSON representation
📧🤖 Manage your Campaign Monitor lists and campaigns
- Host: GitHub
- URL: https://github.com/stephenyeargin/hubot-createsend
- Owner: stephenyeargin
- License: mit
- Created: 2015-02-21T06:24:17.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2025-02-23T04:33:25.000Z (over 1 year ago)
- Last Synced: 2025-04-02T04:46:19.647Z (over 1 year ago)
- Topics: campaign-monitor, createsend, email-marketing, hacktoberfest, hubot, hubot-scripts
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/hubot-createsend
- Size: 1.53 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hubot CreateSend (Campaign Monitor)
[](http://badge.fury.io/js/hubot-createsend) [](https://github.com/stephenyeargin/hubot-createsend/actions/workflows/nodejs.yml)
Manage your Campaign Monitor account via Hubot
## Getting Started
Campaign Monitor has provided [this helpful article](http://help.campaignmonitor.com/topic.aspx?t=206) for locating the necessary credentials in your account. This particular module is built around the idea of subscribing/unsubscribing users _one particular email list_ and viewing the latest campaigns for _one particular client_.
It is heavily inspired (and borrows some code) from the [hubot-mailchimp](https://github.com/hubot-scripts/hubot-mailchimp) module.
## Installation
In your hubot repository, run:
`npm install hubot-createsend --save`
Then add **hubot-createsend** to your `external-scripts.json`:
```json
["hubot-createsend"]
```
### Configuration
| Environment Variable | Required? | Description |
| ---------------------- | :-------: | ----------------------------------------|
| `CREATESEND_API_KEY` | Yes | API key of account or particular client |
| `CREATESEND_CLIENT_ID` | Yes | Unique identifier for desired client
| `CREATESEND_LIST_ID` | Yes | Unique identifier for desired mailing list |
## Usage
### Get latest campaign
Returns the the statistics for the last sent campaign. You can use `hubot cm ...` if you prefer to use a few less keystrokes.
```
alice> @hubot createsend
hubot> Last campaign "Campaign One" was sent to 1000 subscribers (298 opened, 132 clicked, 43 unsubscribed)
```
### Subscribe an email
Add an email address to the list.
```
alice> @hubot createsend subscribe johndoe@example.com
hubot> @alice Subscribing johndoe@example.com ...
hubot> Subscribed johndoe@example.com.
```
### Unsubscribe an email
Remove an email address from the list.
```
alice> @hubot createsend unsubscribe johndoe@example.com
hubot> @alice Unsubscribing johndoe@example.com ...
hubot> Unsubscribed johndoe@example.com.
```