# serverless-slack-notifier

> Lambda functions for slack notifications about AWS Events

Latest version **0.0.1** (published 2016-07-05) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install serverless-slack-notifier
pnpm add serverless-slack-notifier
yarn add serverless-slack-notifier
bun add serverless-slack-notifier
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2016-07-05 |
| First published | 2016-07-05 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | ~0.12.8 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Maarten Huijsmans |
| Maintainers | lukin0110 |
| Keywords | serverless, aws, slack |

## Links

- npm: https://www.npmjs.com/package/serverless-slack-notifier
- Repository: https://github.com/lukin0110/serverless-slack-notifier
- Homepage: https://github.com/lukin0110/serverless-slack-notifier#readme
- Issues: https://github.com/lukin0110/serverless-slack-notifier/issues
- npm.io page: https://npm.io/package/serverless-slack-notifier

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2016-07-05

## README

# serverless-slack-notifier

This is a Serverless project that offers 2 AWS Lambda functions that notifies a Slack channel about S3 & SNS events.

The best part is there are no servers required for this. You get charged only when its called and you don't need to 
worry about scaling :)

It requires that you have an AWS account and credentials that have **Full Admin rights** to the AWS since the 
deployment touches a variety of AWS resources.

## Features

* Notify a channel when an object is created or deleted in a S3 bucket
* Notify a channel when a message is published on a SNS topic
* Configurable S3 buckets and SNS Topics

## Getting started

### 1. Create a Slack webhook
[Create a Slack incoming webhook](https://api.slack.com/incoming-webhooks) for the channel that you want to send the 
notifications to.

### 2. Install the Serverless framework
```
$ sudo npm install serverless -g
```

### 3. Download the project
```
$ serverless project install https://github.com/lukin0110/serverless-slack-notifier
```

### 4. Configure the project

Open the `_meta/variables/s-variables-common.json` file and configure the following 3 parameters:
```
  "s3EventBucket": "dudeBucket",
  "snsTopicName": "dudeTopic",
  "slack_webhook": "https://hooks.slack.com/services/T0d3WTDR$/YT(5M3CJ2/29r5s6ANgxyjkZG6tvwABCDE"
```

### 5. Deploy the project

Install the required `node_modules`:
```
$ npm run init
```

Deploy it:
```
$ npm run deploy
```

## TODO
* notify about DynamoDB events
* notify about CloudWatch events
* notify about Kinesis events
* support multiple S3 buckets
* support multiple SNS topics

## Troubleshooting

Feel free to open a [GitHub issue](https://github.com/lukin0110/serverless-slack-notifier/issues) or bug me on Twitter
[@lukin0110](https://twitter.com/lukin0110).

---
_Source: https://npm.io/package/serverless-slack-notifier · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._