https://github.com/audienseco/recurlybot

Slack bot to notify new Recurly subscriptions
https://github.com/audienseco/recurlybot

Last synced: about 2 months ago
JSON representation

Slack bot to notify new Recurly subscriptions

• Host: GitHub
• URL: https://github.com/audienseco/recurlybot
• Owner: AudienseCo
• License: mit
• Created: 2019-05-01T14:50:00.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-05-01T00:47:40.000Z (about 2 years ago)
• Last Synced: 2025-03-13T03:46:27.531Z (3 months ago)
• Language: JavaScript
• Size: 156 KB
• Stars: 1
• Watchers: 13
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/AudienseCo/recurlybot.svg?branch=master&style=flat-square)](https://travis-ci.org/AudienseCo/recurlybot)

# Recurlybot

Slack bot to notify new Recurly subscriptions.

![](http://g.recordit.co/MDZuZBIOAe.gif)

## Why

One of the things that are hard to replicate in companies with distributed teams is living the vibe of closing deals. This integration makes it easier to celebrate company success with a sense of fun and humor.

## What's this?

A function that given a POST request from [Recurly webhooks](https://docs.recurly.com/docs/webhooks) publishes a message in a the configured Slack channel via a [Slack Incomming Webhook](https://api.slack.com/incoming-webhooks).

## Features

- Notify new subscriptions in a configured Slack channel (plan name, customer name, company and subscription amount).

- Link notifications to a configured internal CRM. By default it links to the Recurly account page.

- Send a ramdon gif related to party or money.

- If you want to surprise the team by adding a custom gif you can setup the gif that will appear when an account closes the deal by [adding a note to the Recurly account](https://docs.recurly.com/docs/accounts#section-account-notes).

### Configuration

Edit [src/config.js](https://github.com/AudienseCo/recurlybot/blob/master/src/config.js) or overwrite it using environment variables:

  - `SLACK_CHANNEL`: the Slack channel where you want to puslish the notifications.

  - `SLACK_URL`: Slack incomming webhook url.

  - `PROFILE_URL`: Customer information page in case you want to link the notification to your CRM or to the Recurly account page.

  - `RECURLY_APIKEY`: Recurly API key.

  - `RECURLY_SUBDOMAIN`: Your company recurly subdomain.

  - `RECURLY_ENV`: Recuring environment, use `staging` for staging or leave it empty for production.

## Install

```bash

npm install recurlybot --save

```

## Usage

### Developing your own Recurly webhooks handler 

```js

const { notifyNewSubscription } = require('recurlybot');

const channel = 'new-customers';

const notification = `

...

`; // XML notification from Recurly

notifyNewSubscription(channel, notification)

  .then(() => {

    console.log('Notification published in Slack');

  }).

  .catch((e) => {

    console.log('Error handling notification');

  });

```

## Using an AWS Lambda function

See [Recurlybot Lambda Packager](https://github.com/AudienseCo/recurlybot-lambda)