Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/english/guides/ai-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@ public class AssistantSimpleApp {
}
});

app.use(assistant);
app.assistant(assistant);

app.event(MessageEvent.class, (req, ctx) -> {
return ctx.ack();
Expand Down
22 changes: 10 additions & 12 deletions docs/english/guides/app-distribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ A newly created Slack app can only be installed in its development workspace in

### Slack app configuration

To enable App Distribution, visit the [Slack app settings page](http://api.slack.com/apps), choose the app you're working on, go to **Settings** > **Manage Distribution** on the left pane, and follow the instructions there.
To enable App Distribution, visit the [Slack app settings page](https://api.slack.com/apps), choose the app you're working on, go to **Settings** > **Manage Distribution** on the left pane, and follow the instructions there.

For **Redirect URL**, Bolt apps respond to `https://{your app's public URL domain}/slack/oauth/callback` if you go with recommended settings. To know how to configure such settings, consult the list of the available env variables below in this page.

Expand Down Expand Up @@ -40,7 +40,6 @@ import com.slack.api.bolt.App;
import com.slack.api.bolt.jetty.SlackAppServer;
import java.util.HashMap;
import java.util.Map;
import static java.util.Map.entry;

// API Request Handler App
// expected env variables:
Expand All @@ -58,10 +57,10 @@ apiApp.command("/hi", (req, ctx) -> {
App oauthApp = new App().asOAuthApp(true);

// Mount the two apps with their root path
SlackAppServer server = new SlackAppServer(new HashMap<>(Map.ofEntries(
entry("/slack/events", apiApp), // POST /slack/events (incoming API requests from the Slack Platform)
entry("/slack/oauth", oauthApp) // GET /slack/oauth/start, /slack/oauth/callback (user access)
)));
Map<String, App> apps = new HashMap<>();
apps.put("/slack/events", apiApp); // POST /slack/events (incoming API requests from the Slack Platform)
apps.put("/slack/oauth", oauthApp); // GET /slack/oauth/start, /slack/oauth/callback (user access)
SlackAppServer server = new SlackAppServer(apps);

server.start(); // http://localhost:3000
```
Expand Down Expand Up @@ -107,7 +106,6 @@ import com.slack.api.bolt.service.builtin.AmazonS3OAuthStateService;

import java.util.HashMap;
import java.util.Map;
import static java.util.Map.entry;

// The standard AWS env variables are expected
// export AWS_REGION=us-east-1
Expand Down Expand Up @@ -139,10 +137,10 @@ OAuthStateService stateService = new AmazonS3OAuthStateService(awsS3BucketName);
oauthApp.service(stateService);

// Mount the two apps with their root path
SlackAppServer server = new SlackAppServer(new HashMap<>(Map.ofEntries(
entry("/slack/events", apiApp), // POST /slack/events (incoming API requests from the Slack Platform)
entry("/slack/oauth", oauthApp) // GET /slack/oauth/start, /slack/oauth/callback (user access)
)));
Map<String, App> apps = new HashMap<>();
apps.put("/slack/events", apiApp); // POST /slack/events (incoming API requests from the Slack Platform)
apps.put("/slack/oauth", oauthApp); // GET /slack/oauth/start, /slack/oauth/callback (user access)
SlackAppServer server = new SlackAppServer(apps);

server.start(); // http://localhost:3000
```
Expand Down Expand Up @@ -287,7 +285,7 @@ app.event(TokensRevokedEvent.class, app.defaultTokensRevokedEventHandler());
app.event(AppUninstalledEvent.class, app.defaultAppUninstalledEventHandler());
```

To enable your own custom `InstallationService` classes to work with the built-in event handlers, the classes need to implement the following methods in the [`InstallationService`](https://github.com/seratch/java-slack-sdk/blob/main/bolt/src/main/java/com/slack/api/bolt/service/InstallationService.java) interface:
To enable your own custom `InstallationService` classes to work with the built-in event handlers, the classes need to implement the following methods in the [`InstallationService`](https://github.com/slackapi/java-slack-sdk/blob/main/bolt/src/main/java/com/slack/api/bolt/service/InstallationService.java) interface:

* `void deleteBot(Bot bot)`
* `void deleteInstaller(Installer installer)`
Expand Down
2 changes: 1 addition & 1 deletion docs/english/guides/app-home.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ An [App Home](/surfaces/app-home) is a private, one-to-one space in Slack shared

### Slack app configuration

To enable Home tabs, visit the [Slack app settings page](http://api.slack.com/apps), choose the app you're working on, go to **Features** > **App Home** on the left pane, and then turn on **Home Tab**.
To enable Home tabs, visit the [Slack app settings page](https://api.slack.com/apps), choose the app you're working on, go to **Features** > **App Home** on the left pane, and then turn on **Home Tab**.

To enable the Events API, go to **Features** > **Event Subscriptions** on the left pane. There are a few things to do on the page.

Expand Down
6 changes: 3 additions & 3 deletions docs/english/guides/audit-logs-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ lang: en

# Audit Logs API

The [Audit Logs API](https://api.lack.com/docs/audit-logs-api) is used for monitoring what is happening in your [Enterprise Grid](/enterprise) organization.
The [Audit Logs API](https://api.slack.com/docs/audit-logs-api) is used for monitoring what is happening in your [Enterprise Grid](/enterprise) organization.

The Audit Logs API can be used by security information and event management (SIEM) tools to provide an analysis of how your Slack organization is being accessed. You can also use this API to write your own applications to see how members of your organization are using Slack.

Expand All @@ -20,7 +20,7 @@ import com.slack.api.Slack;
import com.slack.api.audit.*;

Slack slack = Slack.getInstance();
String token = System.getenv("SLACK_ADMIN_ACCESS_TOKN"); // `auditlogs:read` scope required
String token = System.getenv("SLACK_ADMIN_ACCESS_TOKEN"); // `auditlogs:read` scope required
AuditClient audit = slack.audit(token);
```

Expand Down Expand Up @@ -89,7 +89,7 @@ import com.slack.api.audit.*;
import com.slack.api.audit.response.LogsResponse;
import java.util.concurrent.CompletableFuture;

String token = System.getenv("SLACK_ADMIN_ACCESS_TOKN"); // `auditlogs:read` scope required
String token = System.getenv("SLACK_ADMIN_ACCESS_TOKEN"); // `auditlogs:read` scope required
AsyncAuditClient audit = Slack.getInstance().auditAsync(token);

CompletableFuture<LogsResponse> response = audit.getLogs(req -> req
Expand Down
2 changes: 1 addition & 1 deletion docs/english/guides/events-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The [Events API](/apis/events-api/) is a streamlined way to build apps and bots

### Slack app configuration

To enable the Events API, visit the [Slack app settings page](http://api.slack.com/apps), choose the app you're working on, and go to **Features** > **Event Subscriptions** on the left pane. There are a few things to do on the page.
To enable the Events API, visit the [Slack app settings page](https://api.slack.com/apps), choose the app you're working on, and go to **Features** > **Event Subscriptions** on the left pane. There are a few things to do on the page.

* Turn on **Enable Events**
* Set the **Request URL** to `https://{your app's public URL domain}/slack/events` (this step is not required for Socket Mode apps)
Expand Down
6 changes: 3 additions & 3 deletions docs/english/guides/getting-started-with-bolt.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ If instead you would prefer to use the `Java-WebSocket` implementation, swap its
<dependency>
<groupId>org.java-websocket</groupId>
<artifactId>Java-WebSocket</artifactId>
<version>1.5.1</version>
<version>1.6.0</version>
</dependency>
```

Expand Down Expand Up @@ -329,8 +329,8 @@ The default constructor expects the following two environment variables to exist

|Env Variable|Description|
|-|-|
|`SLACK_BOT_TOKEN`|The valid bot token value starting with `xoxb-` in your development workspace. To issue a bot token, install your Slack app that has a bot user to your development workspace. Visit the [Slack app settings page](http://api.slack.com/apps), choose the app you're working on, and go to **Settings** > **Install App** on the left pane (Add [`app_mentions:read`](/reference/scopes/app_mentions.read) bot scope if you see the message saying "Please add at least one feature or permission scope to install your app.").<br/><br/> If you run an app that is installable for multiple workspaces, no need to specify this. Consult [App Distribution (OAuth)](/tools/java-slack-sdk/guides/app-distribution) for further information.|
|`SLACK_SIGNING_SECRET`|The secret value shared only with the Slack Platform. It is used for verifying incoming requests from Slack. Request verification is crucial for security as Slack apps have internet-facing endpoints. To know the value, visit the [Slack app settings page](http://api.slack.com/apps), choose the app you're working on, go to **Settings** > **Basic Information** on the left pane, and find **App Credentials** > **Signing Secret** on the page. Refer to [Verifying requests from Slack](/authentication/verifying-requests-from-slack) for more information.|
|`SLACK_BOT_TOKEN`|The valid bot token value starting with `xoxb-` in your development workspace. To issue a bot token, install your Slack app that has a bot user to your development workspace. Visit the [Slack app settings page](https://api.slack.com/apps), choose the app you're working on, and go to **Settings** > **Install App** on the left pane (Add [`app_mentions:read`](/reference/scopes/app_mentions.read) bot scope if you see the message saying "Please add at least one feature or permission scope to install your app.").<br/><br/> If you run an app that is installable for multiple workspaces, no need to specify this. Consult [App Distribution (OAuth)](/tools/java-slack-sdk/guides/app-distribution) for further information.|
|`SLACK_SIGNING_SECRET`|The secret value shared only with the Slack Platform. It is used for verifying incoming requests from Slack. Request verification is crucial for security as Slack apps have internet-facing endpoints. To know the value, visit the [Slack app settings page](https://api.slack.com/apps), choose the app you're working on, go to **Settings** > **Basic Information** on the left pane, and find **App Credentials** > **Signing Secret** on the page. Refer to [Verifying requests from Slack](/authentication/verifying-requests-from-slack) for more information.|

If you prefer configuring an `App` in a different way, write some code to initialize `AppConfig` on your own.

Expand Down
2 changes: 1 addition & 1 deletion docs/english/guides/incoming-webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ lang: en

### Slack app configuration

To enable this feature, visit the [Slack app settings page](http://api.slack.com/apps), choose the app you're working on, go to **Features** > **Incoming Webhooks** on the left pane, and then turn on **Activate Incoming Webhooks**.
To enable this feature, visit the [Slack app settings page](https://api.slack.com/apps), choose the app you're working on, go to **Features** > **Incoming Webhooks** on the left pane, and then turn on **Activate Incoming Webhooks**.

Then, install the app to your development workspace. Each time your app is installed, a new webhook URL will be generated.

Expand Down
2 changes: 1 addition & 1 deletion docs/english/guides/interactive-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ See [Composing messages](/tools/java-slack-sdk/guides/composing-messages) to lea

### Slack app configuration

To enable interactive components, visit the [Slack app settings page](http://api.slack.com/apps), choose the app you're working on, and go to **Features** > **Interactivity & Shortcuts** on the left pane. There are three things to do on the page.
To enable interactive components, visit the [Slack app settings page](https://api.slack.com/apps), choose the app you're working on, and go to **Features** > **Interactivity & Shortcuts** on the left pane. There are three things to do on the page.

* Turn on the feature
* Set the **Request URL** to `https://{your app's public URL domain}/slack/events` (this step is not required for Socket Mode apps)
Expand Down
2 changes: 1 addition & 1 deletion docs/english/guides/modals.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ lang: en

## Slack app configuration

The first step to use modals in your app is to enable interactive components. Visit the [Slack app settings page](http://api.slack.com/apps), choose the app you're working on, and go to **Features** > **Interactivity & Shortcuts** on the left pane. There are three things to do on the page.
The first step to use modals in your app is to enable interactive components. Visit the [Slack app settings page](https://api.slack.com/apps), choose the app you're working on, and go to **Features** > **Interactivity & Shortcuts** on the left pane. There are three things to do on the page.

* Turn on the feature
* Set the **Request URL** to `https://{your app's public URL domain}/slack/events` (this step is not required for Socket Mode apps)
Expand Down
2 changes: 1 addition & 1 deletion docs/english/guides/scim-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import com.slack.api.Slack;
import com.slack.api.scim.*;

Slack slack = Slack.getInstance();
String token = System.getenv("SLACK_ADMIN_ACCESS_TOKN"); // `admin` scope required
String token = System.getenv("SLACK_ADMIN_ACCESS_TOKEN"); // `admin` scope required
SCIMClient scim = slack.scim(token);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/english/guides/shortcuts.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Your app has 3 seconds to call `ack()`, which acknowledges a shortcut request is

### Slack app configuration

To enable shortcuts, visit the [Slack app settings page](http://api.slack.com/apps), choose the app you're working on, and go to **Features** > **Interactivity & Shortcuts** on the left pane. There are four things to do on the page.
To enable shortcuts, visit the [Slack app settings page](https://api.slack.com/apps), choose the app you're working on, and go to **Features** > **Interactivity & Shortcuts** on the left pane. There are four things to do on the page.

* Turn on the feature
* Set the **Request URL** to `https://{your app's public URL domain}/slack/events` (this step is not required for Socket Mode apps)
Expand Down
2 changes: 1 addition & 1 deletion docs/english/guides/slash-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Responding to slash command invocations is a common use case. Your app has to re

## Slack app configuration

To enable slash commands, visit the [Slack app settings page](http://api.slack.com/apps), choose the app you're working on, go to **Features** > **Slash Commands** on the left pane. There are a few things to do there on the page.
To enable slash commands, visit the [Slack app settings page](https://api.slack.com/apps), choose the app you're working on, go to **Features** > **Slash Commands** on the left pane. There are a few things to do there on the page.

* Click **Create New Command** button
* Input the command information on the dialog:
Expand Down
2 changes: 1 addition & 1 deletion docs/english/guides/socket-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ With [Socket Mode](/apis/events-api/using-socket-mode), instead of creating a se

## Slack app configuration

To enable Socket Mode, visit the [Slack app settings page](http://api.slack.com/apps), choose the app you're working on, and go to **Settings** on the left pane. There are a few things to do on the page.
To enable Socket Mode, visit the [Slack app settings page](https://api.slack.com/apps), choose the app you're working on, and go to **Settings** on the left pane. There are a few things to do on the page.

* Go to **Settings** > **Basic Information**
* Add a new **App-Level Token** with the [`connections:write`](/reference/scopes/connections.write) scope
Expand Down
2 changes: 1 addition & 1 deletion docs/english/guides/steps-from-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ All three events must be handled for a workflow step to function.

### Slack app configuration

To enable Steps from Apps, visit the [Slack app settings page](http://api.slack.com/apps), choose the app you're working on, and go to **Features** > **Workflow Steps** on the left pane. There are two things to do on the page.
To enable Steps from Apps, visit the [Slack app settings page](https://api.slack.com/apps), choose the app you're working on, and go to **Features** > **Workflow Steps** on the left pane. There are two things to do on the page.

* Turn on the feature (**Turn on workflow steps**)
* Click the **Add Step** button and set the name and Callback ID
Expand Down
3 changes: 2 additions & 1 deletion docs/english/guides/supported-web-frameworks.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,8 +227,9 @@ The simplest way is to have some code that initializes the **App** instance in a
package hello;

import com.slack.api.bolt.App;
import com.slack.api.bolt.AppConfig;
import io.micronaut.context.annotation.Factory;
import javax.inject.Singleton;
import jakarta.inject.Singleton;

@Factory
public class AppFactory {
Expand Down
2 changes: 1 addition & 1 deletion docs/english/guides/web-api-basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -479,4 +479,4 @@ config.getHttpClientResponseHandlers().add(new ResponsePrettyPrintingListener())
Slack slack = Slack.getInstance(config);
```

You may encounter situations where more configurable options or flexibilities while making real-world applications would be helpful. If you have feature requests, go to our [GitHub Issue Tracker](http://github.com/slackapi/java-slack-sdk/issues) and tell us about it.
You may encounter situations where more configurable options or flexibilities while making real-world applications would be helpful. If you have feature requests, go to our [GitHub Issue Tracker](https://github.com/slackapi/java-slack-sdk/issues) and tell us about it.
2 changes: 1 addition & 1 deletion docs/english/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ These docs have lots of information on Bolt for Java and the Java Slack SDK. The

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

* Visit the [Issue Tracker](http://github.com/slackapi/java-slack-sdk/issues) for questions, bug reports, feature requests, and general discussion related to Bolt for Java. Try searching for an existing issue before creating a new one.
* Visit the [Issue Tracker](https://github.com/slackapi/java-slack-sdk/issues) for questions, bug reports, feature requests, and general discussion related to Bolt for Java. Try searching for an existing issue before creating a new one.
* Visit the [Slack Developer Community](https://slackcommunity.com/) for getting help or for bonding with your fellow Slack developers.
* [Email](mailto:support@slack.com) our developer support team: `support@slack.com`.

Expand Down
Loading