Skip to content

Commit

Permalink
Slack docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mdcanzoneri committed Apr 15, 2016
1 parent d0892b3 commit 861e39d
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 0 deletions.
1 change: 1 addition & 0 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Ptero School
/getting_started/index
/scenarios/what
/dashboard/index
/integrations/index
/admin/index
/billing/index
/faq/index
Expand Down
Binary file added integrations/create-channel.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 39 additions & 0 deletions integrations/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
.. _integrations-top:

Integrations
************************

.. toctree::
:maxdepth: 2


Slack
============================
The Ptero integration for Slack pushes messages to a dedicated channel when scenario results are updated, new scenarios are created, and scenarios are pinned. Never miss important updates and collaborate with your team on analytics in real time!

Setup
______________________________

1. Create a Slack channel for your Ptero alerts.
^^^^^^^^^^^^^^^^^^^^^^^^^^^
In Slack, click on the plus sign next to channels to create a new channel. Next, name your channel (may I suggest ptero-alerts) and invite your your coworkers (the more, the merrier).

.. image:: create-channel.png

2. Connect the Slack integration from your Ptero settings page.
^^^^^^^^^^^^^^^^^^^^^^^^^^^
In Ptero, click on "Settings" in the top right corner than navigate to "Integrations" from the left pane. Next, click "Add to Slack", select your newly created channel, and authorize. You can disconnect at any time by returning to the "Integrations" section. You will receive a confirmation email and Slack message once the app is connected.

.. image:: slack-authorization.png

3. Choose your settings.
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Ptero is initially configured to send alerts when scenarios are updated and to allow login directly from chat using the /ptero login command. You can disable either of these alerts from the "Integrations" section in Ptero.

.. image:: slack-settings.png

Tips & Tricks
______________________________
* Use the /ptero login command to login directly from Slack. New users will be prompted to create an account if they use the /ptero login command. These new users will be added as a non-admin user.

* Keep an eye on our blog and docs for new Slack /ptero commands!
Binary file added integrations/slack-authorization.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added integrations/slack-settings.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 861e39d

Please sign in to comment.