# hubot-sqs

> Send AWS SQS messages to Hubot

Latest version **1.3.0** (published 2017-04-28) · CC0 license · 0 weekly downloads

## Install

```sh
npm install hubot-sqs
pnpm add hubot-sqs
yarn add hubot-sqs
bun add hubot-sqs
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.0 |
| Published | 2017-04-28 |
| First published | 2017-04-18 |
| Weekly downloads | 0 |
| License | CC0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Chris Contolini |
| Maintainers | contolini |
| Keywords | hubot, hubot-scripts, aws, sqs |

## Links

- npm: https://www.npmjs.com/package/hubot-sqs
- Repository: https://github.com/catops/hubot-sqs
- Homepage: https://github.com/catops/hubot-sqs#readme
- Issues: https://github.com/catops/hubot-sqs/issues
- npm.io page: https://npm.io/package/hubot-sqs

## Dependencies (2)

- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.41.0
- [coffee-script](https://npm.io/package/coffee-script.md) ~1.10

## 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

- 1.3.0 (latest) — 2017-04-28
- 1.2.0 — 2017-04-21
- 1.1.0 — 2017-04-18
- 1.0.0 — 2017-04-18

## README

# hubot-sqs [![Build Status](https://img.shields.io/travis/catops/hubot-sqs.svg?maxAge=2592000&style=flat-square)](https://travis-ci.org/catops/hubot-sqs) [![npm](https://img.shields.io/npm/v/hubot-sqs.svg?maxAge=2592000&style=flat-square)](https://www.npmjs.com/package/hubot-sqs)

:cat: Send AWS SQS messages to Hubot

See [`src/sqs.coffee`](src/sqs.coffee) for full documentation.

## Installation

In hubot project repo, run:

`npm install hubot-sqs --save`

Then add **hubot-sqs** to your `external-scripts.json`:

```json
["hubot-sqs"]
```

## Configuration

### HUBOT_AWS_SQS_QUEUE_URL

You have to specify the queue URL to pull commands from.

e.g.: `https://sqs.us-east-1.amazonaws.com/XXXXXXXXXXXXX/hubot-queue`

### HUBOT_AWS_SQS_ACCESS_KEY_ID, HUBOT_AWS_SQS_SECRET_ACCESS_KEY

Your AWS account's access key ID and secret access key.

### HUBOT_AWS_SQS_REGION

You can configure the region of SQS with HUBOT_AWS_SQS_REGION, which defaults to `us-east-1`.

## Commands

The SQS messages needs to be in the following JSON format:

```json
{
    "MessageBody": "What's up?!",
    "MessageAttributes": {
        "user": {
            "DataType": "String",
            "StringValue": "CFPBot"
        },
        "room": {
            "DataType": "String",
            "StringValue": "off-topic"
        }
    }
}

```

Assuming the above JSON is in a file called `message.json`, it can be sent to SQS using the command:

```sh
aws sqs send-message --queue-url https://sqs.us-east-1.amazonaws.com/XXXXXXXXXXXXX/hubot-queue --cli-input-json file://message.json
```

Hubot will receive the message and post it to the specified room.

## Original author

Tatsuhiko Miyagawa (check out [hubot-incoming-sqs](https://github.com/miyagawa/hubot-incoming-sqs))

## Contributing

Please read our general [contributing guidelines](CONTRIBUTING.md).

## Open source licensing info
1. [TERMS](TERMS.md)
2. [LICENSE](LICENSE)
3. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)

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