Merge pull request #27 from Tomasz-Kluczkowski/issue-6/docs-slack-int…

…egration docs(Issue-6): Docs for slack api integration
Tomasz-Kluczkowski · Dec 29, 2024 · aead1e3 · aead1e3
2 parents 7ca08b9 + 7f829cb
commit aead1e3
Show file tree

Hide file tree

Showing 9 changed files with 62 additions and 0 deletions.
diff --git 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 <your workspace name>` (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`. 
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
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
diff --git a/docs/slack_api_integration/images/create_new_slack_app.png b/docs/slack_api_integration/images/create_new_slack_app.png
diff --git a/docs/slack_api_integration/images/install_app_in_workspace.png b/docs/slack_api_integration/images/install_app_in_workspace.png
diff --git a/docs/slack_api_integration/images/paste_json_app_manifest.png b/docs/slack_api_integration/images/paste_json_app_manifest.png
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
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
diff --git a/docs/slack_api_integration/images/view_oauth_token.png b/docs/slack_api_integration/images/view_oauth_token.png