diff --git a/tools/lint b/tools/lint index 7cf6802751..875f9a8f39 100755 --- a/tools/lint +++ b/tools/lint @@ -598,6 +598,7 @@ def build_custom_checkers(by_lang): "zerver/webhooks/helloworld/doc.md", "zerver/webhooks/solano/doc.md", "zerver/webhooks/trello/doc.md", + "zerver/webhooks/papertrail/doc.md", } for fn in by_lang['md']: max_length = None diff --git a/zerver/webhooks/papertrail/doc.html b/zerver/webhooks/papertrail/doc.html deleted file mode 100644 index 350ceb626d..0000000000 --- a/zerver/webhooks/papertrail/doc.html +++ /dev/null @@ -1,45 +0,0 @@ -

- Zulip supports integration with Papertrail as a - Webhook - that fires upon finding a certain log. To do this: -

- -

- First, create the stream you'd like to use for Papertrail - notifications, and subscribe all interested parties to this stream. We - recommend the stream name be papertrail. After create a bot named - Papertrail and note the API key. -

- -

- Next, log into your Papertrail Account and browse through your logs. - Search for logs you want to get alerts for and press the Save Search - to open up a modal window, then fill out the details and press the - Save & Setup an alert button. -

- - - - - -

- Go to the Create an alert section, press the Webhooks - link and place the below URL into the Webhook URL section. Be sure to set - the frequency to either minute, hour or day. -

- -

{{ external_api_uri_subdomain }}/v1/external/papertrail?api_key=abcdefgh&stream=papertrail

- - - -

- Note: api_key is the API key of your Zulip bot, - and stream is the stream name you want the - notifications sent to. -

- -

- Congratulations! You're done!
Your Papertrail notifications will - appear in Zulip: -

- diff --git a/zerver/webhooks/papertrail/doc.md b/zerver/webhooks/papertrail/doc.md new file mode 100644 index 0000000000..f3e872e331 --- /dev/null +++ b/zerver/webhooks/papertrail/doc.md @@ -0,0 +1,27 @@ +Zulip supports integration with Papertrail as a +[Webhook](http://www.perforce.com/perforce/doc.current/manuals/p4sag/chapter.scripting.html) +that fires upon finding a certain log. To do this: + +{!create-stream.md!} + +{!create-bot-construct-url.md!} + +Next, log into your Papertrail Account and browse through +your logs. Search for logs you want to get alerts for and press +**Save Search** to open up a modal window, then fill out the +details and press the **Save & Setup an Alert** button. + +![](/static/images/integrations/papertrail/000.png) + +![](/static/images/integrations/papertrail/001.png) + +Go to the **Create an alert** section, press the **Webhooks** +link and place the URL created above into the **Webhook URL** +section. Be sure to set the frequency to either minute, hour or +day. + +![](/static/images/integrations/papertrail/002.png) + +{!congrats.md!} + +![](/static/images/integrations/papertrail/003.png)