Skip to content

Commit 6d41277

Browse files
authored
Merge pull request #1 from aasis21/Documentation-for-build-notifications-using-webhooks
Documentation for build notifications using webhooks
2 parents fb36498 + 2065c59 commit 6d41277

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

docs/guides/build-notifications.rst

+35-2
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,46 @@
11
Enabling Build Notifications
22
============================
33

4+
Using Email
5+
******************
6+
47
Read the Docs allows you to configure emails that can be sent on failing builds.
58
This makes sure you know when your builds have failed.
69

7-
Take these steps to enable build notifications:
10+
Take these steps to enable build notifications using email:
811

912
* Going to **Admin > Notifications** in your project.
1013
* Fill in the **Email** field under the **New Email Notifications** heading
1114
* Submit the form
1215

13-
You should now get notified when your builds fail!
16+
You should now get notified on your email when your builds fail!
17+
18+
Using Webhook
19+
******************
20+
21+
Read the Docs also allows webhooks configuration to receive notification regarding builds fails.
22+
23+
Take these steps to enable build notifications using webhook:
24+
25+
* Going to **Admin > Notifications** in your project.
26+
* Fill in the **Url** field under the **New Webhook Notifications** heading
27+
* Submit the form
28+
29+
The project name, id and its bulid instance that failed will be sent to your webhook url:
30+
31+
.. code-block:: json
32+
33+
{
34+
'name': project.name,
35+
'slug': project.slug,
36+
'build': {
37+
'id': build.id,
38+
'success': build.success,
39+
'date': build.date.strftime('%Y-%m-%d %H:%M:%S'),
40+
}
41+
}
42+
43+
44+
45+
46+
You should now get notified on your webhook when your builds fail!

0 commit comments

Comments
 (0)