Skip to content

Update modal handling documents #975

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
seratch merged 1 commit into from
Mar 5, 2021
Merged

Update modal handling documents #975

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 45 additions & 7 deletions docs-src/web/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ Modals use the same blocks that compose messages with the addition of an `input`
from slack_sdk.signature import SignatureVerifier
signature_verifier = SignatureVerifier(os.environ["SLACK_SIGNING_SECRET"])

from flask import Flask, request, make_response
from flask import Flask, request, make_response, jsonify
app = Flask(__name__)

@app.route("/slack/events", methods=["POST"])
Expand All @@ -397,9 +397,7 @@ Modals use the same blocks that compose messages with the addition of an `input`

if "payload" in request.form:
payload = json.loads(request.form["payload"])

if payload["type"] == "shortcut" \
and payload["callback_id"] == "open-modal-shortcut":
if payload["type"] == "shortcut" and payload["callback_id"] == "test-shortcut":
# Open a new modal by a global shortcut
try:
api_response = client.views_open(
Expand Down Expand Up @@ -436,11 +434,15 @@ Modals use the same blocks that compose messages with the addition of an `input`
code = e.response["error"]
return make_response(f"Failed to open a modal due to {code}", 200)

if payload["type"] == "view_submission" \
and payload["view"]["callback_id"] == "modal-id":
if (
payload["type"] == "view_submission"
and payload["view"]["callback_id"] == "modal-id"
):
# Handle a data submission request from the modal
submitted_data = payload["view"]["state"]["values"]
print(submitted_data) # {'b-id': {'a-id': {'type': 'plain_text_input', 'value': 'your input'}}}

# Close this modal with an empty response body
return make_response("", 200)

return make_response("", 404)
Expand All @@ -461,7 +463,43 @@ Also, to run the above example, the following `Slack app configurations <https:/

**Updating and pushing modals**

You can dynamically update a view inside of a modal by calling `views.update` and passing the view ID returned in the previous `views.open` call.
In response to `view_submission` requests, you can tell Slack to update the current modal view by having `"response_action": "update"` and an updated view. Also, there are other response_action types such as `errors` and `push`. Refer to `the API document <https://api.slack.com/surfaces/modals/using#updating_response>`_ for more details.

.. code-block:: python

if (
payload["type"] == "view_submission"
and payload["view"]["callback_id"] == "modal-id"
):
# Handle a data submission request from the modal
submitted_data = payload["view"]["state"]["values"]
print(submitted_data) # {'b-id': {'a-id': {'type': 'plain_text_input', 'value': 'your input'}}}

# Update the modal with a new view
return make_response(
jsonify(
{
"response_action": "update",
"view": {
"type": "modal",
"title": {"type": "plain_text", "text": "Accepted"},
"close": {"type": "plain_text", "text": "Close"},
"blocks": [
{
"type": "section",
"text": {
"type": "plain_text",
"text": "Thanks for submitting the data!",
},
}
],
},
}
),
200,
)

If your app modify the current modal view when receiving `block_actions` requests from Slack, you can call `views.update` API method with the given view ID.

.. code-block:: python

Expand Down
Loading