|
1 | 1 | --- |
2 | | -title: Creating workflow steps |
| 2 | +title: Creating steps from apps |
3 | 3 | lang: en |
4 | 4 | slug: /concepts/creating-steps |
5 | 5 | --- |
6 | 6 |
|
7 | 7 | :::danger |
8 | 8 |
|
9 | | -Workflow Steps from Apps are a deprecated feature. |
| 9 | +Steps from apps are a deprecated feature. |
10 | 10 |
|
11 | | -Workflow Steps from Apps are different than, and not interchangable with, Slack automation workflows. We encourage those who are currently publishing Workflow Steps from Apps to consider the new [Slack automation features](https://api.slack.com/automation), such as custom functions for Bolt. |
| 11 | +Steps from apps are different than, and not interchangeable with, Slack automation workflows. We encourage those who are currently publishing steps from apps to consider the new [Slack automation features](https://api.slack.com/automation), such as custom steps for Bolt. |
12 | 12 |
|
13 | 13 | Please [read the Slack API changelog entry](https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back) for more information. |
14 | 14 |
|
15 | 15 | ::: |
16 | 16 |
|
17 | | -To create a workflow step, Bolt provides the `WorkflowStep` class. |
| 17 | +To create a step from app, Bolt provides the `WorkflowStep` class. |
18 | 18 |
|
19 | 19 | When instantiating a new `WorkflowStep`, pass in the step's `callback_id` and a configuration object. |
20 | 20 |
|
21 | | -The configuration object contains three keys: `edit`, `save`, and `execute`. Each of these keys must be a single callback or a list of callbacks. All callbacks have access to a `step` object that contains information about the workflow step event. |
| 21 | +The configuration object contains three keys: `edit`, `save`, and `execute`. Each of these keys must be a single callback or a list of callbacks. All callbacks have access to a `step` object that contains information about the step from app event. |
22 | 22 |
|
23 | | -After instantiating a `WorkflowStep`, you can pass it into `app.step()`. Behind the scenes, your app will listen and respond to the workflow step’s events using the callbacks provided in the configuration object. |
| 23 | +After instantiating a `WorkflowStep`, you can pass it into `app.step()`. Behind the scenes, your app will listen and respond to the step’s events using the callbacks provided in the configuration object. |
24 | 24 |
|
25 | | -Alternatively, workflow steps can also be created using the `WorkflowStepBuilder` class alongside a decorator pattern. For more information, including an example of this approach, [refer to the documentation](https://slack.dev/bolt-python/api-docs/slack_bolt/workflows/step/step.html#slack_bolt.workflows.step.step.WorkflowStepBuilder). |
| 25 | +Alternatively, steps from apps can also be created using the `WorkflowStepBuilder` class alongside a decorator pattern. For more information, including an example of this approach, [refer to the documentation](https://slack.dev/bolt-python/api-docs/slack_bolt/workflows/step/step.html#slack_bolt.workflows.step.step.WorkflowStepBuilder). |
26 | 26 |
|
27 | 27 | Refer to the module documents (<a href="https://slack.dev/bolt-python/api-docs/slack_bolt/kwargs_injection/args.html">common</a> / <a href="https://slack.dev/bolt-python/api-docs/slack_bolt/workflows/step/utilities/index.html">step-specific</a>) to learn the available arguments. |
28 | 28 |
|
@@ -56,4 +56,4 @@ ws = WorkflowStep( |
56 | 56 |
|
57 | 57 | # Pass Step to set up listeners |
58 | 58 | app.step(ws) |
59 | | -``` |
| 59 | +``` |
0 commit comments