Skip to content

Commit

Permalink
Clarify /slack/events path requirement. (slackapi#1153)
Browse files Browse the repository at this point in the history
* Clarify `/slack/events` path requirement.
* We may change the log message in the future; generalize the statement

Co-authored-by: Kazuhiro Sera <seratch@gmail.com>
  • Loading branch information
2 people authored and srajiang committed Oct 14, 2021
1 parent e9e9353 commit c82ddda
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,12 @@ const app = new App({
})();
```

> ⚙️ By default, Bolt listens to the `/slack/events` endpoint for *all* incoming requests (whether shortcuts, events, or actions payloads). When configuring Request URLs in your app configuration, they should all have `/slack/events` appended. The default behavior be modified using the constructor's `endpoints` parameter.
## Listening for events

The Slack **Request URL** for a Bolt app must have the path set to `/slack/events`.
For example: `https://my-slack-app.example.com/slack/events`.
Otherwise, all incoming requests from Slack won't be handled.

Apps typically react to a collection of incoming events, which can correspond [Events API events](https://api.slack.com/events-api), [actions](https://api.slack.com/interactivity/components), [shortcuts](https://api.slack.com/interactivity/shortcuts), [slash commands](https://api.slack.com/interactivity/slash-commands) or [options requests](https://api.slack.com/reference/block-kit/block-elements#external_select). For each type of
request, there's a method to build a listener function.

Expand Down

0 comments on commit c82ddda

Please sign in to comment.