package
0.40.0-beta
Repository: https://github.com/instill-ai/pipeline-backend.git
Documentation: pkg.go.dev

# README


title: "Slack" lang: "en-US" draft: false description: "Learn about how to set up a VDP Slack component https://github.com/instill-ai/instill-core"

The Slack component is an application component that allows users to get and send message on Slack. It can carry out the following tasks:

Release Stage

Alpha

Configuration

The component definition and tasks are defined in the definition.json and tasks.json files respectively.

Setup

In order to communicate with Slack, the following connection details need to be provided. You may specify them directly in a pipeline recipe as key-value pairs within the component's setup block, or you can create a Connection from the Integration Settings page and reference the whole setup as setup: ${connection.<my-connection-id>}.

FieldField IDTypeNote
Token (required)tokenstringFill in your Slack app access token. For more information about how to access to create app tokens, please refer to the Slack API documentation.

Supported Tasks

Read Message

Get the latest message since specific date

InputIDTypeDescription
Task ID (required)taskstringTASK_READ_MESSAGE
Channel Name (required)channel-namestringA channel name display in Slack
Start to read datestart-to-read-datestringearliest date in all read messages
OutputIDTypeDescription
Conversationsconversationsarray[object]An array of conversations with thread messages
Output Objects in Read Message

Conversations

FieldField IDTypeNote
Last Datelast-datestringDate of the last message
Start Conversation Messagemessagestringmessage to start a conversation
Start Datestart-datestringwhen a conversation starts
Replied messagesthread-reply-messagesarrayreplies in a conversation
User UIDuser-idstringunique id from Slack
User Nameuser-namestringuser name in Slack

Replied Messages

FieldField IDTypeNote
Replied Timedatetimestringreplied datetime
Replied Messagemessagestringmessage to reply a conversation
User UIDuser-idstringunique id from Slack
User Nameuser-namestringuser name in Slack

Send Message

send message to a specific channel

InputIDTypeDescription
Task ID (required)taskstringTASK_WRITE_MESSAGE
Channel Name (required)channel-namestringA channel name display in Slack
Message (required)messagestringmessage to be sent to the target channel
OutputIDTypeDescription
Resultresultstringresult for sending message

# Functions

Init returns an implementation of IConnector that interacts with Slack.

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

No description provided by the author