Files
simstudioai--sim/apps/sim/tools/slack/message.ts
T
wehub-resource-sync d25d482dc2
Publish CLI Package / publish-npm (push) Waiting to run
Publish Python SDK / publish-pypi (push) Waiting to run
Publish TypeScript SDK / publish-npm (push) Waiting to run
CI / Migrate Dev DB (push) Has been skipped
CI / Detect Version (push) Has been cancelled
CI / Migrate DB (push) Has been cancelled
CI / Build Dev ECR (./docker/app.Dockerfile, ECR_APP) (push) Has been cancelled
CI / Build Dev ECR (./docker/db.Dockerfile, ECR_MIGRATIONS) (push) Has been cancelled
CI / Build Dev ECR (./docker/pii.Dockerfile, ECR_PII) (push) Has been cancelled
CI / Build Dev ECR (./docker/realtime.Dockerfile, ECR_REALTIME) (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
CI / Build AMD64 (./docker/app.Dockerfile, ECR_APP, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build AMD64 (./docker/db.Dockerfile, ECR_MIGRATIONS, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (./docker/pii.Dockerfile, ECR_PII, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (./docker/realtime.Dockerfile, ECR_REALTIME, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/app.Dockerfile, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/db.Dockerfile, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/pii.Dockerfile, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/realtime.Dockerfile, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Test and Build (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

131 lines
3.7 KiB
TypeScript

import type { SlackMessageParams, SlackMessageResponse } from '@/tools/slack/types'
import { MESSAGE_OUTPUT_PROPERTIES } from '@/tools/slack/types'
import type { ToolConfig } from '@/tools/types'
export const slackMessageTool: ToolConfig<SlackMessageParams, SlackMessageResponse> = {
id: 'slack_message',
name: 'Slack Message',
description:
'Send messages to Slack channels or direct messages. Supports Slack mrkdwn formatting.',
version: '1.0.0',
oauth: {
required: true,
provider: 'slack',
},
params: {
authMethod: {
type: 'string',
required: false,
visibility: 'user-only',
description: 'Authentication method: oauth or bot_token',
},
destinationType: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Destination type: channel or dm',
},
botToken: {
type: 'string',
required: false,
visibility: 'user-only',
description: 'Bot token for Custom Bot',
},
accessToken: {
type: 'string',
required: false,
visibility: 'hidden',
description: 'OAuth access token or bot token for Slack API',
},
channel: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Slack channel ID (e.g., C1234567890)',
},
dmUserId: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Slack user ID for direct messages (e.g., U1234567890)',
},
text: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'Message text to send (supports Slack mrkdwn formatting)',
},
threadTs: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Thread timestamp to reply to (creates thread reply)',
},
blocks: {
type: 'json',
required: false,
visibility: 'user-or-llm',
description:
'Block Kit layout blocks as a JSON array. When provided, text becomes the fallback notification text.',
},
files: {
type: 'file[]',
required: false,
visibility: 'user-only',
description: 'Files to attach to the message',
},
},
request: {
url: '/api/tools/slack/send-message',
method: 'POST',
headers: () => ({
'Content-Type': 'application/json',
}),
body: (params: SlackMessageParams) => {
const isDM = params.destinationType === 'dm'
return {
accessToken: params.accessToken || params.botToken,
channel: isDM ? undefined : params.channel?.trim(),
userId: isDM ? params.dmUserId?.trim() : undefined,
text: params.text,
thread_ts: params.threadTs?.trim() || undefined,
blocks:
typeof params.blocks === 'string'
? JSON.parse(params.blocks)
: params.blocks || undefined,
files: params.files || null,
}
},
},
transformResponse: async (response: Response) => {
const data = await response.json()
if (!data.success) {
throw new Error(data.error || 'Failed to send Slack message')
}
return {
success: true,
output: data.output,
}
},
outputs: {
message: {
type: 'object',
description: 'Complete message object with all properties returned by Slack',
properties: MESSAGE_OUTPUT_PROPERTIES,
},
// Legacy properties for backward compatibility
ts: { type: 'string', description: 'Message timestamp' },
channel: { type: 'string', description: 'Channel ID where message was sent' },
fileCount: {
type: 'number',
description: 'Number of files uploaded (when files are attached)',
},
files: { type: 'file[]', description: 'Files attached to the message' },
},
}