:plugin: github
:type: input

///////////////////////////////////////////
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}-{plugin}"]

=== Github input plugin

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

==== Description

Read events from github webhooks

[id="plugins-{type}s-{plugin}-options"]
==== Github Input 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}-drop_invalid>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-ip>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|Yes
| <<plugins-{type}s-{plugin}-secret_token>> |<<string,string>>|No
|=======================================================================

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

&nbsp;

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

  * Value type is <<boolean,boolean>>
  * Default value is `false`

If Secret is defined, we drop the events that don't match.
Otherwise, we'll just add an invalid tag

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

  * Value type is <<string,string>>
  * Default value is `"0.0.0.0"`

The ip to listen on

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

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

The port to listen on

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

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

Your GitHub Secret Token for the webhook



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