Slack SDK for Java
ζ—₯本θͺž (Japanese) Go to GitHub

Slack SDK for Java

Slack SDK for Java supports the Slack platform in a Java idiomatic way. The SDK written in Java so developers can use it in any JVM language including Kotlin, Groovy, and Scala.

Within the SDK, there are two different modules:

  • Bolt for Java, which is a framework with a simple API that makes it easy to write modern Slack apps in Java.
  • Slack API Client, for when you need a more customized approach to building a Slack app in Java.

Modules

The table below shows all the available modules in the Slack Java SDK. All of them have the same latest version as we release all at the same time, even in the case that some don’t have any changes apart from updates on their dependency side.

All released versions are available on the Maven Central repositories. The latest version is 1.29.2.

Bolt & Built-in Extensions

groupId:artifactId Description
com.slack.api:bolt πŸ“– Bolt is a framework that offers an abstraction layer to build Slack apps safely and quickly.
com.slack.api:bolt-socket-mode πŸ“– This module offers a handy way to run Bolt apps through Socket Mode connections.
com.slack.api:bolt-servlet πŸ“– This module offers a handy way to run Bolt apps on the Java EE Servlet environments.
com.slack.api:bolt-jetty πŸ“– This module offers a handy way to run Bolt apps on the Java EE compatible Jetty HTTP server (9.x).
com.slack.api:bolt-jakarta-servlet πŸ“– This module offers a handy way to run Bolt apps on the Jakarta EE Servlet environments.
com.slack.api:bolt-jakarta-jetty πŸ“– This module offers a handy way to run Bolt apps on the Jakarta EE compatible Jetty HTTP server.
com.slack.api:bolt-aws-lambda πŸ“– This module offers a handy way to run Bolt apps on AWS API Gateway + Lambda.
com.slack.api:bolt-google-cloud-functions πŸ“– This module offers a handy way to run Bolt apps on Google Cloud Functions.
com.slack.api:bolt-micronaut πŸ“– This is an adapter for Micronaut to run Bolt apps on top of it.
com.slack.api:bolt-helidon πŸ“– This is an adapter for Helidon SE to run Bolt apps on top of it.
com.slack.api:bolt-http4k πŸ“– This is an adapter for http4k to run Bolt apps on top of any of the multiple server backends that the library supports.
com.slack.api:bolt-ktor πŸ“– This is an adapter for Ktor to run Bolt apps on top of it.

Foundation Modules

groupId:artifactId Description
com.slack.api:slack-api-model πŸ“– This is a collection of the classes representing the Slack core objects such as conversations, messages, users, blocks, and surfaces. As this is an essential part of the SDK, all other modules depend on this.
com.slack.api:slack-api-model-kotlin-extension πŸ“– This contains the Block Kit Kotlin DSL builder, which allows you to define block kit structures via a Kotlin-native DSL.
com.slack.api:slack-api-client πŸ“– This is a collection of the Slack API clients. The supported are Basic API Methods, Socket Mode API, RTM API, SCIM API, Audit Logs API, and Status API.
com.slack.api:slack-api-client-kotlin-extension πŸ“– This contains extension methods for various slack client message builders so you can seamlessly use the Block Kit Kotlin DSL directly on the Java message builders.
com.slack.api:slack-app-backend πŸ“– This module is a set of Slack app server-side handlers and data classes for Events API, Interactive Components, Slash Commands, Actions, and OAuth flow. These are used by Bolt framework as the foundation of it in primitive layers.

Requirements

The SDK supports OpenJDK 8 and higher LTS versions.

Users can expect every single patch release has been done after verifying functionality by running the basic CI builds with all LTS versions and all the unit tests have passed at least on the latest LTS version. We don’t run comprehensive verifications with all OpenJDK distributions but it should be working with all of them.

Getting Help

If you get stuck, we’re here to help. The following are the best ways to get assistance working through your issue: