1Create a Slack App

Navigate to https://api.slack.com/apps and create a new app. You will install this app to your Slack workspace to interact with Dataiku Agents and LLMs. You will be able to configure the app yourself or use our pre-configured defaults using a manifest.

2Configuration Strategy

Use this manifest to create a pre-configured app. You can change the display names and descriptions to match your use case in the JSON but this can also be configured after the app creation.

View JSON manifest

{
    "display_information": {
        "name": "Dataiku Agent App",
        "description": "App to interact with a Dataiku Agent through a bot.",
        "background_color": "#1c2a38",
        "long_description": "I'm a bot to interact with a Dataiku Agent. You can talk to me in direct messages or mention me in a channel I'm part of. I will reply in the same thread or start one and consider the thread as part of our conversation."
    },
    "features": {
        "app_home": {
            "home_tab_enabled": true,
            "messages_tab_enabled": true,
            "messages_tab_read_only_enabled": false
        },
        "bot_user": {
            "display_name": "Dataiku Agent",
            "always_online": true
        }
    },
    "oauth_config": {
        "scopes": {
            "bot": [
                "app_mentions:read",
                "channels:history",
                "chat:write",
                "files:read",
                "files:write",
                "im:history",
                "incoming-webhook",
                "mpim:history",
                "reactions:write",
                "users:read"
            ]
        }
    },
    "settings": {
        "event_subscriptions": {
            "bot_events": [
                "app_home_opened",
                "app_mention",
                "message.im"
            ]
        },
        "interactivity": {
            "is_enabled": true
        },
        "org_deploy_enabled": false,
        "socket_mode_enabled": true,
        "token_rotation_enabled": false
    }
}

If configuring your app manually these are the minimum settings for the connection to function correctly.

Enable Socket Mode:

In the left sidebar, select "Socket Mode"
Toggle "Enable Socket Mode" to ON if not enabled

Configure Event Subscriptions:

In the left sidebar, select "Event Subscriptions"
Under "Subscribe to bot events", select "Add Bot User Event" and add the following events:

Event Name	Description	Required Scope
app_home_opened	User opened the App Home on Slack	none
app_mention	Subscribe to only the message events that mention your app or bot	app_mentions:read
message.im	A message was posted in a direct message channel	im:history

These event subscriptions are required for your Slack bot to function properly.

3Generate an App Level Token

You will need to generate an app-level token to enable socket mode.

Go to api.slack.com/apps, find your Slack app for this integration if you're not already on the page
In the left sidebar select "Basic Information"
Navigate to App-Level Tokens and select "Generate Token and Scopes"
Enter a name for the token and add the connections:write scope
Copy the App-Level Token (starts with xapp-) to configure in the Dataiku Slack Webapp later

With Socket Mode enabled, you do NOT need to configure the Events API URL or expose your Dataiku instance.

Important

Each app-level token can only be used by one Dataiku WebApp. Sharing a token across multiple instances causes missing messages, as Slack randomly distributes events among connections.

4Install the Slack App to your Slack Workspace

After configuring the bot and permissions, select "Install App"
Select "Install to Your Workspace Name" to add your app to your Slack workspace
Authorize the requested permissions when prompted
Copy the Bot-User OAuth Token (starts with xoxb-) to configure in the Dataiku Slack Webapp later

Note

This installation is for internal workspace use only

5Create and Configure the Visual Webapp in Dataiku

In the webapp edit tab, configure the following:

Slack Authentication Settings:
- Bot User OAuth Token (From the Slack App Install App or OAuth & Permissions Menu)
- App-Level Token (From the Slack App Socket Mode Menu)
LLM: Select the Dataiku LLM to use for generating responses
Select "Save" to apply your configurations

Start the Backend:

When you save the webapp, the backend should automatically start
You'll see a notification indicating the backend is starting
If the backend doesn't start automatically:
- Go to the "Actions" panel on the right side of the screen
- Select "Start backend" to manually start it

6Test the Integration

In Slack:

Send a Direct Message to your bot
@mention your bot in a channel it has joined

The bot should respond with a message from your configured Agent/LLM

7Adding Bots to Channels

After installation, your bot will not automatically have access to all channels
You must explicitly invite your bot to channels using /invite @your_bot_name
For private channels, remember that your app needs groups:history and groups:read permissions in the bot scopes
Without being added to a channel, your bot won't see messages or be able to respond in that channel

Important

If you don't want your bot to be able to read data from private channels do not give it the groups:history and groups:read permissions.