Skip to content

Commit

Permalink
Fix links and add config to webhook readme (influxdata#5558)
Browse files Browse the repository at this point in the history
  • Loading branch information
glinton authored and danielnelson committed Mar 8, 2019
1 parent 9378de9 commit 0392007
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 7 deletions.
33 changes: 31 additions & 2 deletions plugins/inputs/webhooks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,36 @@ $ cp config.conf.new /etc/telegraf/telegraf.conf
$ sudo service telegraf start
```

## Available webhooks

### Configuration:

```toml
[[inputs.webhooks]]
## Address and port to host Webhook listener on
service_address = ":1619"

[inputs.webhooks.filestack]
path = "/filestack"

[inputs.webhooks.github]
path = "/github"
# secret = ""

[inputs.webhooks.mandrill]
path = "/mandrill"

[inputs.webhooks.rollbar]
path = "/rollbar"

[inputs.webhooks.papertrail]
path = "/papertrail"

[inputs.webhooks.particle]
path = "/particle"
```


### Available webhooks

- [Filestack](filestack/)
- [Github](github/)
Expand All @@ -23,7 +52,7 @@ $ sudo service telegraf start
- [Particle](particle/)


## Adding new webhooks plugin
### Adding new webhooks plugin

1. Add your webhook plugin inside the `webhooks` folder
1. Your plugin must implement the `Webhook` interface
Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/webhooks/filestack/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Filestack webhook

You should configure your Filestack's Webhooks to point at the `webhooks` service. To do this go to `filestack.com/`, select your app and click `Credentials > Webhooks`. In the resulting page, set the `URL` to `http://<my_ip>:1619/filestack`, and click on `Add`.
You should configure your Filestack's Webhooks to point at the `webhooks` service. To do this go to [filestack.com](https://www.filestack.com/), select your app and click `Credentials > Webhooks`. In the resulting page, set the `URL` to `http://<my_ip>:1619/filestack`, and click on `Add`.

## Events

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/webhooks/mandrill/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# mandrill webhook

You should configure your Mandrill's Webhooks to point at the `webhooks` service. To do this go to `mandrillapp.com/` and click `Settings > Webhooks`. In the resulting page, click on `Add a Webhook`, select all events, and set the `URL` to `http://<my_ip>:1619/mandrill`, and click on `Create Webhook`.
You should configure your Mandrill's Webhooks to point at the `webhooks` service. To do this go to [mandrillapp.com](https://mandrillapp.com) and click `Settings > Webhooks`. In the resulting page, click on `Add a Webhook`, select all events, and set the `URL` to `http://<my_ip>:1619/mandrill`, and click on `Create Webhook`.

## Events

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/webhooks/particle/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# particle webhooks


You should configure your Particle.io's Webhooks to point at the `webhooks` service. To do this go to `(https://console.particle.io/)[https://console.particle.io]` and click `Integrations > New Integration > Webhook`. In the resulting page set `URL` to `http://<my_ip>:1619/particle`, and under `Advanced Settings` click on `JSON` and add:
You should configure your Particle.io's Webhooks to point at the `webhooks` service. To do this go to [https://console.particle.io](https://console.particle.io/) and click `Integrations > New Integration > Webhook`. In the resulting page set `URL` to `http://<my_ip>:1619/particle`, and under `Advanced Settings` click on `JSON` and add:

```
{
Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/webhooks/rollbar/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# rollbar webhooks

You should configure your Rollbar's Webhooks to point at the `webhooks` service. To do this go to `rollbar.com/` and click `Settings > Notifications > Webhook`. In the resulting page set `URL` to `http://<my_ip>:1619/rollbar`, and click on `Enable Webhook Integration`.
You should configure your Rollbar's Webhooks to point at the `webhooks` service. To do this go to [rollbar.com](https://rollbar.com/) and click `Settings > Notifications > Webhook`. In the resulting page set `URL` to `http://<my_ip>:1619/rollbar`, and click on `Enable Webhook Integration`.

## Events

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/webhooks/webhooks.go
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ func (wb *Webhooks) SampleConfig() string {
[inputs.webhooks.particle]
path = "/particle"
`
`
}

func (wb *Webhooks) Description() string {
Expand Down

0 comments on commit 0392007

Please sign in to comment.