Skip to content

Commit

Permalink
[Docs][Connector-V2][Feishu]Refactor connector-v2 docs using unified …
Browse files Browse the repository at this point in the history
…format Slack
  • Loading branch information
ruanwenjun committed Aug 24, 2023
1 parent f459f50 commit ce3911c
Showing 1 changed file with 19 additions and 22 deletions.
41 changes: 19 additions & 22 deletions docs/en/connector-v2/sink/Slack.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,39 @@

> Slack sink connector
## Description

Used to send data to Slack Channel. Both support streaming and batch mode.
## Support Those Engines

> 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}`
> Spark<br/>
> Flink<br/>
> SeaTunnel Zeta<br/>
## Key features

- [ ] [exactly-once](../../concept/connector-v2-features.md)
- [ ] [cdc](../../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]
## Description

Slack webhook url
Used to send data to Slack Channel. Both support streaming and batch mode.

### oauth_token [string]
> 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}`
Slack oauth token used for the actual authentication
## Data Type Mapping

### slack_channel [string]
All data types are mapped to string.

slack channel for data write
## Options

### common options
| Name | Type | Required | Default | Description |
|----------------|--------|----------|---------|-----------------------------------------------------------------------------------------------------|
| webhooks_url | String | Yes | - | Slack webhook url |
| oauth_token | String | Yes | - | Slack oauth token used for the actual authentication |
| slack_channel | String | Yes | - | slack channel for data write |
| common-options | | no | - | Sink plugin common parameters, please refer to [Sink Common Options](common-options.md) for details |

Sink plugin common parameters, please refer to [Sink Common Options](common-options.md) for details
## Task Example

## Example
### Simple:

```hocon
sink {
Expand Down

0 comments on commit ce3911c

Please sign in to comment.