:plugin: slack
:type: output
:default_codec: plain

///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////

[id="plugins-{type}s-{plugin}"]

=== Slack output plugin

include::{include_path}/plugin_header.asciidoc[]

==== Description

Write events to Slack.

[id="plugins-{type}s-{plugin}-options"]
==== Slack Output Configuration Options

This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.

[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-attachments>> |<<array,array>>|No
| <<plugins-{type}s-{plugin}-channel>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-format>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-icon_emoji>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-icon_url>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-url>> |<<string,string>>|Yes
| <<plugins-{type}s-{plugin}-username>> |<<string,string>>|No
|=======================================================================

Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
output plugins.

&nbsp;

[id="plugins-{type}s-{plugin}-attachments"]
===== `attachments` 

  * Value type is <<array,array>>
  * There is no default value for this setting.

Attachments array as described https://api.slack.com/docs/attachments

[id="plugins-{type}s-{plugin}-channel"]
===== `channel` 

  * Value type is <<string,string>>
  * There is no default value for this setting.

The channel to post to

[id="plugins-{type}s-{plugin}-format"]
===== `format` 

  * Value type is <<string,string>>
  * Default value is `"%{message}"`

The text to post in slack

[id="plugins-{type}s-{plugin}-icon_emoji"]
===== `icon_emoji` 

  * Value type is <<string,string>>
  * There is no default value for this setting.

Emoji icon to use

[id="plugins-{type}s-{plugin}-icon_url"]
===== `icon_url` 

  * Value type is <<string,string>>
  * There is no default value for this setting.

Icon URL to use

[id="plugins-{type}s-{plugin}-url"]
===== `url` 

  * This is a required setting.
  * Value type is <<string,string>>
  * There is no default value for this setting.

The incoming webhook URI needed to post a message

[id="plugins-{type}s-{plugin}-username"]
===== `username` 

  * Value type is <<string,string>>
  * There is no default value for this setting.

The username to use for posting



[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]

:default_codec!: