diff --git a/README.md b/README.md index ce4b1d0..c35c361 100644 --- a/README.md +++ b/README.md @@ -59,3 +59,65 @@ This file holds application configuration in json format. All keys are required "service_account_key_path": ".secrets/.service_account.json" } ``` + +## Setting Up Integration With Slack API + +- navigate to Slack API new app page: https://api.slack.com/apps?new_app=1 +- Click `Create New App` + +![image](docs/slack_api_integration/images/create_new_slack_app.png) + +- Click `From a Manifest` + +![image](docs/slack_api_integration/images/create_app_from_a_manifest.png) + +- select target workspace for the new app and click `Next` + +![image](docs/slack_api_integration/images/pick_workspace_for_new_app.png) + +- Paste this manifest in the `Json` tab to allow user profile reading and writing (only) and click `Next` + +```json +{ + "display_information": { + "name": "user-profile-app", + "description": "User Profile Integration", + "background_color": "#004492" + }, + "oauth_config": { + "scopes": { + "user": [ + "users.profile:read", + "users.profile:write" + ] + } + }, + "settings": { + "org_deploy_enabled": false, + "socket_mode_enabled": false, + "token_rotation_enabled": false + } +} +``` + +![image](docs/slack_api_integration/images/paste_json_app_manifest.png) + + +- click `Create` + +![image](docs/slack_api_integration/images/review_summary_and_create_app.png) + +- After your app is created, navigate to `Settings -> Install App` to install it in your workspace and generate necessary `OAuth tokens` for programmatic communication. + +![image](docs/slack_api_integration/images/install_app_in_workspace.png) + +- Click `Install to ` (here my workspace is called `lab` so it shows as `Install to lab`). +- Confirm that you want to install the app and click `Allow`. + +![image](docs/slack_api_integration/images/confirm_app_installation_in_workspace.png) + +- After you click `Allow` you will be presented with the `User OAuth Token` which will be used for programmatic communication with Slack API on behalf of your user. The secret always starts with `xoxp`. + +![image](docs/slack_api_integration/images/view_oauth_token.png) + +- This can also be found in `Features -> OAuth & Permissions`. \ No newline at end of file diff --git a/docs/slack_api_integration/images/confirm_app_installation_in_workspace.png b/docs/slack_api_integration/images/confirm_app_installation_in_workspace.png new file mode 100755 index 0000000..f63b0cd Binary files /dev/null and b/docs/slack_api_integration/images/confirm_app_installation_in_workspace.png differ diff --git a/docs/slack_api_integration/images/create_app_from_a_manifest.png b/docs/slack_api_integration/images/create_app_from_a_manifest.png new file mode 100755 index 0000000..af768de Binary files /dev/null and b/docs/slack_api_integration/images/create_app_from_a_manifest.png differ diff --git a/docs/slack_api_integration/images/create_new_slack_app.png b/docs/slack_api_integration/images/create_new_slack_app.png new file mode 100755 index 0000000..75d0eb9 Binary files /dev/null and b/docs/slack_api_integration/images/create_new_slack_app.png differ diff --git a/docs/slack_api_integration/images/install_app_in_workspace.png b/docs/slack_api_integration/images/install_app_in_workspace.png new file mode 100755 index 0000000..35c8f7e Binary files /dev/null and b/docs/slack_api_integration/images/install_app_in_workspace.png differ diff --git a/docs/slack_api_integration/images/paste_json_app_manifest.png b/docs/slack_api_integration/images/paste_json_app_manifest.png new file mode 100755 index 0000000..eb3109e Binary files /dev/null and b/docs/slack_api_integration/images/paste_json_app_manifest.png differ diff --git a/docs/slack_api_integration/images/pick_workspace_for_new_app.png b/docs/slack_api_integration/images/pick_workspace_for_new_app.png new file mode 100755 index 0000000..4d00366 Binary files /dev/null and b/docs/slack_api_integration/images/pick_workspace_for_new_app.png differ diff --git a/docs/slack_api_integration/images/review_summary_and_create_app.png b/docs/slack_api_integration/images/review_summary_and_create_app.png new file mode 100755 index 0000000..7187ca1 Binary files /dev/null and b/docs/slack_api_integration/images/review_summary_and_create_app.png differ diff --git a/docs/slack_api_integration/images/view_oauth_token.png b/docs/slack_api_integration/images/view_oauth_token.png new file mode 100755 index 0000000..758ec4d Binary files /dev/null and b/docs/slack_api_integration/images/view_oauth_token.png differ