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
Copy file name to clipboardExpand all lines: docs/english/audit-logs.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Audit Logs API client
2
2
3
-
The [Audit Logs API](https://docs.slack.dev/admins/audit-logs-api) is a set of APIs that you can use to monitor what's happening in your [Enterprise Grid](https://docs.slack.dev/enterprise-grid) organization.
3
+
The [Audit Logs API](/admins/audit-logs-api) is a set of APIs that you can use to monitor what's happening in your [Enterprise Grid](/enterprise-grid) organization.
4
4
5
5
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 apps to see how members of your organization are using Slack.
6
6
@@ -10,11 +10,11 @@ You'll need a valid token in order to use the Audit Logs API. In addition, the S
10
10
11
11
## AuditLogsClient {#auditlogsclient}
12
12
13
-
An OAuth token with [the admin scope](https://docs.slack.dev/reference/scopes/admin) is required to access this API.
13
+
An OAuth token with [the admin scope](/reference/scopes/admin) is required to access this API.
14
14
15
15
You'll likely use the `/logs` endpoint as it's the essential part of this API.
16
16
17
-
To learn about the available parameters for this endpoint, check out [using the Audit Logs API](https://docs.slack.dev/admins/audit-logs-api). You can also learn more about the data structure of `api_response.typed_body` from [the class source code](https://github.com/slackapi/python-slack-sdk/blob/main/slack_sdk/audit_logs/v1/logs.py).
17
+
To learn about the available parameters for this endpoint, check out [using the Audit Logs API](/admins/audit-logs-api). You can also learn more about the data structure of `api_response.typed_body` from [the class source code](https://github.com/slackapi/python-slack-sdk/blob/main/slack_sdk/audit_logs/v1/logs.py).
Copy file name to clipboardExpand all lines: docs/english/installation.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ It's also good to try on the Python REPL.
41
41
42
42
## Access tokens {#handling-tokens}
43
43
44
-
Making calls to the Slack API often requires a [token](https://docs.slack.dev/authentication/tokens) with associated scopes that grant access to resources. Collecting a token can be done from app settings or with an OAuth installation depending on your app's requirements.
44
+
Making calls to the Slack API often requires a [token](/authentication/tokens) with associated scopes that grant access to resources. Collecting a token can be done from app settings or with an OAuth installation depending on your app's requirements.
45
45
46
46
**Always keep your access tokens safe.**
47
47
@@ -69,21 +69,21 @@ import os
69
69
SLACK_BOT_TOKEN= os.environ["SLACK_BOT_TOKEN"]
70
70
```
71
71
72
-
Refer to our [best practices for security](https://docs.slack.dev/authentication/best-practices-for-security) page for more information.
72
+
Refer to our [best practices for security](/authentication/best-practices-for-security) page for more information.
73
73
74
74
## Installing on a single workspace {#single-workspace}
75
75
76
76
If you're building an application for a single Slack workspace, there's no need to build out the entire OAuth flow. Once you've set up your features, click the **Install App to Team** button on the **Install App** page. If you add new permission scopes or Slack app features after an app has been installed, you must reinstall the app to your workspace for the changes to take effect.
77
77
78
-
Refer to the [quickstart](https://docs.slack.dev/quickstart) guide for more details.
78
+
Refer to the [Slack quickstart](/quickstart) guide for more details.
79
79
80
80
## Installing on multiple workspaces {#multi-workspace}
81
81
82
-
If you intend for an app to be installed on multiple Slack workspaces, you will need to handle this installation via the industry-standard OAuth protocol. Read more about [installing with OAuth](https://docs.slack.dev/authentication/installing-with-oauth).
82
+
If you intend for an app to be installed on multiple Slack workspaces, you will need to handle this installation via the industry-standard OAuth protocol. Read more about [installing with OAuth](/authentication/installing-with-oauth).
83
83
84
84
The OAuth exchange is facilitated via HTTP and requires a webserver; in this example, we'll use [Flask](https://flask.palletsprojects.com/).
85
85
86
-
To configure your app for OAuth, you'll need a client ID, a client secret, and a set of one or more scopes that will be applied to the token once it is granted. The client ID and client secret are available from the [app page](https://api.slack.com/apps). The scopes are determined by the functionality of the app — every method you wish to access has a corresponding scope, and your app will need to request that scope in order to be able to access the method. Review the full list of [OAuth scopes](https://docs.slack.dev/reference/scopes).
86
+
To configure your app for OAuth, you'll need a client ID, a client secret, and a set of one or more scopes that will be applied to the token once it is granted. The client ID and client secret are available from the [app page](https://api.slack.com/apps). The scopes are determined by the functionality of the app — every method you wish to access has a corresponding scope, and your app will need to request that scope in order to be able to access the method. Review the full list of [OAuth scopes](/reference/scopes).
87
87
88
88
```python
89
89
import os
@@ -115,7 +115,7 @@ def pre_install():
115
115
116
116
### The OAuth completion page {#oauth-completion}
117
117
118
-
Once the user has agreed to the permissions you've requested, Slack will redirect the user to your auth completion page, which includes a `code` query string parameter. You'll use the `code` parameter to call the [`oauth.v2.access`](https://docs.slack.dev/reference/methods/oauth.v2.access) API method that will grant you the token.
118
+
Once the user has agreed to the permissions you've requested, Slack will redirect the user to your auth completion page, which includes a `code` query string parameter. You'll use the `code` parameter to call the [`oauth.v2.access`](/reference/methods/oauth.v2.access) API method that will grant you the token.
Copy file name to clipboardExpand all lines: docs/english/legacy/auth.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,21 +31,21 @@ import os
31
31
SLACK_BOT_TOKEN= os.environ["SLACK_BOT_TOKEN"]
32
32
```
33
33
34
-
Refer to our [best practices for security](https://docs.slack.dev/authentication/best-practices-for-security) page for more information.
34
+
Refer to our [best practices for security](/authentication/best-practices-for-security) page for more information.
35
35
36
36
## Installing on a single workspace {#single-workspace}
37
37
38
38
If you're building an application for a single Slack workspace, there's no need to build out the entire OAuth flow. Once you've set up your features, click the **Install App to Team** button on the **Install App** page. If you add new permission scopes or Slack app features after an app has been installed, you must reinstall the app to your workspace for the changes to take effect.
39
39
40
-
Refer to the [quickstart](https://docs.slack.dev/quickstart) guide for more details.
40
+
Refer to the [quickstart](/quickstart) guide for more details.
41
41
42
42
## Installing on multiple workspaces {#multi-workspace}
43
43
44
-
If you intend for an app to be installed on multiple Slack workspaces, you will need to handle this installation via the industry-standard OAuth protocol. Read more about [installing with OAuth](https://docs.slack.dev/authentication/installing-with-oauth).
44
+
If you intend for an app to be installed on multiple Slack workspaces, you will need to handle this installation via the industry-standard OAuth protocol. Read more about [installing with OAuth](/authentication/installing-with-oauth).
45
45
46
46
The OAuth exchange is facilitated via HTTP and requires a webserver; in this example, we'll use [Flask](https://flask.palletsprojects.com/).
47
47
48
-
To configure your app for OAuth, you'll need a client ID, a client secret, and a set of one or more scopes that will be applied to the token once it is granted. The client ID and client secret are available from the [app page](https://api.slack.com/apps). The scopes are determined by the functionality of the app — every method you wish to access has a corresponding scope, and your app will need to request that scope in order to be able to access the method. Review the full list of [OAuth scopes](https://docs.slack.dev/reference/scopes).
48
+
To configure your app for OAuth, you'll need a client ID, a client secret, and a set of one or more scopes that will be applied to the token once it is granted. The client ID and client secret are available from the [app page](https://api.slack.com/apps). The scopes are determined by the functionality of the app — every method you wish to access has a corresponding scope, and your app will need to request that scope in order to be able to access the method. Review the full list of [OAuth scopes](/reference/scopes).
49
49
50
50
```python
51
51
import os
@@ -77,7 +77,7 @@ def pre_install():
77
77
78
78
### The OAuth completion page {#oauth-completion}
79
79
80
-
Once the user has agreed to the permissions you've requested, Slack will redirect the user to your auth completion page, which includes a `code` query string parameter. You'll use the `code` parameter to call the [`oauth.v2.access`](https://docs.slack.dev/reference/methods/oauth.v2.access) API method that will grant you the token.
80
+
Once the user has agreed to the permissions you've requested, Slack will redirect the user to your auth completion page, which includes a `code` query string parameter. You'll use the `code` parameter to call the [`oauth.v2.access`](/reference/methods/oauth.v2.access) API method that will grant you the token.
Copy file name to clipboardExpand all lines: docs/english/legacy/basic_usage.md
+20-20Lines changed: 20 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,9 @@ The v3 SDK provides additional features such as Socket Mode, OAuth flow, SCIM AP
8
8
9
9
The Slack Web API allows you to build applications that interact with Slack in more complex ways than the integrations we provide out of the box.
10
10
11
-
Accessing Slack API methods requires an OAuth token — read more about [installing with OAuth](https://docs.slack.dev/authentication/installing-with-oauth).
11
+
Accessing Slack API methods requires an OAuth token — read more about [installing with OAuth](/authentication/installing-with-oauth).
12
12
13
-
Each of these [API methods](https://docs.slack.dev/reference/methods) is fully documented on our developer site at [docs.slack.dev](https://docs.slack.dev/).
13
+
Each of these [API methods](/reference/methods) is fully documented on our developer site at [docs.slack.dev](/).
See the [`chat.postEphemeral`](https://docs.slack.dev/reference/methods/chat.postephemeral) API method for more details.
56
+
See the [`chat.postEphemeral`](/reference/methods/chat.postephemeral) API method for more details.
57
57
58
58
## Formatting messages with Block Kit {#block-kit}
59
59
60
-
Messages posted from apps can contain more than just text; they can also include full user interfaces composed of blocks using [Block Kit](https://docs.slack.dev/block-kit).
60
+
Messages posted from apps can contain more than just text; they can also include full user interfaces composed of blocks using [Block Kit](/block-kit).
61
61
62
-
The [`chat.postMessage method`](https://docs.slack.dev/reference/methods/chat.postmessage) takes an optional blocks argument that allows you to customize the layout of a message. Blocks are specified in a single object literal, so just add additional keys for any optional argument.
62
+
The [`chat.postMessage method`](/reference/methods/chat.postmessage) takes an optional blocks argument that allows you to customize the layout of a message. Blocks are specified in a single object literal, so just add additional keys for any optional argument.
63
63
64
64
To send a message to a channel, use the channel's ID. For DMs, use the user's ID.
65
65
@@ -135,7 +135,7 @@ When appearing in the channel, it won't contain any attachments or message butto
135
135
136
136
:::
137
137
138
-
Refer to the [threading messages](https://docs.slack.dev/messaging#threading) page for more information.
138
+
Refer to the [threading messages](/messaging#threading) page for more information.
See the [`chat.update`](https://docs.slack.dev/reference/methods/chat.update) API method for formatting options and some special considerations when calling this with a bot user.
152
+
See the [`chat.update`](/reference/methods/chat.update) API method for formatting options and some special considerations when calling this with a bot user.
See the [`views.update`](https://docs.slack.dev/reference/methods/views.update) API method for more details.
297
+
See the [`views.update`](/reference/methods/views.update) API method for more details.
298
298
299
-
If you want to push a new view onto the modal instead of updating an existing view, see the [`views.push`](https://docs.slack.dev/reference/methods/views.push) API method.
299
+
If you want to push a new view onto the modal instead of updating an existing view, see the [`views.push`](/reference/methods/views.push) API method.
See the [`reactions.add`](https://docs.slack.dev/reference/methods/reactions.add) and [`reactions.remove`](https://docs.slack.dev/reference/methods/reactions.remove) API methods for more details.
325
+
See the [`reactions.add`](/reference/methods/reactions.add) and [`reactions.remove`](/reference/methods/reactions.remove) API methods for more details.
326
326
327
327
## Listing public channels {#listing-public-channels}
328
328
@@ -338,7 +338,7 @@ Archived channels are included by default. You can exclude them by passing `excl
If you are already in the channel, the response is slightly different. The `already_in_channel` attribute will be true, and a limited `channel` object will be returned. Bot users cannot join a channel on their own, they need to be invited by another user.
362
362
363
-
See the [`conversations.join`](https://docs.slack.dev/reference/methods/conversations.join) API method for more details.
363
+
See the [`conversations.join`](/reference/methods/conversations.join) API method for more details.
When posting messages to a channel, Slack allows apps to send no more than one message per channel per second. We allow bursts over that limit for short periods; however, if your app continues to exceed the limit over a longer period of time, it will be rate limited. Different API methods have other limits — be sure to check the [rate limits](https://docs.slack.dev/apis/web-api/rate-limits) and test that your app has a graceful fallback if it should hit those limits.
417
+
When posting messages to a channel, Slack allows apps to send no more than one message per channel per second. We allow bursts over that limit for short periods; however, if your app continues to exceed the limit over a longer period of time, it will be rate limited. Different API methods have other limits — be sure to check the [rate limits](/apis/web-api/rate-limits) and test that your app has a graceful fallback if it should hit those limits.
418
418
419
419
If you go over these limits, Slack will begin returning *HTTP 429 Too Many Requests* errors, a JSON object containing the number of calls you have been making, and a *Retry-After* header containing the number of seconds until you can retry.
420
420
@@ -454,4 +454,4 @@ while True:
454
454
raise e
455
455
```
456
456
457
-
Refer to the [rate limits](https://docs.slack.dev/apis/web-api/rate-limits) page for more information.
457
+
Refer to the [rate limits](/apis/web-api/rate-limits) page for more information.
0 commit comments