-
Notifications
You must be signed in to change notification settings - Fork 662
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
docs: replace redirected or missing links to sdk documentation #2125
Changes from all commits
24491da
31049f3
5e52a45
cd89dea
69f9cfc
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -170,7 +170,7 @@ app.get('/slack/oauth_redirect', (req, res) => { | |
|
||
There are many situations where you may want to persist some custom data relevant to your application across the entire OAuth flow. For example, you may want to map Slack resources (like users) to your own application's resources, or verify and gate eligibility for proceeding with installing your Slack application to a workspace based on your application's requirements. To this end, this package provides a series of hooks, or callbacks, that allow your application to integrate throughout key points of the OAuth flow. | ||
|
||
These are all callbacks customizable via the [`CallbackOptions`](reference/oauth#callbackoptions) and [`InstallPathOptions`](reference/oauth#installpathoptions) interfaces - check their [reference documentation](reference/oauth) for more details. | ||
These are all callbacks customizable via the [`CallbackOptions`](/reference/oauth/interfaces/CallbackOptions) and [`InstallPathOptions`](/reference/oauth/interfaces/InstallPathOptions) interfaces - check their [reference documentation](reference/oauth) for more details. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Absolute linking off from the |
||
|
||
For example, you may wish to store some information relevant to your application in a cookie before starting the OAuth flow and redirecting the user to the slack.com authorize URL. Once the user completes the authorization process on slack.com and is redirected back to your application, you can read this cookie and determine if the user has the appropriate permissions to proceed with installation of your application: | ||
|
||
|
@@ -248,6 +248,7 @@ app.get('/slack/oauth_redirect', (req, res) => { | |
}); | ||
``` | ||
</details> | ||
|
||
--- | ||
Comment on lines
250
to
252
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixes possible confusion in markdown parsing - this might've been interpreted as a header called ""! |
||
|
||
### Storing installations in a database | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,8 @@ | ||
--- | ||
title: Incoming Webhooks | ||
permalink: /webhook | ||
slug: /webhook | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This changes the
Which matches the path of other There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. oh good catch -- you are indeed correct! permalink is what the old jekyll site used, i missed it There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Super interesting moves by There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. oh yes to wrap up explanation -- permalink is ignored entirely. when there's nothing set, docusaurus defaults to the folder structure the md file is in |
||
--- | ||
|
||
# Slack Incoming Webhooks | ||
|
||
[![build-ci](https://github.com/slackapi/node-slack-sdk/actions/workflows/ci-build.yml/badge.svg)](https://github.com/slackapi/node-slack-sdk/actions/workflows/ci-build.yml) | ||
<!-- TODO: per-flag badge https://docs.codecov.io/docs/flags#section-flag-badges-and-graphs --> | ||
[![codecov](https://codecov.io/gh/slackapi/node-slack-sdk/branch/main/graph/badge.svg)](https://codecov.io/gh/slackapi/node-slack-sdk) | ||
<!-- TODO: npm versions with scoped packages: https://github.com/rvagg/nodei.co/issues/24 --> | ||
|
||
Comment on lines
-6
to
-12
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🪓 Might've been carried over from the GitHub |
||
The `@slack/webhook` package contains a helper for making requests to Slack's [Incoming | ||
Webhooks](https://api.slack.com/incoming-webhooks). Use it in your app to send a notification to a channel. | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,7 +3,7 @@ | |
The `@slack/rtm-api` package contains a simple, convenient, and configurable client for receiving events and sending simple messages to Slack's [Real Time Messaging API](https://api.slack.com/rtm). Use it in your | ||
app to stay connected to the Slack platform over a persistent Websocket connection. | ||
|
||
**Note**: RTM isn't available for modern scoped apps anymore. We recommend using the [Events API](https://slack.dev/node-slack-sdk/events-api) and [Web API](https://slack.dev/node-slack-sdk/web-api) instead. If you need to use RTM (possibly due to corporate firewall limitations), you can do so by creating a [legacy scoped app](https://api.slack.com/apps?new_classic_app=1). If you have an existing RTM app, do not update its scopes as it will be updated to a modern scoped app and stop working with RTM. | ||
**Note**: The RTM API isn't available for modern granular-permissions apps, and you can no longer create new legacy apps. We recommend using [Bolt for JavaScript](https://tools.slack.dev/bolt-js). If you have an existing RTM app, do not update its scopes as it will be updated to a granular-permissions app and stop working with the RTM API. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This matches the wording on |
||
|
||
## Installation | ||
|
||
|
@@ -16,7 +16,7 @@ $ npm install @slack/rtm-api | |
## Usage | ||
|
||
These examples show the most common features of the `RTMClient`. You'll find even more extensive [documentation on the | ||
package's website](https://slack.dev/node-slack-sdk/rtm-api). | ||
package's website](https://tools.slack.dev/node-slack-sdk/rtm-api). | ||
|
||
<!-- END: Remove before copying into the docs directory --> | ||
|
||
|
@@ -72,7 +72,7 @@ user ID and team ID, you can look those up any time the client is connected as t | |
|
||
Options passed to the `.start()` method are passed through as arguments to the [`rtm.connect` Web API | ||
method](https://api.slack.com/methods/rtm.connect). These arguments deal with presence, which is discussed in more | ||
detail [on the documentation website](https://slack.dev/node-slack-sdk/rtm-api#presence). | ||
detail [on the documentation website](https://tools.slack.dev/node-slack-sdk/rtm-api/#presence). | ||
|
||
</details> | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the link fixed by the change from
permalink
toslug
below! 👾