Numerous Pancakes Munched

    navy-admiral-slack-notifier

    0.0.1 • Public • Published

    navy-admiral-slack-notifier

    Send notifications to Slack after an Order is successfully executed.

    Installation

    Run the following on the same server that the Admrial is installed on:

    npm install -g navy-admiral-slack-notifier
    

    Usage

    This plugin assumes that a slackNotifer hash containing the following options has been added to the Admiral for the application you want notifications to be posted for.

    • slackToken: Slack integration Token (required)
    • slackOrg: Name of your Slack Organisation (required)
    • channel: Slack channel to which notification should be posted (required)
    • botName: The username that notification messages should be posted as (optional. Default is "admiralbot")
    • orders: An array of Order names. If specified, notifications will only be posted for these Orders (optional. Default is all Orders)

    An example Admiral application configuration might look like:

    { "name": "My Application"
    , "appId": "myApp"
    , "slackNotifier":
      { "slackToken": "asasasdfasdf"
      , "slackOrg": "myOrg"
      , "channel": "general"
      , "botName": "mybot"
      , "orders": [ "orderName" ]
      }
    }
    

    Keywords

    none

    Install

    npm i navy-admiral-slack-notifier

    DownloadsWeekly Downloads

    1

    Version

    0.0.1

    License

    none

    Last publish

    Collaborators

    • microadam