An asynchronous HTTP client for Slack's web API
Clone or download
Latest commit e412282 Nov 7, 2018

README.md

slack-client

license GitHub last commit Build Status GitHub release Maven metadata URI

Overview

An asychronous HTTP client wrapping Slack's RPC-style web api. Provides an extensible API with builder-style parameters and responses, allowing you to focus on your interactions with users, rather than your interactions with Slack. Notably, we:

  • Implement most of Slack's web API
  • Actively maintain this project
  • Provide per-method in-memory rate limiting so you don't have to worry about overwhelming slack from a single process
  • Expose highly configurable hooks to allow filtering and debugging in an extensible way

Features

We currently support:

auth

  • auth.test
  • auth.revoke

channels

  • channels.history
  • channels.info
  • channels.list
  • channels.replies (findReplies)

chat

  • chat.delete
  • chat.getPermalink
  • chat.postEphemeral
  • chat.postMessage
  • chat.update

conversations

  • conversations.archive
  • conversations.create
  • conversations.history
  • conversations.info
  • conversations.invite
  • conversations.list
  • conversations.open
  • conversations.unarchive

dialog

  • dialog.open

files

  • files.upload
  • files.sharedPublicURL

groups

  • groups.list
  • groups.replies (findReplies)

im

  • im.open

reactions

  • reactions.add

search

  • search.messages

usergroups

  • usergroups.create
  • usergroups.disable
  • usergroups.enable
  • usergroups.list
  • usergroups.update

usergroups.users

  • usergroups.users.update

users

  • users.conversations
  • users.info (findUser)
  • users.list
  • users.lookupByEmail

Utility Methods

  • getConversationByName
  • getChannelByName

We happily welcome any PRs for APIs that haven't yet been implemented!

Usage

To use with Maven-based projects, add the following dependencies::

<dependency>
  <groupId>com.hubspot.slack</groupId>
  <artifactId>slack-base</artifactId>
  <version>{latest version}</version>
</dependency>
<dependency>
  <groupId>com.hubspot.slack</groupId>
  <artifactId>slack-java-client</artifactId>
  <version>{latest  version}</version>
</dependency>

Latest version can be seen here, on Maven central.

Seting up Guice

Install the SlackClientModule in the Guice module you want to use to talk to slack.

public class MyFancyModule extends AbstractModule {
  @Override
  protected void configure() {
    install(new SlackClientModule());
  }
}

Finally inject the factory where you want to build the client:

public class MySlacker {
  private final SlackClient slackClient;
  
  
  public MySlacker(
      SlackWebClient.Factory clientFactory
  ) {
    this.slackClient = clientFactory.build(
        SlackClientRuntimeConfig.builder()
          .setTokenSupplier(() -> "your token here")
          // ... all your configuration here
          .build()
    );
  }
  
  // then just use the client!
}

Using the Client

If you're not familiar with Java 8's CompletableFuture API, know that you can transform this client from an asynchronous one to a synchronous one by calling join on any of the futures returned. To simplify getting started, we've included an example module with some common tasks to give you a feel for how you can interact with the client.

Contributors

License

Copyright 2018 HubSpot, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.