wow-apps/symfony-slack-bot

Simple Symfony 3 and 4 Bundle for sending customizeable messages to Slack via incoming webhooks

Installs: 9 287

Dependents: 0

Suggesters: 0

Stars: 17

Watchers: 6

Forks: 8

Open Issues: 1

Type:symfony-bundle

4.0.2 2019-05-13 10:53 UTC

README

SlackBot banner

SensioLabsInsight

Packagist version Packagist Downloads

Maintainability Codacy Badge Scrutinizer Code Quality

Travis CI Build Scrutinizer Build ContinuousPHP Build

Code Coverage

Symfony Slack Bot

Simple Symfony 3 and 4 Bundle for sending customizable messages to Slack via incoming webhooks.

Requires:

  • PHP 7.0+
  • Symfony 3.0+
  • Guzzle Client 6.0+

Installation:

Step 1: Download the Bundle

"require": {
        "wow-apps/symfony-slack-bot": "^4.0"
}

or

$ composer require wow-apps/symfony-slack-bot 

Step 2: Enable the Bundle (skip for Symfony 4)

// ./app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new WowApps\SlackBundle\WowAppsSlackBundle(),
    );

    // ...

    return $bundles
}

Step 3: Add configuration (skip for Symfony 4)

# SlackBot Configuration
services:
    # SlackBot Configuration
    wow_apps_slack:
        api_url: "%env(WOW_APPS_SLACK_BOT_API_URL)%"
        default_icon_url: "https://wow-apps.github.io/symfony-slack-bot/public/message-icon.png"
        default_channel: "general"
        default_username: "wow-apps/symfony-slack-bot"
        default_fallback: "Can't display attachment in plain-text mode"
        colors:
            default: "#607D8B"
            info: "#2196F3"
            warning: "#FF5722"
            success: "#8BC34A"
            danger: "#F44336"
        templates:
            exception:
                username: "Exception"
                channel: "general"
                icon: "https://wow-apps.github.io/symfony-slack-bot/public/exception-icon.png"

see more about override default parameters

Send test message:

To test your configuration, send test message by next command:

./bin/console wowapps:slackbot:test

Test command result preview

Documentation

  • Actual version 4.x
  • Unmaintained version 3.x

News and updates

Follow news and updates in my Telegram channel @wow_apps_pro or Twitter @alexey_samara_

Say thanks

I don't ask for donates, I do what I do for free, for all development community. But I will be grateful if you inform me on the email in which project you are using this Bundle, as well as I will be glad to criticize and suggestions.

e-mail

License

MIT © 2016 - 2019 Alexey Samara & contributors

Contribute

Do you want to make a change? Pull requests are welcome.