btrz-webhooks-emitter/README.md

Betterez simple client to emit events to the webhooks pipeline

# btrz-webhooks-emitter

Betterez library for emitting webhooks to the SQS queue.

# Configuration
This lib will use the following ENV variables:
  * AWS_SERVICE_KEY
  * AWS_SERVICE_SECRET
  * SQS_QUEUE_URL
  * WEBHOOK_COMPRESS (optional) – when set to `zstd` or `gzip`, the message `data` payload is compressed (base64-encoded); when unset or any other value, messages stay plain. Values are case-insensitive.

# How to use
```javascript
const btrzEmitter = require("btrz-webhooks-emitter");

const attrs = {
  providerId: "123",
  data: {foo: "bar"}
};

btrzEmitter.emitEvent("transaction.created", attrs);
```

`btrzEmitter.emitEvent()` will send asynchronously a message to SQS and no response, it will log an error if exists.

It's recommendable to send a third param with the logger you are using:
```javascript
btrzEmitter.emitEvent("transaction.created", attrs, logger);
```

# Denied fields
`btrz-webhooks-denied-fields` library will be consumed to filter off the possible denied fields.
 
# Test
`AWS_SERVICE_KEY=YOUR_KEY AWS_SERVICE_SECRET=YOUR_SECRET_KEY SQS_QUEUE_URL=YOUR_QUEUE_URL npm test`