You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -75,15 +75,15 @@ While the `assistant_thread_started` and `assistant_thread_context_changed` even
75
75
76
76
If you do provide your own `threadContextService` property, it must feature `get` and `save` methods.
77
77
78
-
:::tip
78
+
:::tip[Tip]
79
79
Be sure to give the [AI apps reference docs](/reference#agents--assistants) a look!
80
80
:::
81
81
82
82
## Handling a new thread {#handling-a-new-thread}
83
83
84
84
When the user opens a new thread with your AI app, the [`assistant_thread_started`](https://docs.slack.dev/reference/events/assistant_thread_started) event will be sent to your app.
85
85
86
-
:::tip
86
+
:::tip[Tip]
87
87
When a user opens a thread with your app while in a channel, the channel info is stored as the thread's `AssistantThreadContext` data. You can grab that info by using the `context.getThreadContext()` utility, as subsequent user message event payloads won't include the channel info.
Copy file name to clipboardExpand all lines: docs/content/guides/app-home.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,11 +6,11 @@ lang: en
6
6
7
7
An [App Home](https://docs.slack.dev/surfaces/app-home) is a private, one-to-one space in Slack shared by a user and an app. Each App Home contains a number of tabbed surfaces, including a Messages tab for app-user conversation, and a Home tab that can be fully customized by the app.
8
8
9
-
### Slack App Configuration
9
+
### Slack app configuration
10
10
11
-
To enable Home tabs, visit the [Slack App configuration 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**.
11
+
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**.
12
12
13
-
To enable Events API, go to **Features** > **Event Subscriptions** on the left pane. There are a few things to do on the page.
13
+
To enable the Events API, go to **Features** > **Event Subscriptions** on the left pane. There are a few things to do on the page.
14
14
15
15
* Turn on **Enable Events**
16
16
* Set the **Request URL** to `https://{your app's public URL domain}/slack/events` (this step is not required for Socket Mode apps)
@@ -20,25 +20,25 @@ To enable Events API, go to **Features** > **Event Subscriptions** on the left p
20
20
* Choose **app_home_opened** event
21
21
* Click the **Save Changes** button at the bottom for sure
22
22
23
-
### What Your Bolt App Does
23
+
### What your Bolt app does
24
24
25
-
All your app needs to do to provide Home tabs to your app users are:
25
+
To provide Home tabs to your app users:
26
26
27
-
1. Call the [**views.publish**](https://docs.slack.dev/reference/methods/views.publish) method to update the Home tab on a per-user basis
28
-
2. Handle any user interactions in Home tab (`"block_actions"`, `"block_suggestion"`)
27
+
1. Call the [`views.publish`](https://docs.slack.dev/reference/methods/views.publish) method to update the Home tab on a per-user basis
28
+
2. Handle any user interactions in Home tab (`block_actions`, `block_suggestion`)
29
29
30
-
Most commonly, [`"app_home_opened"`](https://docs.slack.dev/reference/events/app_home_opened) events would be used as the trigger to call the [**views.publish**](https://docs.slack.dev/reference/methods/views.publish) method. Subscribing this event type is useful particularly for the initial Home tab creation. But it's also fine to publish Home tabs by any other means.
30
+
Most commonly, [`app_home_opened`](https://docs.slack.dev/reference/events/app_home_opened) events would be used as the trigger to call the [`views.publish`](https://docs.slack.dev/reference/methods/views.publish) method. Subscribing this event type is useful particularly for the initial Home tab creation. But it's also fine to publish Home tabs by any other means.
31
31
32
32
---
33
33
## Examples
34
34
35
-
:::tip
35
+
:::tip[Tip]
36
36
37
37
If you're a beginner to using Bolt for Slack App development, consult [Getting Started with Bolt](/guides/getting-started-with-bolt), first.
38
38
39
39
:::
40
40
41
-
The following code calls [**views.publish**](https://docs.slack.dev/reference/methods/views.publish) method when receiving an [`"app_home_opened"` events](https://docs.slack.dev/reference/events/app_home_opened) for the user that triggered the event. The user will see the updated Home tab immediately after the [**views.publish**](https://docs.slack.dev/reference/methods/views.publish) call has been successfully completed.
41
+
The following code calls the [`views.publish`](https://docs.slack.dev/reference/methods/views.publish) method when receiving an [`app_home_opened`](https://docs.slack.dev/reference/events/app_home_opened)event for the user that triggered the event. The user will see the updated Home tab immediately after the [`views.publish`](https://docs.slack.dev/reference/methods/views.publish) call has been successfully completed.
It looks like as below in Kotlin. (New to Kotlin? [Getting Started in Kotlin](/guides/getting-started-with-bolt#getting-started-in-kotlin) may be helpful)
81
+
It looks like this in Kotlin. (New to Kotlin? [Getting Started in Kotlin](/guides/getting-started-with-bolt#getting-started-in-kotlin) may be helpful.)
82
82
83
83
```kotlin
84
84
// static imports
@@ -130,6 +130,6 @@ val appHomeView = view { it
130
130
}
131
131
```
132
132
133
-
###Under the Hood
133
+
## Under the hood
134
134
135
135
Refer to [the Events API guide](/guides/events-api).
Copy file name to clipboardExpand all lines: docs/content/guides/audit-logs-api.md
+19-21Lines changed: 19 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,16 @@ lang: en
4
4
5
5
# Audit Logs API
6
6
7
-
[Audit Logs API](https://api.lack.com/docs/audit-logs-api) is a set of APIs for monitoring what's happening in your [Enterprise Grid](https://docs.slack.dev/enterprise-grid/) organization.
7
+
The [Audit Logs API](https://api.lack.com/docs/audit-logs-api) is used for monitoring what is happening in your [Enterprise Grid](https://docs.slack.dev/enterprise-grid/) organization.
8
8
9
9
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.
10
10
11
-
Follow the instructions in [the API document](https://docs.slack.dev/admins/audit-logs-api) to get a valid token for using Audit Logs API. Your Slack app for Audit Logs API needs to be installed on the Enterprise Grid Organization, not an individual workspace within the organization.
11
+
Follow the instructions in [the API documentation](https://docs.slack.dev/admins/audit-logs-api) to get a valid token for using the Audit Logs API. Your Slack app used for accessing the Audit Logs API needs to be installed at the org level on the Enterprise Grid organization, not an individual workspace within the organization.
12
12
13
13
---
14
-
## Call Audit Logs API in Java
14
+
## Call the Audit Logs API in Java
15
15
16
-
It's straight-forward to call Audit Logs API using the `slack-api-client` library.
16
+
Use the `slack-api-client` library to call the Audit Logs API.
This is the primary endpoint for retrieving actual audit events from your organization. It will return a list of actions that have occurred on the installed workspace or grid organization. Authentication required.
37
+
This is the primary endpoint for retrieving actual audit events from your organization. It will return a list of actions that have occurred on the installed workspace or grid organization. Authentication is required.
Refer to [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-api-client/sdkLatestVersion/slack-api-client-sdkLatestVersion-javadoc.jar/!/com/slack/api/audit/response/LogsResponse.html) to know the response data structure.
49
+
Refer to the [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-api-client/sdkLatestVersion/slack-api-client-sdkLatestVersion-javadoc.jar/!/com/slack/api/audit/response/LogsResponse.html) to know the response data structure.
50
50
51
-
### getSchemas()
51
+
### `getSchemas()`
52
52
53
-
This endpoint returns information about the kind of objects which the Audit Logs API returns as a list of all objects and a short description. Authentication not required.
53
+
This endpoint returns information about the kind of objects, which the Audit Logs API returns as a list of all objects and a short description. Authentication is not required.
Refer to [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-api-client/sdkLatestVersion/slack-api-client-sdkLatestVersion-javadoc.jar/!/com/slack/api/audit/response/SchemasResponse.html) to know the response data structure.
61
+
Refer to the [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-api-client/sdkLatestVersion/slack-api-client-sdkLatestVersion-javadoc.jar/!/com/slack/api/audit/response/SchemasResponse.html) to know the response data structure.
62
62
63
-
### getActions()
63
+
### `getActions()`
64
64
65
-
This endpoint returns information about the kind of actions that the Audit Logs API returns as [a list of all actions](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-api-client/sdkLatestVersion/slack-api-client-sdkLatestVersion-javadoc.jar/!/com/slack/api/audit/Actions.html) and a short description of each. Authentication not required.
65
+
This endpoint returns information about the kind of actions that the Audit Logs API returns as [a list of all actions](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-api-client/sdkLatestVersion/slack-api-client-sdkLatestVersion-javadoc.jar/!/com/slack/api/audit/Actions.html) and a short description of each. Authentication is not required.
Refer to [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-api-client/sdkLatestVersion/slack-api-client-sdkLatestVersion-javadoc.jar/!/com/slack/api/audit/response/ActionsResponse.html) to know the response data structure.
73
+
Refer to the [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-api-client/sdkLatestVersion/slack-api-client-sdkLatestVersion-javadoc.jar/!/com/slack/api/audit/response/ActionsResponse.html) to know the response data structure.
74
74
75
75
76
76
---
77
-
## Rate Limits
77
+
## Rate limits
78
78
79
-
The Audit Logs API methods conform to Slack's [rate limits](https://docs.slack.dev/apis/web-api/rate-limits) and all methods are rated Tier 3. This allows for up to 50 calls per minute, with an allowance for sporadic bursts. Refer to [the API document](https://docs.slack.dev/admins/audit-logs-api) for more details.
79
+
The Audit Logs API methods conform to Slack's [rate limits](https://docs.slack.dev/apis/web-api/rate-limits) and all methods are rated Tier 3. This allows for up to 50 calls per minute, with an allowance for sporadic bursts. Refer to [the API documentation](https://docs.slack.dev/admins/audit-logs-api) for more details.
80
80
81
-
`AsyncAuditClient`, the async client, has great consideration for Rate Limits.
81
+
The async client, `AsyncAuditClient`, has great consideration for rate limits. The async client internally has its queue systems to avoid burst traffics as much as possible while `AuditClient`, the synchronous client, always blindly sends requests. Both sync and async clients maintain the metrics data in a `MetricsDatastore` together. This allows the async client to accurately know the current traffic they generated toward the Slack platform and estimate the remaining amount to call.
82
82
83
-
The async client internally has its queue systems to avoid burst traffics as much as possible while `AuditClient`, the synchronous client, always blindly sends requests. The good thing is that both sync and async clients maintain the metrics data in a `MetricsDatastore` together. This allows the async client to accurately know the current traffic they generated toward the Slack Platform and estimate the remaining amount to call.
83
+
The default implementation of the datastore is an in-memory one using the JVM heap memory. The default `SlackConfig` enables the in-memory one.
84
84
85
-
The default implementation of the datastore is in-memory one using the JVM heap memory. The default `SlackConfig` enables the in-memory one. It should work nicely for most cases. If your app is fine with it, you don't need to configure anything.
86
-
87
-
`AsyncAuditClient` considers the metrics data very well. It may delay API requests to avoid rate-limited errors if the clients in the app already sent too many requests within a short period.
85
+
The `AsyncAuditClient` considers the metrics data well. It may delay API requests to avoid rate-limited errors if the clients in the app already sent too many requests within a short period.
0 commit comments