Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.watson-orchestrate.ibm.com/llms.txt

Use this file to discover all available pages before exploring further.

Deploy your agent to Slack workspaces using your own Slack app.

​
Prerequisites

  • A Slack workspace with admin access
  • A Slack app that is created in your workspace
  • Slack API credentials:
    • Client ID
    • Client Secret
    • Signing Secret
    • Bot User OAuth Token for each team or workspace
    • Slack Team ID (starts with the letter ‘T’)
      • Locate your team ID in the URL of the Workflow Steps tab in your Slack app settings
      Slack Team ID
  • Slack Bot Token Scopes:
    • app_mentions:read
    • chat:write
    • im:history
    • im:write
    • users.profile:read
  • Subscribed to following Bot Events:
    • message.im
    • app_mention

​
Create a Slack channel

Using YAML:
YAML
name: "Slack Support Bot"
description: "Support agent in Slack"
channel: "byo_slack"
spec_version: "v1"
kind: "channel"
client_id: "1234567890.1234567890"
client_secret: "your_client_secret_here"
signing_secret: "your_signing_secret_here"
teams:
  - id: "T01234567"
    bot_access_token: "xoxb-your-bot-token-here"
Using Python:
Python
from ibm_watsonx_orchestrate.agent_builder.channels import SlackChannel, SlackTeam

slack = SlackChannel(
    name="Slack Support Bot",
    description="Support agent in Slack",
    client_id="1234567890.1234567890",
    client_secret="your_client_secret_here",
    signing_secret="your_signing_secret_here",
    teams=[
        SlackTeam(
            id="T01234567",
            bot_access_token="xoxb-your-bot-token-here"
        )
    ]
)

​
Configuration requirements

FieldRequiredFormatDescription
client_idYesStringSlack API client ID
client_secretYesStringSlack API client secret
signing_secretYesStringSlack API signing secret
teamsYesArray of SlackTeam objectsSlack teams or workspaces
teams[].idYesStringSlack team or workspace ID
teams[].bot_access_tokenYesStringBot user OAuth token