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: README.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
@@ -60,7 +60,7 @@ ngrok http 3000
60
60
61
61
## Running a Socket Mode app
62
62
63
-
If you use [Socket Mode](https://api.slack.com/socket-mode) for running your app, `SocketModeHandler` is available for it.
63
+
If you use [Socket Mode](https://docs.slack.dev/apis/events-api/using-socket-mode/) for running your app, `SocketModeHandler` is available for it.
64
64
65
65
```python
66
66
import os
@@ -91,7 +91,7 @@ python app.py
91
91
92
92
## Listening for events
93
93
94
-
Apps typically react to a collection of incoming events, which can correspond to [Events API events](https://api.slack.com/events-api), [actions](https://api.slack.com/interactivity/components), [shortcuts](https://api.slack.com/interactivity/shortcuts), [slash commands](https://api.slack.com/interactivity/slash-commands) or [options requests](https://api.slack.com/reference/block-kit/block-elements#external_select). For each type of
94
+
Apps typically react to a collection of incoming events, which can correspond to [Events API events](https://docs.slack.dev/apis/events-api/), [actions](https://docs.slack.dev/block-kit/#making-things-interactive), [shortcuts](https://docs.slack.dev/interactivity/implementing-shortcuts/), [slash commands](https://docs.slack.dev/interactivity/implementing-slash-commands/) or [options requests](https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element#external_select). For each type of
95
95
request, there's a method to build a listener function.
96
96
97
97
```python
@@ -138,12 +138,12 @@ Most of the app's functionality will be inside listener functions (the `fn` para
138
138
| Argument | Description |
139
139
| :---: | :--- |
140
140
| `body` | Dictionary that contains the entire body of the request (superset of `payload`). Some accessory data is only available outside of the payload (such as `trigger_id` and `authorizations`).
141
-
|`payload`| Contents of the incoming event. The payload structure depends on the listener. For example, for an Events API event, `payload` will be the [event type structure](https://api.slack.com/events-api#event_type_structure). For a block action, it will be the action from within the `actions` list. The `payload` dictionary is also accessible via the alias corresponding to the listener (`message`, `event`, `action`, `shortcut`, `view`, `command`, or `options`). For example, if you were building a `message()` listener, you could use the `payload` and `message` arguments interchangably. **An easy way to understand what's in a payload is to log it**. |
141
+
|`payload`| Contents of the incoming event. The payload structure depends on the listener. For example, for an Events API event, `payload` will be the [event type structure](https://docs.slack.dev/apis/events-api/#event-type-structure). For a block action, it will be the action from within the `actions` list. The `payload` dictionary is also accessible via the alias corresponding to the listener (`message`, `event`, `action`, `shortcut`, `view`, `command`, or `options`). For example, if you were building a `message()` listener, you could use the `payload` and `message` arguments interchangably. **An easy way to understand what's in a payload is to log it**. |
142
142
| `context` | Event context. This dictionary contains data about the event and app, such as the `botId`. Middleware can add additional context before the event is passed to listeners.
143
-
| `ack` | Function that **must** be called to acknowledge that your app received the incoming event. `ack` exists for all actions, shortcuts, view submissions, slash command and options requests. `ack` returns a promise that resolves when complete. Read more in [Acknowledging events](https://tools.slack.dev/bolt-python/concepts/acknowledge).
143
+
| `ack` | Function that **must** be called to acknowledge that your app received the incoming event. `ack` exists for all actions, shortcuts, view submissions, slash command and options requests. `ack` returns a promise that resolves when complete. Read more in [Acknowledging events](https://docs.slack.dev/tools/bolt-python/concepts/acknowledge/).
144
144
| `respond` | Utility function that responds to incoming events **if** it contains a `response_url` (shortcuts, actions, and slash commands).
145
145
| `say` | Utility function to send a message to the channel associated with the incoming event. This argument is only available when the listener is triggered for events that contain a `channel_id` (the most common being `message` events). `say` accepts simple strings (for plain-text messages) and dictionaries (for messages containing blocks).
146
-
| `client` | Web API client that uses the token associated with the event. For single-workspace installations, the token is provided to the constructor. For multi-workspace installations, the token is returned by using [the OAuth library](https://tools.slack.dev/bolt-python/concepts/authenticating-oauth), or manually using the `authorize` function.
146
+
| `client` | Web API client that uses the token associated with the event. For single-workspace installations, the token is provided to the constructor. For multi-workspace installations, the token is returned by using [the OAuth library](https://docs.slack.dev/tools/bolt-python/concepts/authenticating-oauth/), or manually using the `authorize` function.
147
147
| `logger` | The built-in [`logging.Logger`](https://docs.python.org/3/library/logging.html) instance you can use in middleware/listeners.
148
148
| `complete` | Utility function used to signal the successful completion of a custom step execution. This tells Slack to proceed with the next steps in the workflow. This argument is only available with the `.function` and `.action` listener when handling custom workflow step executions.
149
149
| `fail` | Utility function used to signal that a custom step failed to complete. This tells Slack to stop the workflow execution. This argument is only available with the `.function` and `.action` listener when handling custom workflow step executions.
@@ -192,7 +192,7 @@ Apps can be run the same way as the syncronous example above. If you'd prefer an
192
192
193
193
## Getting Help
194
194
195
-
[The documentation](https://tools.slack.dev/bolt-python) has more information on basic and advanced concepts for Bolt for Python. Also, all the Python module documents of this library are available [here](https://tools.slack.dev/bolt-python/reference/).
195
+
[The documentation](https://docs.slack.dev/tools/bolt-python/) has more information on basic and advanced concepts for Bolt for Python. Also, all the Python module documents of this library are available [here](https://docs.slack.dev/tools/bolt-python/reference/).
196
196
197
197
If you otherwise get stuck, we're here to help. The following are the best ways to get assistance working through your issue:
Copy file name to clipboardExpand all lines: examples/aws_lambda/README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,16 +32,16 @@ Instructions on how to set up and deploy each example are provided below.
32
32
`lazy_aws_lambda_config.yaml`
33
33
- Optionally enter a description for the role, such as "Bolt Python basic
34
34
role"
35
-
3. Ensure you have created an app on api.slack.com/apps as per the[Getting
36
-
Started Guide](https://slack.dev/bolt-python/tutorial/getting-started).
35
+
3. Ensure you have created an app on api.slack.com/apps as per the
36
+
[Building an App](https://docs.slack.dev/tools/bolt-python/building-an-app) guide.
37
37
Ensure you have installed it to a workspace.
38
38
4. Ensure you have exported your Slack Bot Token and Slack Signing Secret for your
39
39
apps as the environment variables `SLACK_BOT_TOKEN` and
40
-
`SLACK_SIGNING_SECRET`, respectively, as per the[Getting
41
-
Started Guide](https://slack.dev/bolt-python/tutorial/getting-started).
40
+
`SLACK_SIGNING_SECRET`, respectively, as per the
41
+
[Building an App](https://docs.slack.dev/tools/bolt-python/building-an-app) guide.
42
42
5. You may want to create a dedicated virtual environment for this example app, as
43
-
per the "Setting up your project" section of the[Getting
44
-
Started Guide](https://slack.dev/bolt-python/tutorial/getting-started).
43
+
per the "Setting up your project" section of the
44
+
[Building an App](https://docs.slack.dev/tools/bolt-python/building-an-app) guide.
45
45
6. Let's deploy the Lambda! Run `./deploy_lazy.sh`. By default it deploys to the
46
46
us-east-1 region in AWS - you can change this at the top of `lazy_aws_lambda_config.yaml` if you wish.
47
47
7. Load up AWS Lambda inside the AWS Console - make sure you are in the correct
@@ -150,7 +150,7 @@ Let’s create a user role that will use the custom policy we created as well as
150
150
3. "Create Role"
151
151
152
152
### Create Slack App and Load your Lambda to AWS
153
-
Ensure you have created an app on [api.slack.com/apps](https://api.slack.com/apps) as per the [Getting Started Guide](https://slack.dev/bolt-python/tutorial/getting-started). You do not need to ensure you have installed it to a workspace, as the OAuth flow will provide your app the ability to be installed by anyone.
153
+
Ensure you have created an app on [api.slack.com/apps](https://api.slack.com/apps) as per the [Building an App](https://docs.slack.dev/tools/bolt-python/building-an-app) guide. You do not need to ensure you have installed it to a workspace, as the OAuth flow will provide your app the ability to be installed by anyone.
154
154
155
155
1. Remember those S3 buckets we made? You will need the names of these buckets again in the next step.
156
156
2. You need many environment variables exported! Specifically the following from api.slack.com/apps
Copy file name to clipboardExpand all lines: examples/django/README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ This example demonstrates how you can use Bolt for Python in your Django applica
4
4
5
5
### `simple_app` - Single-workspace App Example
6
6
7
-
If you want to run a simple app like the one you've tried in the [Getting Started Guide](https://slack.dev/bolt-python/tutorial/getting-started), this is the right one for you. By default, this Django project runs this application. If you want to switch to OAuth flow supported one, modify `myslackapp/urls.py`.
7
+
If you want to run a simple app like the one you've tried in the [Building an App](https://docs.slack.dev/tools/bolt-python/building-an-app) guide, this is the right one for you. By default, this Django project runs this application. If you want to switch to OAuth flow supported one, modify `myslackapp/urls.py`.
8
8
9
9
To run this app, all you need to do are:
10
10
@@ -31,7 +31,7 @@ python manage.py migrate
31
31
python manage.py runserver 0.0.0.0:3000
32
32
```
33
33
34
-
As you did at [Getting Started Guide](https://slack.dev/bolt-python/tutorial/getting-started), configure ngrok or something similar to serve a public endpoint. Lastly,
34
+
As you did at [Building an App](https://docs.slack.dev/tools/bolt-python/building-an-app) guide, configure ngrok or something similar to serve a public endpoint. Lastly,
35
35
36
36
* Go back to the Slack app configuration page
37
37
* Go to "Event Subscriptions"
@@ -54,7 +54,7 @@ To run this app, all you need to do are:
54
54
* Create a new Slack app configuration at https://api.slack.com/apps?new_app=1
55
55
* Go to "OAuth & Permissions"
56
56
* Add `app_mentions:read`, `chat:write` in Scopes > Bot Token Scopes
57
-
* Follow the instructions [here](https://slack.dev/bolt-python/concepts#authenticating-oauth) for configuring OAuth flow supported Slack apps
57
+
* Follow the instructions [here](https://docs.slack.dev/tools/bolt-python/concepts/authenticating-oauth) for configuring OAuth flow supported Slack apps
58
58
59
59
You can start your Django application this way:
60
60
@@ -73,7 +73,7 @@ python manage.py migrate
73
73
python manage.py runserver 0.0.0.0:3000
74
74
```
75
75
76
-
As you did at [Getting Started Guide](https://slack.dev/bolt-python/tutorial/getting-started), configure ngrok or something similar to serve a public endpoint. Lastly,
76
+
As you did at [Building an App](https://docs.slack.dev/tools/bolt-python/building-an-app) guide, configure ngrok or something similar to serve a public endpoint. Lastly,
0 commit comments