Skip to content

Commit 4efda2d

Browse files
links
1 parent a228096 commit 4efda2d

21 files changed

+97
-105
lines changed

docs/english/audit-logs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Audit Logs API client
22

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.
44

55
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.
66

@@ -10,11 +10,11 @@ You'll need a valid token in order to use the Audit Logs API. In addition, the S
1010

1111
## AuditLogsClient {#auditlogsclient}
1212

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.
1414

1515
You'll likely use the `/logs` endpoint as it's the essential part of this API.
1616

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).
1818

1919
``` python
2020
import os

docs/english/installation.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ It's also good to try on the Python REPL.
4141

4242
## Access tokens {#handling-tokens}
4343

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.
4545

4646
**Always keep your access tokens safe.**
4747

@@ -69,21 +69,21 @@ import os
6969
SLACK_BOT_TOKEN = os.environ["SLACK_BOT_TOKEN"]
7070
```
7171

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.
7373

7474
## Installing on a single workspace {#single-workspace}
7575

7676
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.
7777

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.
7979

8080
## Installing on multiple workspaces {#multi-workspace}
8181

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).
8383

8484
The OAuth exchange is facilitated via HTTP and requires a webserver; in this example, we'll use [Flask](https://flask.palletsprojects.com/).
8585

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).
8787

8888
```python
8989
import os
@@ -115,7 +115,7 @@ def pre_install():
115115

116116
### The OAuth completion page {#oauth-completion}
117117

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.
119119

120120
```python
121121
@app.route("/slack/oauth_redirect", methods=["GET"])

docs/english/legacy/auth.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,21 +31,21 @@ import os
3131
SLACK_BOT_TOKEN = os.environ["SLACK_BOT_TOKEN"]
3232
```
3333

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.
3535

3636
## Installing on a single workspace {#single-workspace}
3737

3838
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.
3939

40-
Refer to the [quickstart](https://docs.slack.dev/quickstart) guide for more details.
40+
Refer to the [quickstart](/quickstart) guide for more details.
4141

4242
## Installing on multiple workspaces {#multi-workspace}
4343

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).
4545

4646
The OAuth exchange is facilitated via HTTP and requires a webserver; in this example, we'll use [Flask](https://flask.palletsprojects.com/).
4747

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).
4949

5050
``` python
5151
import os
@@ -77,7 +77,7 @@ def pre_install():
7777

7878
### The OAuth completion page {#oauth-completion}
7979

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.
8181

8282
``` python
8383
@app.route("/slack/oauth_redirect", methods=["GET"])

docs/english/legacy/basic_usage.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ The v3 SDK provides additional features such as Socket Mode, OAuth flow, SCIM AP
88

99
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.
1010

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).
1212

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](/).
1414

1515
## Sending a message {#sending-messages}
1616

@@ -53,13 +53,13 @@ response = client.chat_postEphemeral(
5353
)
5454
```
5555

56-
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.
5757

5858
## Formatting messages with Block Kit {#block-kit}
5959

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).
6161

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.
6363

6464
To send a message to a channel, use the channel's ID. For DMs, use the user's ID.
6565

@@ -135,7 +135,7 @@ When appearing in the channel, it won't contain any attachments or message butto
135135

136136
:::
137137

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.
139139

140140
## Updating a message {#updating-messages}
141141

@@ -149,7 +149,7 @@ response = client.chat_update(
149149
)
150150
```
151151

152-
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.
153153

154154
## Deleting a message {#deleting-messages}
155155

@@ -162,7 +162,7 @@ response = client.chat_delete(
162162
)
163163
```
164164

165-
See the [`chat.delete`](https://docs.slack.dev/reference/methods/chat.delete) API method for more
165+
See the [`chat.delete`](/reference/methods/chat.delete) API method for more
166166
details.
167167

168168
## Opening a modal {#opening-modals}
@@ -244,7 +244,7 @@ if __name__ == "__main__":
244244
app.run("localhost", 3000)
245245
```
246246

247-
See the [`views.open`](https://docs.slack.dev/reference/methods/views.open) API method more details and additional parameters.
247+
See the [`views.open`](/reference/methods/views.open) API method more details and additional parameters.
248248

249249
To run the above example, the following [app configurations](https://api.slack.com/apps) are required:
250250

@@ -294,9 +294,9 @@ response = client.views_update(
294294
)
295295
```
296296

297-
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.
298298

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.
300300

301301
## Emoji reactions {#emoji}
302302

@@ -322,7 +322,7 @@ response = client.reactions_remove(
322322
)
323323
```
324324

325-
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.
326326

327327
## Listing public channels {#listing-public-channels}
328328

@@ -338,7 +338,7 @@ Archived channels are included by default. You can exclude them by passing `excl
338338
response = client.conversations_list(exclude_archived=1)
339339
```
340340

341-
See the [`conversations.list`](https://docs.slack.dev/reference/methods/conversations.list) API method for more details.
341+
See the [`conversations.list`](/reference/methods/conversations.list) API method for more details.
342342

343343
## Getting a channel's info {#get-channel-info}
344344

@@ -348,7 +348,7 @@ Once you have the ID for a specific channel, you can fetch information about tha
348348
response = client.conversations_info(channel="C0XXXXXXX")
349349
```
350350

351-
See the [`conversations.info`](https://docs.slack.dev/reference/methods/conversations.info) API method for more details.
351+
See the [`conversations.info`](/reference/methods/conversations.info) API method for more details.
352352

353353
## Joining a channel {#join-channel}
354354

@@ -360,7 +360,7 @@ response = client.conversations_join(channel="C0XXXXXXY")
360360

361361
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.
362362

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.
364364

365365
------------------------------------------------------------------------
366366

@@ -372,7 +372,7 @@ Maybe you've finished up all the business you had in a channel, or maybe you joi
372372
response = client.conversations_leave(channel="C0XXXXXXX")
373373
```
374374

375-
See the [`conversations.leave`](https://docs.slack.dev/reference/methods/conversations.leave) API method for more details.
375+
See the [`conversations.leave`](/reference/methods/conversations.leave) API method for more details.
376376

377377
## Listing team members {#list-team-members}
378378

@@ -382,7 +382,7 @@ users = response["members"]
382382
user_ids = list(map(lambda u: u["id"], users))
383383
```
384384

385-
See the [`users.list`](https://docs.slack.dev/reference/methods/users.list) API method for more details.
385+
See the [`users.list`](/reference/methods/users.list) API method for more details.
386386

387387
## Uploading files {#uploading-files}
388388

@@ -394,7 +394,7 @@ response = client.files_upload_v2(
394394
)
395395
```
396396

397-
See the [`files.upload`](https://docs.slack.dev/reference/methods/files.upload) API method for more details.
397+
See the [`files.upload`](/reference/methods/files.upload) API method for more details.
398398

399399
## Calling API methods {#calling-API-methods}
400400

@@ -414,7 +414,7 @@ assert response["message"]["text"] == "Hello world!"
414414

415415
## Rate limits {#rate-limits}
416416

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](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.
418418

419419
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.
420420

@@ -454,4 +454,4 @@ while True:
454454
raise e
455455
```
456456

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

Comments
 (0)