Skip to content

Slack Client API

The Slack plugin exposes Slack operations through SlackClient. This page documents the current public client surface and the parameters each method accepts.

Requirements

To use the Slack client in Titan code:

  • enable the slack plugin
  • complete project-scoped Slack OAuth configuration so a personal token is available in keyring for the active repository

Accessing the client

slack_plugin = config.registry.get_plugin("slack")
client = slack_plugin.get_client()

Connection validation

auth_test()

Validate the configured personal Slack token and return identity metadata.

Call:

client.auth_test()

Parameters:

  • No parameters.

Discovery operations

list_users(limit=100, cursor=None)

List Slack users visible to the current token.

Parameters:

  • limit: Optional maximum number of users to return.
  • cursor: Optional pagination cursor.

list_public_channels(limit=100, cursor=None, exclude_archived=True)

List public Slack channels visible to the current token.

Parameters:

  • limit: Optional maximum number of channels to return.
  • cursor: Optional pagination cursor.
  • exclude_archived: Optional flag to skip archived channels.

read_channel(channel_id, limit=20, cursor=None, oldest=None, latest=None, inclusive=False)

Read message history from a Slack public channel.

Parameters:

  • channel_id: Required Slack channel ID.
  • limit: Optional maximum number of messages to return.
  • cursor: Optional pagination cursor.
  • oldest: Optional oldest timestamp bound.
  • latest: Optional latest timestamp bound.
  • inclusive: Optional boundary inclusion flag.

read_conversation(conversation_id, limit=20, cursor=None, oldest=None, latest=None, inclusive=False)

Read message history from any Slack conversation ID.

Parameters:

  • conversation_id: Required conversation ID.
  • limit: Optional maximum number of messages to return.
  • cursor: Optional pagination cursor.
  • oldest: Optional oldest timestamp bound.
  • latest: Optional latest timestamp bound.
  • inclusive: Optional boundary inclusion flag.

open_direct_message(user_id)

Open or reuse a direct message conversation with a Slack user.

Parameters:

  • user_id: Required Slack user ID.

post_message(channel_id, text, thread_ts=None)

Post a plain-text message to a Slack conversation.

Parameters:

  • channel_id: Required conversation ID.
  • text: Required message text.
  • thread_ts: Optional thread timestamp for replies.

upload_file(channel_id, file_path, title=None, initial_comment=None, thread_ts=None)

Upload a local file to a Slack conversation, optionally with a message posted above it. Uses files.uploadV2 and requires the files:write scope; connections created before that scope was added must be reconnected.

Parameters:

  • channel_id: Required conversation ID.
  • file_path: Required local path of the file to upload.
  • title: Optional title shown on the Slack file. Defaults to the file name.
  • initial_comment: Optional Slack-ready text posted as the message above the file.
  • thread_ts: Optional thread timestamp to share the file into.

Returns ClientResult[UISlackUploadedFile] with file_id, channel, title, name, and permalink.

Usage constraints

  • The current client surface backs discovery, messaging, and summary workflows.
  • read_channel() exists in the client API but is not yet exposed as a public workflow step.
  • The current Slack integration assumes one active Slack workspace binding per repository.
  • granted_scopes is recorded during OAuth connection setup; auth_test() validates the token but does not refresh that stored scope snapshot.