-
Notifications
You must be signed in to change notification settings - Fork 401
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.
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
Clarify that OAuth is not supported by custom receivers. #711
Conversation
Codecov Report
@@ Coverage Diff @@
## main #711 +/- ##
=======================================
Coverage 82.32% 82.32%
=======================================
Files 8 8
Lines 758 758
Branches 250 250
=======================================
Hits 624 624
Misses 78 78
Partials 56 56 Continue to review full report at Codecov.
|
This looks good. Definitely more clear. The one usecase we aren't currently covering is when folks want to use our built in express Receiver but extend it.
All OAuth related fields can be passed into an instance of our ExpressReceiver here. This is a usecase I've seen a handful of times when folks want to add custom endpoints. |
Good point @stevengill. I'll try to update this PR with the use-case of extending the |
After looking into documenting how to use OAuth with an instance of I've created issue #715 to track the work. |
c3c5750
to
018d92c
Compare
Hi, does this mean that Bolt OAuth is not supported in this deployment tutorial?
offline: POST /slack/events (λ: slack) ---- i assumed that Bolt's implementation of OAuth handled getting the "Exchanging a temporary authorization code for an access token" part but then i realized i am using a custom receiver due to the aws-serverless-express in this tutorial. |
Summary
Problem
Some developers have experienced confusion from the mention of
ExpressReceiver
in the OAuth documentation. This is understandable becauseExpressReceiver
doesn't have any formal documentation. Specifically, this sentence is the source of confusion:Solution
I've taken a stab at rewording this section by:
ExpressReceiver
from the opening paragraphExpressReceiver
Requirements (place an
x
in each[ ]
)