Slack Responder setup guide - snowplow-archive/sauna GitHub Wiki

HOME > GUIDE FOR DEVOPS > SETTING UP SAUNA > RESPONDERS > Slack Responder setup guide

This responder has not yet been released.

See also: Slack Responder user guide

• 1. Overview
• 2. Compatibility
• 3. Slack setup
• 4. Sauna setup
  • 4.1 Avro schema
  • 4.2 Example

This responder lets you communicate with your team via the Slack messaging platform.

This responder will be released in Sauna version TBC.

The Slack responder uses incoming webhooks - simple integrations that can be used to post messages from external sources into Slack. To set up an incoming webhook in your Slack channel,

• Log in to your Slack team as a Team Owner or Administrator.

• Go to Manage → Custom Integrations → Incoming WebHooks → Add Configuration, or use this link to jump to the page immediately.

• Specify the channel that you want to send messages to (e.g. #general), then click on Add Incoming Webhooks Integration to create a new webhook.

• Scroll down to the Integration Settings section and copy the Webhook URL to the Sauna config. (It should be of the form https://hooks.slack.com/services/Txxx/Byyy/ZZZ.) The responder should now be able to send messages to the Slack channel that you've specified previously.

The Slack Responder must be configured using a self-describing Avro which validates against this JSON Schema:

iglu:com.snowplowanalytics.sauna.responders/SlackConfig/avro/1-0-0

The responder can be enabled by placing the following Avro config in the configuration directory (in an .avro or .json file):

{
    "schema": "iglu:com.snowplowanalytics.sauna.responders/SlackConfig/avro/1-0-0",

    "data": {
        "enabled": true,
        "id": "com.acme.MySlackResponder",
        "parameters": {
            "sendMessageEnabled": true,
            "webhookUrl": "https://hooks.slack.com/services/Txxx/Byyy/ZZZ"
        }
    }
}