https://github.com/rohitjmathew/hubot-slack-attachment-optimised

Re-enable `slack-attachment` event for hubot-slack
https://github.com/rohitjmathew/hubot-slack-attachment-optimised

coffeescript hubot slack

Last synced: 26 days ago
JSON representation

Re-enable `slack-attachment` event for hubot-slack

• Host: GitHub
• URL: https://github.com/rohitjmathew/hubot-slack-attachment-optimised
• Owner: rohitjmathew
• License: mit
• Created: 2019-05-30T10:28:13.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-05-30T20:19:04.000Z (over 5 years ago)
• Last Synced: 2024-10-06T04:01:54.423Z (3 months ago)
• Topics: coffeescript, hubot, slack
• Language: CoffeeScript
• Size: 8.79 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Re-enable `slack-attachment` in [hubot-slack][hubot-slack]

When Slack introduced version 3 of their [hubot-slack][hubot-slack] adapter the old `slack-attachment` was removed due to [constraints in the RTM API](https://github.com/slackhq/hubot-slack/issues/108). This is a personalised implementation of [hubot-slack-attachment](https://github.com/inkel/hubot-slack-attachment).

This module attempts to reintroduce the event using [Incoming Webhooks][incoming] to somehow replicate the lost feature.

To use again `slack-attachment` events, just run the following in your hubot repository:

```

npm install hubot-slack-attachment-optimised --save

```

And then add `hubot-slack-attachment-optimised` to `external-scripts.json`.

Last but not least, you need to add the environment variable `HUBOT_SLACK_INCOMING_WEBHOOK` to the URL for the new [incoming webhook][incoming] you've just defined.

## Usage

Emit a `slack.attachment` event with the following parameters:

```coffee

robot.emit 'slack.attachment',

  message: msg.message

  content:

    # see https://api.slack.com/docs/attachments

    text: "Attachment text"

    fallback: "Attachment fallback"

    fields: [{

      title: "Field title"

      value: "Field value"

    }]

  channel: "#general" # optional, defaults to message.room

  username: "foobot" # optional, defaults to robot.name

  icon_url: "..." # optional

  icon_emoji: "..." # optional

```

## Known Issues

* The user name sending the attachment will be `#{robot.name} (bot)`, so if your bot is named `hubot` it will appear as `hubot (bot)`

[hubot-slack]: https://github.com/slackhq/hubot-slack

[incoming]: https://my.slack.com/services/new/incoming-webhook

## License

This software is licensed under MIT License. See [LICENSE][LICENSE] for more details.