Slack Real Time Messaging Output Adapter


The Spotfire Streaming Output Adapter Slack Real Time Messaging allows you to send messages as users, using the shared Input Adapter for Slack Real Time Messaging.

The adapter has multiple samples, described in Slack Samples. Note that these samples will demonstrate how to use three Slack adapters to receive events, send messages in real time, and perform all functions as a user.

Slack Real Time Messaging Output Adapter Properties

This section describes the properties you can set for this adapter, using the various tabs of the Properties view in StreamBase Studio.

General Tab

Name: Use this required field to specify or change the name of this instance of this component. The name must be unique within the current EventFlow module. The name can contain alphanumeric characters, underscores, and escaped special characters. Special characters can be escaped as described in Identifier Naming Rules. The first character must be alphabetic or an underscore.

Adapter: A read-only field that shows the formal name of the adapter.

Class name: Shows the fully qualified class name that implements the functionality of this adapter. If you need to reference this class name elsewhere in your application, you can right-click this field and select Copy from the context menu to place the full class name in the system clipboard.

Start options: This field provides a link to the Cluster Aware tab, where you configure the conditions under which this adapter starts.

Enable Error Output Port: Select this checkbox to add an Error Port to this component. In the EventFlow canvas, the Error Port shows as a red output port, always the last port for the component. See Using Error Ports to learn about Error Ports.

Description: Optionally, enter text to briefly describe the purpose and function of the component. In the EventFlow Editor canvas, you can see the description by pressing Ctrl while the component's tooltip is displayed.

Adapter Properties Tab

Property Description
Shared Input Slack Realtime Messaging Adapter Name This Output Adapter for Slack Real Time Messaging uses the shared RTM client of the EventFlow application's input adapter to send Slack messages.
Log Level Controls the level of verbosity the adapter uses to send notifications to the console. This setting can be higher than the containing application's log level. If set lower, the system log level is used. Available values, in increasing order of verbosity, are: OFF, ERROR, WARN, INFO, DEBUG, TRACE.

Cluster Aware Tab

Use the settings in this tab to enable this operator or adapter for runtime start and stop conditions in a multi-node cluster. During initial development of the fragment that contains this operator or adapter, and for maximum compatibility with releases before 10.5.0, leave the Cluster start policy control in its default setting, Start with module.

Cluster awareness is an advanced topic that requires an understanding of StreamBase Runtime architecture features, including clusters, quorums, availability zones, and partitions. See Cluster Awareness Tab Settings on the Using Cluster Awareness page for instructions on configuring this tab.

Concurrency Tab

Use the Concurrency tab to specify parallel regions for this instance of this component, or multiplicity options, or both. The Concurrency tab settings are described in Concurrency Options, and dispatch styles are described in Dispatch Styles.


Concurrency settings are not suitable for every application, and using these settings requires a thorough analysis of your application. For details, see Execution Order and Concurrency, which includes important guidelines for using the concurrency options.

Input Control Port

The schema is defined as:

Field Data Type Description
channelId string To which channel the message will be sent to.
text string Message content.

Status Output Port

Field Data Type Description
status string The name of the status.
time timestamp The date and time the status information was produced.
info list(name string, value string) A list of Name-value pairs of details for the status, such as database name or error message.

All status messages that may be produced and the info list they provide:

  • OK—Message sent successfully and got OK response. Info list contains:

    • Message—message sent successfully.

  • RESPONSE ERROR—Get invalid response. Info list contains:

    • Message—Error message.

    • Error Code—Error Code.

Scopes and Permissions

New Slack apps can act independently of a user token. Build a bot user powered by only the specific permissions it needs. OAuth scopes let you specify exactly how your app needs to access a Slack user's account. Slack uses scopes that refer to the object they grant access to, followed by the class of actions on that object they allow (for example, file:write). Additionally, some scopes have an optional perspective which is either user, bot, or admin, which influences how the action appears in Slack (for example, chat:write:user will send a message from the authorizing user, as opposed to your Slack app). See this related documentation for more information.

Token Types

User tokens represent workspace members. They are issued for the user who installed the app and for users who authenticate the app. When your app asks for OAuth scopes, they are applied to user tokens. You can use these tokens to take actions on behalf of users. User tokens start with xoxp- which is used in the Slack Client Adapter. Bot user tokens represent a bot associated with the app installed in a workspace. Bot user tokens begin with xoxb-, which is used in the Real Time Messaging Input and Output adapters. See this related documentation for more information.

Messaging for Slack Apps

To manage, compose, or make Slack messages interactive, see this related Slack documentation.

Suspend and Resume Behavior

When suspended, the adapter stops processing.

When resumed, the adapter once again starts processing web pages.