clj-slack

clj-slack is a Clojure library to talk to the Slack REST API. It supports almost the entire Slack API.

Documentation

Slack API methods are described here.

clj-slack documentation is available here.

Usage

This is on Clojars of course. Just add [org.julienxx/clj-slack "0.8.3"] to your :dependencies in your project.clj file.

Get your access token by creating a new app or here. If you create a new Slack app, don't forget to add the relevant scopes to your app.

Your need to create a connection map like {:api-url "https://slack.com/api" :token "YOUR TOKEN"} and pass it as the first argument of every functions in clj-slack. Of course you can change api-url for debugging or testing purposes.

You can pass clj-http options in the connection map if needed.

clj-slack will throw an Exception if the connection map you're trying to use is not valid.

Example:

(require 'clj-slack.users)
(def connection {:api-url "https://slack.com/api" :token "YOUR TOKEN"})
(clj-slack.users/list connection)

You can use optional params described in Slack API by passing them through a map.

(require 'clj-slack.stars)
(def connection {:api-url "https://slack.com/api" :token "YOUR TOKEN"})
(clj-slack.stars/list connection {:count "2" :page "3"})

Uploading a file:

(require 'clj-slack.files)
(def connection {:api-url "https://slack.com/api" :token "YOUR TOKEN"})
(clj-slack.files/upload connection (clojure.java.io/input-stream "/path/to/file/file.ext") {:channels "CHANNEL_ID", :title "This is a file.})

Testing

In order to run the tests, you have to set 3 environment variables:

• TOKEN a legacy Slack token
• CLIENT_ID a OAuth client id
• CLIENT_SECRET a OAuth client secret then run lein test.

License

Copyright (C) 2014-2023 Julien Blanchard

Distributed under the Eclipse Public License, the same as Clojure.