Clarify request URL endpoints #477
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #477 +/- ##
=======================================
Coverage 84.23% 84.23%
=======================================
Files 7 7
Lines 552 552
Branches 163 163
=======================================
Hits 465 465
Misses 60 60
Partials 27 27 Continue to review full report at Codecov.
|
aoberoi
reviewed
Apr 20, 2020
README.md
Outdated
| @@ -27,6 +27,8 @@ const app = new App({ | |||
| })(); | |||
| ``` | |||
|
|
|||
| > ⚙️ By default, Bolt will listen to the `/slack/events` endpoint of your public URL for all incoming requests (whether shortcuts, events, or interactivity payloads). When configuring Request URLs in your app configuration, the should all have `/slack/events` appended by default. You can modify the default behavior by passing an array of `endpoints` of type string into the constructor. | |||
There was a problem hiding this comment.
How about...
You can modify the default behavior using the
endpointsoption in theAppconstructor. This option can be set to a string, or an array of strings, of the paths to use instead of'/slack/events'.
I think it’s important that we consistently refer to the properties of AppOptions as “options”.
seratch
approved these changes
Apr 21, 2020
|
@shaydewael I'll update the Japanese pages later (in another pull request). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Clarifies request URL endpoints in Getting Started guide and commands/shortcuts docs.
Addresses #246 and is a commonly-asked question through other forums.
Requirements (place an
xin each[ ])