Optionally use Slack's web API instead of per-channel webhooks #94
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
yasunariw
changed the title
yasunariw
force-pushed
the
yasu/upgrade-status-rules
branch
from
8730f89
to
b47ab24
Compare
yasunariw
force-pushed
the
yasu/slack-webhook-to-api
branch
from
94779d8
to
76762b0
Compare
yasunariw
force-pushed
the
yasu/upgrade-status-rules
branch
from
b47ab24
to
24e0c4f
Compare
yasunariw
force-pushed
the
yasu/slack-webhook-to-api
branch
from
f179fc8
to
6e6ae96
Compare
yasunariw
force-pushed
the
yasu/slack-webhook-to-api
branch
4 times, most recently
from
cf9b42f
to
d527ce4
Compare
ygrek
suggested changes
Dec 30, 2020
yasunariw
force-pushed
the
yasu/slack-webhook-to-api
branch
from
0060a7b
to
9bd0cae
Compare
yasunariw
changed the title
ygrek
approved these changes
Dec 31, 2020
Slack Webhooks and Web API should be able to share the same payload structure.
Adds a way to send notifications without per-channel webhooks. The sending mechanism will authenticate with a bearer token that is valid for any channel that the bot has been added to. The channel is specified in a new `channel` field in the notification payload. A note on error handling: for web API requests, Slack always returns a 200 response and communicates the error message in the response body, so checking for status alone isn't enough.
yasunariw
force-pushed
the
yasu/slack-webhook-to-api
branch
from
6e18496
to
7404d4a
Compare
ygrek
reviewed
Jan 4, 2021
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.
Description of the task
Send Slack notifications by querying the API with an access token instead of querying per-channel webhooks.
As per #56, it's cumbersome to generate and maintain an incoming webhook per Slack channel, especially when there are multiple channels to message.
If the user can configure an access token, they can use the single token to message any channel that the bot is added to. This is a one-time setup, so additional channels can be configured later on without providing a webhook URL for it.
Summary:
notificationinslack.atd: The API endpoint expects the channel to be provided as a field in the request body.send_notificationinapi_remote.ml: Modified to use the stored access token to authenticate and send a message to thechat.postMessageAPI endpoint, falling back on webhooks if unable to find a token.okfield in the payload, so checking for status code alone isn't enough to catch errors:(How to test
Existing tests were promoted as the slack payload now contains a
channelfield, but otherwise no regressions.Additional tests were run on a dummy Slack workspace to check oauth behavior.
References
postMessageAPI endpoint that replaces webhooks