https://github.com/jackcoded/newman-reporter-slackmsg

Custom Newman reporter for slack
https://github.com/jackcoded/newman-reporter-slackmsg

newman newman-reporter-slackmsg slack slack-bots webhook-url

Last synced: 2 months ago
JSON representation

Custom Newman reporter for slack

• Host: GitHub
• URL: https://github.com/jackcoded/newman-reporter-slackmsg
• Owner: jackcoded
• Created: 2020-06-14T23:38:45.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T09:17:55.000Z (almost 2 years ago)
• Last Synced: 2024-09-29T18:23:11.659Z (3 months ago)
• Topics: newman, newman-reporter-slackmsg, slack, slack-bots, webhook-url
• Language: JavaScript
• Homepage:
• Size: 838 KB
• Stars: 16
• Watchers: 2
• Forks: 25
• Open Issues: 13
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# newman-reporter-slackmsg

Custom [Newman](https://github.com/postmanlabs/newman) reporter to send message to [Slack](https://slack.com/)



## Before you get started

- Install [Newman](https://github.com/postmanlabs/newman) ``` $ npm run i -g newman ```

- Create a [Slack incoming webhook url](https://api.slack.com/messaging/webhooks)

or

- Create a [Slack bot to send to channel or user dynamically](https://api.slack.com/messaging/sending)

## Installation

 ```CLI

 npm i -g newman-reporter-slackmsg

 ```

## Usage

```CLI

 newman run  -e  --suppress-exit-code -r slackmsg --reporter-slackmsg-webhookurl ''

```

## Usage with channel override bot

```CLI

 newman run  -e  --suppress-exit-code -r slackmsg --reporter-slackmsg-webhookurl '' --reporter-slackmsg-token '' --reporter-slackmsg-channel ''

```

## Reporter Options Optionals

```

 --reporter-slackmsg-messageSize '' e.g 150

 --reporter-slackmsg-token '' e.g xoxb-XXXXXXXXXXXX-TTTTTTTTTTTTTT

 --reporter-slackmsg-channel '' e.g #general

 --reporter-slackmsg-failuresChannel '' e.g. #alerts

 --reporter-slackmsg-collection ' e.g test.json

 --reporter-slackmsg-environment ' e.g env.json

 --reporter-slackmsg-reportingurl ' e.g https://127.0.1/index.html

  --reporter-slackmsg-limitFailures '; e.g 5

```

## Reporter Options

**webhookurl** 

Webhook URL to point to the slack api where results are published

**collection** 

Option to add the name of collection file onto the message

**environment**

Option to add the name of environment file onto the message

**messageSize**

Option to change the message size, defaulted to 100

**token**

Option to use bearer token for slack bots for channel override

**channel**

Option to select channel or user receive the result

**failuresChannel**

Option to select channel or user to receive failures

**limitFailures**

Option to limit the amount failures shown in slack