xteam/slackmessengerbundle

An integration bundle with slack

v0.1.1 2016-03-04 17:28 UTC

This package is not auto-updated.

Last update: 2024-12-11 10:02:14 UTC


README

This bundle allows you to receive and publish messages from Slack mapped to Message objects.

Scrutinizer Code Quality ScrutinizerBuild Status Travis Build Status SensioLabsInsight

Extending

To receive messages you need to create an EventListener which will be listening to the event slack.message_received

Example:

namespace PP\AwesomeBundle\EventListener;

use XTeam\SlackMessengerBundle\Event\MessageEvent;

class AwesomeWorkListener
{
    public function doYourJob(MessageEvent $event)
    {
        $message = $event->getMessage();
        /** Do the right job **/
    }
}

And register this in services.yml

;PP/AwesomeBundle/Resources/config/service.yml
services:
    pp_awesome.awesome.listener:
        class: %pp_awesome.awesome.listener.class%
        tags:
            - { name: kernel.event_listener, event: slack.message_received, method: doYourJob }

Installation

Step 1: Composer require

$ php composer.phar require xteam/slackmessengerbundle "dev-master"

Step 2: Enable the bundle

Enable the bundle in the kernel:

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new XTeam\SlackMessengerBundle\XTeamSlackMessengerBundle(),
    );
}

Step 3: Add options to parameters.yml

#app/config/parameters.yml
parameters:
  # ...
  slack.token: Your SLack token

Step 4: Add routes

#app/congig/routes.yml

x_team_slack_messenger:
    resource: "@XTeamSlackMessengerBundle/Resources/config/routing.yml"
    prefix:   /

Notes

This bundle requires a Symfony in version higher or equal 2.7

Usage example

curl -X POST --data 'token=XXXXXXXXXXXXXXXXXX&team_id=T0001&team_domain=example&channel_id=C2147483705&channel_name=test&timestamp=1355517523.000005&user_id=U2147483697&user_name=Steve&text=googlebot: What is the air-speed velocity of an unladen swallow?&trigger_word=googlebot' http://localhost/app_dev.php/v1/message/post

curl -X POST --data 'token=XXXXXXXXXXXXXXXXXX&team_id=T0001&team_domain=example&channel_id=C2147483705&channel_name=test&timestamp=1355517523.000005&user_id=U2147483697&user_name=Steve&text=googlebot: What is the air-speed velocity of an unladen swallow? /five <@U07E9557H> and <@U07HSHYAU>&trigger_word=googlebot' http://localhost/app_dev.php/v1/message/post