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.

Tags

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

Properties

In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display Name	API Name	Default Value	Allowable Values	Description
App Token *	App Token			The Application Token that is registered to your Slack application
Bot Token *	Bot Token			The Bot Token that is registered to your Slack application
Event Type to Receive *	Event Type to Receive	Receive App Mention Events	Receive App Mention Events Receive Message Events Receive Commands Receive Joined Channel Events	Specifies the type of Event that the Processor should respond to
Resolve User Details *	Resolve User Details	false	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 property Event Type to Receive has a value of Receive Joined Channel Events or Receive App Mention Events or Receive Message Events

Dynamic Properties

This component does not support dynamic properties.

Relationships

Name	Description
success	All FlowFiles that are created will be sent to this Relationship.

Reads Attributes

This processor does not read attributes.

Writes Attributes

Name	Description
mime.type	Set 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

This component does not specify system resource considerations.

See Also

ConsumeSlack