Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/k2tzumi/slack-echo-bot
https://github.com/k2tzumi/slack-echo-bot
gas hacktoberfest slack-bot
Last synced: 28 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/k2tzumi/slack-echo-bot
- Owner: k2tzumi
- Created: 2020-03-08T02:10:50.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-04-18T05:41:43.000Z (over 4 years ago)
- Last Synced: 2024-10-15T00:03:26.995Z (3 months ago)
- Topics: gas, hacktoberfest, slack-bot
- Language: TypeScript
- Homepage:
- Size: 102 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/google/clasp)
What is this?
==============================
This bot can echo messages between specified channels.
This bot runs as a web app within a Google app script.
You can make this bot work by registering it as an endpoint for [Slack API](https://api.slack.com/apps) event subscriptions.
REQUIREMENTS
--------------------
- `npm`
- [clasp](https://github.com/google/clasp)
`npm install -g @google/clasp`
- `make`
USAGE
--------------------
To use it, you need to set up Google apps scripts and Slack API.
### Install Google apps scripts
1. Enable Google Apps Script API
https://script.google.com/home/usersettings
2. make push
3. make deploy
4. Grant the necessary privileges
make open
Publish > Deploy as web app.. > Update
Grant access
### Register with the Slack API
* Create New App
https://api.slack.com/apps
Please make a note of `App Credentials` displayed after registration.
### Setting Script properties
In order to run the application and change its behavior, you need to set the following Google Apps scripts property.
|Property name|Required|Setting Value|Description|
|--|--|--|--|
|VERIFICATION_TOKEN|○|Basic Information > App Credentials > Verification Token|A token that easily authenticates the source of a hooked request|
|CLIENT_ID|○|Basic Information > App Credentials > Client ID|Use with OAuth|
|CLIENT_SECRET|○|Basic Information > App Credentials > Client Secret|Use with OAuth|
|SLACK_WORKSPACE_NAME|optional|your workspace's name. e.g.) https://`example`.slack.com ||
|ACCESS_TOKEN|optional|Set automatically by oauth authentication|Access token issued after oauth authentication.|
|CHANNEL_NAME|optional|Set automatically by oauth authentication|Channel name specified during oauth authentication.|
|BOT_USER_ID|optional|Set automatically by oauth authentication|ID of bot user registered with slack api.|
1. Open Project
`$ make open`
2. Add Scirpt properties
File > Project properties > Scirpt properties > Add row
Setting Property & Value
### OAuth Authentication
#### Settings OAuth & Permissions
* Redirect URLs
`Add New Redirect URL` > Add Redirect URL > `Save URLs`
ex) https://script.google.com/macros/s/miserarenaiyo/usercallback
You can check the Redirect URL in the following way. The `RedirectUri` of the displayed page.
`$ make application`
* Bot Token Scopes
Click `Add an OAuth Scope` to select the following permissions
* [chat:write](https://api.slack.com/scopes/chat:write)
* [channels:read](https://api.slack.com/scopes/channels:read)
* [channels:history](https://api.slack.com/scopes/channels:history)
* [users.profile:read](https://api.slack.com/scopes/users.profile:read)
* [team:read](https://api.slack.com/scopes/team:read)
* [incoming-webhook](https://api.slack.com/scopes/incoming-webhook)
* Install App to Workspace
You must specify a destination channel that bot can post to as an app.
### Install App to Workspace
1. Open web application
`$ make application`
The browser will be launched with the following URL:
ex) https://script.google.com/macros/s/miserarenaiyo/exec
2. Click `Authorize.`
You must specify a destination channel that bot can post to as an app.
3. Click `Allow`
The following message is displayed when OAuth authentication is successful
```
Success!
Setting EventSubscriptions
```
When prompted, click the `Setting EventSubscriptions` to set up an Event Subscriptions.
### Setting Event Subscriptions
Turn on.
Setting Request URL.
ex) https://script.google.com/macros/s/miserarenaiyo/exec
Add Workspace Event.
Select `message.channels`.