https://github.com/seratch/send-to-notion-in-slack-oss
Send to Notion in Slack (Simplified OSS Edition)
https://github.com/seratch/send-to-notion-in-slack-oss
notion slack
Last synced: 17 days ago
JSON representation
Send to Notion in Slack (Simplified OSS Edition)
- Host: GitHub
- URL: https://github.com/seratch/send-to-notion-in-slack-oss
- Owner: seratch
- License: mit
- Created: 2022-11-05T05:21:25.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-07T09:37:05.000Z (over 2 years ago)
- Last Synced: 2025-03-24T04:22:13.597Z (about 1 month ago)
- Topics: notion, slack
- Language: Python
- Homepage: https://seratch.notion.site/Send-to-Notion-in-Slack-2f7fd79ee4e64ec5b8053227f548df78
- Size: 30.3 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Send to Notion in Slack (Simplified OSS Edition)
This is a simplified open-source version of [Send to Notion in Slack](https://seratch.notion.site/Send-to-Notion-in-Slack-2f7fd79ee4e64ec5b8053227f548df78).
The benefits of this light-weight version are:
* You can run this app inside your managed infrastructure
* You can take full control of the app, from data management to code customization
* You can customize any of the metadata of the app such as its name, icon, and description
As this is a bit simpler implementation than the hosted one, there are a few limitations:
* You have to set up both Slack and Notion integrations on your own
* This app connects a pair of a single Slack Org/Workspace and a single Notion Workspace
* This app is supposed to be installed once by your Notion Workspace admin
### This app is free! but your support would be appreciated ❤️
Anyone can use and modify this app under the MIT license, but [buying me a coffee](https://www.buymeacoffee.com/seratchoss) would be greatly appreciated!
## Steps to configure this app
To enable this app, you will go through the following steps:
* Preparation on the Slack side:
* Create a new Slack app settings
* Install the app into your Slack Workspace
* Create a new app-level token for the Socket Mode connection
* Preparation on the Notion side:
* Create new integration settings
* Share your databases with the app
* Deploy this app to somewhere you manage
* Build a Docker image using the Dockerfile
* Spin up a new running app with the image
### Preparation on the Slack side
To set up your Slack app configurations, go through the following three steps.
#### Create a new Slack app settings
* Head to https://api.slack.com/apps
* Click the "Create New App" button
* Select "From an app manifest"
* Select the Slack workspace to use this app, and then click "Next"
* Paste the whole content in `./app-manifest.json` in this repo, and then click "Next"
You will see the top page of the created app configuration page!
#### Install the app into your Slack Workspace
* Head to **Settings** > **Install App** on `https://api.slack.com/apps/{your app id}`
* Click "Install to Workspace" and complete the OAuth flow
* Save the **Bot User OAuth Token** string value. You will use it as "SLACK_BOT_TOKEN" env variable later
#### Create a new app-level token for the Socket Mode connection
* Head to **Settings** > **Basic Information** on `https://api.slack.com/apps/{your app id}`
* Scroll down to **App-Level Tokens** section
* Click "Generate Token and Scopes"
* Give "socket mode" (or whatever) for Token Name
* Click "Add Scope" and select `connections:write`
* Click "Generate" to generate a new token
* Save the string value. You will use it as "SLACK_APP_TOKEN" env variable later
### Preparation on the Notion side
On the Notion side, all you need to do are to create a new integration and share your databases with the integration.
#### Create new integration settings
* Head to https://www.notion.so/my-integrations
* Click "New integration" button to start
* Give "Send to Notion in Slack" (or whatever you like) for "Name"
* "Logo" is optional, but you can use the `./icon.png` file in this repo
* Double-check that the "Associated workspace" is correct
* This app needs only "Read Content" and "Insert Content" capabilities
* This app does not need any user capabilities so that you can go with "No user information" for it
* Click "Submit" button to complete
* Save the "Internal Integration Token" string value. You will use it as "NOTION_API_TOKEN" env variable later
#### Share your databases with the app
* Head to the associated Notion Workspace
* Click the menu of a database page
* Click "Add connections" in the "Connections" section
* Add the newly created integration
* Repeat this step for all the databases that you want to send data from Slack
### Deploy this app to somewhere you manage
If you want to use the pre-built Docker image, you can pull it this way:
```bash
docker pull ghcr.io/seratch/send-to-notion-in-slack-oss:main
```
If you want to run the app locally, the following steps should work for you.
```bash
export SLACK_APP_TOKEN=xapp-...
export SLACK_BOT_TOKEN=xoxb-...
export NOTION_API_TOKEN=secret_...
docker run \
--platform linux/amd64 \
-e SLACK_APP_TOKEN=$SLACK_APP_TOKEN \
-e SLACK_BOT_TOKEN=$SLACK_BOT_TOKEN \
-e NOTION_API_TOKEN=$NOTION_API_TOKEN \
-it ghcr.io/seratch/send-to-notion-in-slack-oss:main
```
Please read https://github.com/seratch/send-to-notion-in-slack-oss/pkgs/container/send-to-notion-in-slack-oss for more details.
#### Build a Docker image using the Dockerfile
You can build a new image by running the following command:
```bash
docker build . -t your-repo/send-to-notion
```
#### Spin up a new running app with the image
If you want to run the app locally, the following steps should work for you.
```bash
export SLACK_APP_TOKEN=xapp-...
export SLACK_BOT_TOKEN=xoxb-...
export NOTION_API_TOKEN=secret_...
docker run -e SLACK_APP_TOKEN=$SLACK_APP_TOKEN -e SLACK_BOT_TOKEN=$SLACK_BOT_TOKEN -e NOTION_API_TOKEN=$NOTION_API_TOKEN -it your-repo/send-to-notion
```
You can set up your production infra to do the same for deployments.
## How to run the app
There are three ways to open the modal dialog to send data to Notion.
* Use the `/send-to-notion` slash command
* Run the global shortcut labeled "Submit data to Notion"
* Click the "Submit data to Notion" button on the app's Home tab
Please refer to [the product page](https://seratch.notion.site/Send-to-Notion-in-Slack-2f7fd79ee4e64ec5b8053227f548df78) for more details!
### This app is free! but your support would be appreciated ❤️
Anyone can use and modify this app under the MIT license, but [buying me a coffee](https://www.buymeacoffee.com/seratchoss) would be greatly appreciated!