Slack

A behaviour module for implementing Slack realt time messaging through a websocket connection.

To use this module you will need a valid Slack API token. You can find your token on the Slack Web API page.

Example

defmodule SlackRtm do
  use Slack

  def start_link(initial_state) do
    Slack.start_link(__MODULE__, "token_value", initial_state)
  end

  def init(state, slack) do
    IO.puts "Connected as #{slack.me.name}"
    {:ok, state}
  end

  def handle_message({:type, "message", response}, slack, state) do
    Slack.send_message("Received message!", response.channel, slack)
    state = state ++ [response.text]
    {:ok, state}
  end

  def handle_message({:type, type, _response}, _slack, state) do
    IO.puts "No callback for #{type}"
    {:ok, state}
  end

  def handle_close(reason, slack, state) do
    IO.puts "Websocket closed!"
  end
end

Slack has a large variety of types it can send you, so it’s wise ot have a catch all handle like above to avoid crashing.

Callbacks

• init(state, slack_state) - Called when the websocket connection starts

  It must return:

  • {:ok, state}

• handle_message({:type, type, json_map}, slack_state, state)

  It must return:

  • {:ok, state}
• handle_close(reason, slack_state, state)

You can find every type Slack will respond with and examples of each on the Slack RTM API page.