Skip to main content

SlackRecordSink

Description

Format and send Records to a configured Channel using the Slack Post Message API. The service requires a Slack App with a Bot User configured for access to a Slack workspace. The Bot User OAuth Bearer Token is required for posting messages to Slack.

Tags

record, sink, slack

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 NameAPI NameDefault ValueAllowable ValuesDescription
API URL *api-urlhttps://slack.com/apiSlack Web API URL for posting text messages to channels. It only needs to be changed if Slack changes its API URL.
Access Token *access-tokenBot OAuth Token used for authenticating and authorizing the Slack request sent by NiFi.
Channel ID *channel-idSlack channel, private group, or IM channel to send the message to. Use Channel ID instead of the name.
Input Character Set *input-character-setUTF-8Specifies the character set of the records used to generate the Slack message.
Record Writer *record-sink-record-writerController Service:
RecordSetWriterFactory

Implementations:
AvroRecordSetWriter
CSVRecordSetWriter
FreeFormTextRecordSetWriter
JsonRecordSetWriter
RecordSetWriterLookup
ScriptedRecordSetWriter
XMLRecordSetWriter
Specifies the Controller Service to use for writing out the records.
Web Service Client Provider *web-service-client-providerController Service:
WebClientServiceProvider

Implementations:
StandardWebClientServiceProvider
Controller service to provide HTTP client for communicating with Slack API

State Management

This component does not store state.

Restricted

This component is not restricted.

System Resource Considerations

This component does not specify system resource considerations.

See Also