ListenSlack

Description:

Retrieves real-time messages or Slack commands from one or more Slack conversations. The messages are written out in JSON format. Note that this Processor should be used to obtain real-time messages and commands from Slack and does not provide a mechanism for obtaining historical messages. The ConsumeSlack Processor should be used for an initial load of messages from a channel. See Usage / Additional Details for more information about how to configure this Processor and enable it to retrieve messages and commands from Slack.

Additional Details...

Tags:

slack, real-time, event, message, command, listen, receive, social media, team, text, unstructured

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values.

Display NameAPI NameDefault ValueAllowable ValuesDescription
App TokenApp TokenThe Application Token that is registered to your Slack application
Sensitive Property: true
Bot TokenBot TokenThe Bot Token that is registered to your Slack application
Sensitive Property: true
Event Type to ReceiveEvent Type to ReceiveReceive App Mention Events
  • Receive App Mention Events The Processor is to receive only slack messages that mention the bot user (App Mention Events)
  • Receive Message Events The Processor is to receive Slack Message Events
  • Receive Commands The Processor is to receive Commands from Slack that are specific to your application. The Processor will not receive Message Events.
Specifies the type of Event that the Processor should respond to
Resolve User DetailsResolve User Detailsfalse
  • true
  • false
Specifies whether the Processor should lookup details about the Slack User who sent the received message. If true, the output JSON will contain an additional field named 'userDetails'. The 'user' field will still contain the ID of the user. In order to enable this capability, the Bot Token must be granted the 'users:read' and optionally the 'users.profile:read' Bot Token Scope. If the rate limit is exceeded when retrieving this information, the received message will be rejected and must be re-delivered.

This Property is only considered if the [Event Type to Receive] Property is set to one of the following values: [Receive App Mention Events], [Receive Message Events]

Relationships:

NameDescription
successAll FlowFiles that are created will be sent to this Relationship.

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
mime.typeSet to application/json, as the output will always be in JSON format

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.

See Also:

ConsumeSlack