Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for build notifications using webhooks. #3671

Merged
merged 6 commits into from
Apr 17, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 33 additions & 3 deletions docs/guides/build-notifications.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,43 @@
Enabling Build Notifications
============================

Using email
-----------

Read the Docs allows you to configure emails that can be sent on failing builds.
This makes sure you know when your builds have failed.

Take these steps to enable build notifications:
Take these steps to enable build notifications using email:

* Going to **Admin > Notifications** in your project.
* Go to **Admin > Notifications** in your project.
* Fill in the **Email** field under the **New Email Notifications** heading
* Submit the form

You should now get notified when your builds fail!
You should now get notified by email when your builds fail!

Using webhook
-------------

Read the Docs can also send webhooks when builds fail.

Take these steps to enable build notifications using a webhook:

* Go to **Admin > Notifications** in your project.
* Fill in the **URL** field under the **New Webhook Notifications** heading
* Submit the form

The project name, slug and its details for the build that failed will be sent as POST request to your webhook URL:

.. code-block:: json

{
"name": "Read the Docs",
"slug": "rtd",
"build": {
"id": 6321373,
"success": false,
"date": "2017-02-15 20:35:54",
}
}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove these extra spaces, please (just leave one).

You should now get notified on your webhook when your builds fail!