Skip to content

infinitypaul/honeybadge

Repository files navigation

a production-ready web endpoint that accepts a JSON payload as a POST request and sends an alert to a Slack channel if the payload matches desired criteria.

Creator

Tech Stack

  • Laravel
  • Mysql
  • PHP

Download Instruction

  1. Clone the project.
git clone https://github.com/infinitypaul/honeybadge.git projectname
  1. Install dependencies via composer.
composer install 
  1. Run php server.
php artisan serve

Troubleshooting

Setup

The slack channel requires a url configuration option. This URL should match a URL for an incoming webhook that you have configured for your Slack team. https://slack.com/apps/A0F7XDUAZ-incoming-webhooks

Add the webhook url to your .env
LOG_SLACK_WEBHOOK_URL=

Api Usage

Using POST Request:

POST http://localhost/api/notify

payload: {
  "RecordType": "Bounce",
  "Type": "SpamNotification",
  "TypeCode": 512,
  "Name": "Spam notification",
  "Tag": "",
  "MessageStream": "outbound",
  "Description": "The message was delivered, but was either blocked by the user, or classified as spam, bulk mail, or had rejected content.",
  "Email": "[email protected]",
  "From": "[email protected]",
  "BouncedAt": "2023-02-27T21:41:30Z"
}

And Viola.

Enjoy!!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages