You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@seatunnel.apache.org by GitBox <gi...@apache.org> on 2022/10/29 15:25:48 UTC

[GitHub] [incubator-seatunnel] EricJoy2048 commented on a diff in pull request #3226: [Feature][Connector-V2][Slack] Add Slack sink connector

EricJoy2048 commented on code in PR #3226:
URL: https://github.com/apache/incubator-seatunnel/pull/3226#discussion_r1008717494


##########
docs/en/connector-v2/sink/Slack.md:
##########
@@ -0,0 +1,57 @@
+# Slack
+
+> Slack sink connector
+
+## Description
+
+Used to send data to Slack Channel. Both support streaming and batch mode.
+> For example, if the data from upstream is [`age: 12, name: huan`], the content send to socket server is the following: `{"name":"huan","age":17}`
+
+
+## Key features
+
+- [ ] [exactly-once](../../concept/connector-v2-features.md)
+- [ ] [schema projection](../../concept/connector-v2-features.md)
+
+## Options
+
+| name           | type   | required | default value |
+| -------------- |--------|----------|---------------|
+| webhooks_url   | String | Yes      | -             |
+| oauth_token    | String | Yes      | -             |
+| slack_channel  | String | Yes      | -             |
+| common-options |        | no       | -             |
+
+### webhooks_url [string]
+
+Slack webhook url
+
+### oauth_token [string]
+
+Slack oauth token used for the actual authentication
+
+### slack_channel [string]
+
+slack channel for data write
+
+### common options
+
+Sink plugin common parameters, please refer to [Sink Common Options](common-options.md) for details
+
+## Example
+
+```hocon
+sink {
+ SlackSink {
+  webhooks_url = "https://hooks.slack.com/services/xxxxxxxxxxxx/xxxxxxxxxxxx/xxxxxxxxxxxxxxxx"
+  oauth_token = "xoxp-xxxxxxxxxx-xxxxxxxx-xxxxxxxxx-xxxxxxxxxxx"
+  slack_channel = "channel name"
+ }
+}
+```
+
+## Changelog
+
+### 2.3.0-beta 2022-10-20

Review Comment:
   `### 2.3.0-beta 2022-10-20` need replace with `new version`, `new version` will be update to the real version number when we release a version.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@seatunnel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org