-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
2065c59
Documentation for build notifications using webhooks
aasis21 6d41277
Merge pull request #1 from aasis21/Documentation-for-build-notificati…
aasis21 77d79a8
Update build-notifications.rst
aasis21 cfc7d1c
Update build-notifications.rst
aasis21 b1ff7d3
corrected typo
aasis21 d903e40
futher suggested changes
aasis21 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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", | ||
} | ||
} | ||
|
||
You should now get notified on your webhook when your builds fail! |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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).