Configuring Dialogs Bot in Slack
Important
To create a Dialogs app in Slack from Manifest, you must have the Kyvos manifest file. Contact Kyvos Support to obtain the kyvosSlackApp.zip file, which includes the manifest and the Kyvos logo file.
The bot server will be accessible at: <https://<FQDN>
Dialogs bot integrates with Slack through Slack API Portal at: https://api.slack.com/apps. The configuration process includes:
Create a new Slack App.
Verify that the Dialogs Bot is available in the Slack App.
Configure Slack properties for the Dialogs Bot from Kyvos Manager.
Configure the OAuth Redirect URL in the Identity Provider (IdP), such as Azure Active Directory.
Restart the Dialogs Bot services from Kyvos Manager.
This setup ensures secure communication between Slack, the Kyvos Bot Server, and the Kyvos platform.
Step 1: Creating a new Slack app
To create a new Slack app, perform the following steps.
In your web browser, type https://api.slack.com/apps. The Slack api page is displayed.
On this page:
- 1 Step 1: Creating a new Slack app
- 2 Step 2: Adding a logo to Dialogs App
- 3 Step 3: Post configuration: Search for the Dialogs Bot in Slack
- 4 Step 4: Configuring Slack properties for the Dialogs Bot from Kyvos Manager
- 5 Step 5: Configuring OAuth Redirect URL
- 6 Step 6: Restarting Dialogs Bot services
- 7 Troubleshooting
Related topics
In the page, click Create New App. The Create an app dialog box is displayed.
In the dialog box, choose to create an app from a manifest. The Pick a workspace to develop your app dialog is displayed.
In the dialog box, select a development workspace and click Next. The Create app from manifest dialog is displayed.
Before pasting the manifest configuration, replace the
<FQDN>placeholder with the publicly accessible fully qualified domain name of the Dialogs Bot Server to ensure Slack can successfully connect to the bot service. You can also modify the display name of the Dialogs bot application, as shown below.In the dialog box, paste your manifest configuration in the input field provided and click Next. The Review summary & create your app dialog is displayed.
Review and verify that the configuration you entered matches the summary and click Create. A new app has been created to your manifest specification. Now, you are redirected to the Settings page.
On the page, in the Basic Information section, the App credentials are displayed. These credentials allow your app to access the Slack API. They are secret. Please don't share your app credentials with anyone, include them in public code repositories, or store them in insecure ways.
Copy the Signing Secret credentials and keep it handy.
Now, navigate to the OAuth & Permissions section in the left pane.
In the OAuth Token section, click Install to Kyvos. The Allow the app to access Slack page is displayed.
Review app permissions and click Allow. You are redirected to the Settings page and the in the OAuth Tokens section, the token is generated. Copy the token and keep it handy. This token will be used as SLACK_BOT_TOKEN.
Step 2: Adding a logo to Dialogs App
You can customize the Dialogs Slack App by adding an app logo and background color from the Slack API Portal. The logo is displayed in the Slack workspace wherever the Dialogs Bot appears, helping users easily identify the application.
To add a Logo to the Slack App, perform the following steps.
Log in to the Slack API Portal.
Open the required Slack App.
On the Settings page, click Basic Information in the left navigation pane.
Scroll to the Display Information section.
Click Add App Icon and upload the required logo image.
Optionally, specify the background color for the app icon.
Click Save Changes to apply the updates.
The updated logo is displayed for the Dialogs Bot in the Slack workspace.
Step 3: Post configuration: Search for the Dialogs Bot in Slack
In Slack, click More (⋯) from the left navigation pane and select Tools.
Under Tools, click Apps.
In the Apps page, use the Search by app name or category search box to find the required Dialogs app.
Select the Dialogs app from the search results.
In the app details pane, click Open App to launch the Dialogs bot.
The Dialogs Bot opens in Slack, where you can start interacting with the bot and validate the integration setup.
Step 4: Configuring Slack properties for the Dialogs Bot from Kyvos Manager
Configure the required Slack integration properties in Kyvos Manager to enable communication between the Kyvos Dialogs Bot and Slack. These properties include the Slack bot token, signing secret, and OAuth redirect URL required for authentication and integration setup.
To configure Kyvos Dialogs Properties, perform the following steps.
Log in to Kyvos Manager.
Navigate to Kyvos Ecosystem > Kyvos Properties > Dialog Bot Properties.
Configure the following properties:
Property | Description |
|---|---|
| Enables Slack integration. Set the value to |
| Specify the Slack Bot Token copied from the Slack App configuration. |
| Specify the Slack Signing Secret copied from the Slack App configuration. |
| Specify the OAuth callback URL. |
Save the changes to apply the configuration.
Step 5: Configuring OAuth Redirect URL
Configure the OAuth Redirect URL in the Identity Provider (IdP) to enable successful authentication between Slack and the Kyvos Dialogs Bot. The redirect URL configured in the OAuth provider must match the callback URL configured in Kyvos Dialogs properties.
The following steps demonstrated how to configure OAuth redirect URL to the Azure Active Directory.
To Configure the OAuth Redirect URL, perform the following steps.
Log in to the Identity Provider portal. For example: Azure Active Directory (Azure AD).
Navigate to Azure AD > App Registrations > Kyvos App.
In the left navigation pane, click Authentication (Preview).
On the Authentication (Preview) page, click the Redirect URL Configuration tab.
Under Mobile and desktop applications, add the redirect URL. Example:
https://<SERVER_URL>/oauth/callbackSave the configuration changes.
Step 6: Restarting Dialogs Bot services
After completing the Slack and OAuth configuration, restart the Kyvos Dialogs Bot services from Kyvos Manager to apply the updated settings and enable the Slack integration.
To restart the Dialogs Bot services, perform the following steps.
Log in to Kyvos Manager.
Restart the Dialogs Bot service from the server where the bot is deployed.
Verify that the service starts successfully after the restart.
Confirm that the Slack Bot is accessible and responding in the configured Slack workspace.
Troubleshooting
Use the following troubleshooting steps to identify and resolve common issues encountered during the Dialogs Bot integration with Slack.
Event Subscription Verification Failed
Ensure that the following endpoint is publicly accessible over HTTPS:
https://<FQDN>/slack/events
OAuth Failure
Verify that the following property:
SLACK_REDIRECT_URI
matches the redirect URI configured in the OAuth provider.
Bot Not Responding
Verify the following:
The property
SLACK_ENABLEDis set to true.The Slack App is installed in the workspace.
Slack OAuth scopes are configured correctly.
The HTTPS certificate is valid.
The Slack event subscription URL is reachable.