Skip to content

Document generic webhooks #8609

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.

Sign up for GitHub

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

Merged
merged 26 commits into from
Nov 8, 2021
Merged

Document generic webhooks #8609

Changes from 1 commit
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
c0689f1
Document generic webhooks
astrojuanlu Oct 21, 2021
c6c499b
Whitespace
astrojuanlu Oct 25, 2021
0a031b3
Describe legacy webhooks and migration path
astrojuanlu Oct 25, 2021
9405d4b
Add examples
astrojuanlu Oct 25, 2021
2dd6b39
Fix external version disclaimer
astrojuanlu Oct 25, 2021
3e988a5
Add example to validate webhook signature
astrojuanlu Oct 25, 2021
80446dd
Merge branch 'webhooks' into webhooks-documentation
astrojuanlu Oct 25, 2021
ce31189
Fix markup for Discord webhook example
astrojuanlu Oct 25, 2021
43f9dd4
Clarify that validation is optional
astrojuanlu Oct 25, 2021
b6fd66e
Style improvements
astrojuanlu Oct 25, 2021
b443b4f
Fix digest comparison
astrojuanlu Oct 25, 2021
8f55e27
Webhook example improvements
astrojuanlu Oct 25, 2021
39c8ab2
Update external documentation links
astrojuanlu Oct 25, 2021
fe45d31
Fix screenshot zoom
astrojuanlu Oct 25, 2021
33f9557
Move payload validation down
astrojuanlu Nov 8, 2021
1077d61
Update template syntax
astrojuanlu Nov 8, 2021
481380d
Merge branch 'webhooks' into webhooks-documentation
astrojuanlu Nov 8, 2021
19eec46
Complete webhook example payload
astrojuanlu Nov 8, 2021
088e629
Add screenshot for custom payload
astrojuanlu Nov 8, 2021
2a0a031
Style improvements
astrojuanlu Nov 8, 2021
ec9b4fc
Switch to one space for template substitutions
astrojuanlu Nov 8, 2021
b049047
Add examples for URLs
astrojuanlu Nov 8, 2021
94f9fc1
Fix parameter name
astrojuanlu Nov 8, 2021
a928097
Complete remaining variables
astrojuanlu Nov 8, 2021
8f20472
Fix title length
astrojuanlu Nov 8, 2021
04e2953
Fix JSON
astrojuanlu Nov 8, 2021
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
6 changes: 3 additions & 3 deletions docs/build-notifications.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Build Notifications and Webhooks

.. note::

Currently we don't send notifications nor trigger webhooks
Currently we don't send notifications or trigger webhooks
on :doc:`builds from pull requests </pull-requests>`.

Email notifications
Expand All @@ -20,8 +20,8 @@ Take these steps to enable build notifications using email:

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

Webhooks
--------
Build Status Webhooks
------------------------------

Read the Docs can also send webhooks when builds are triggered, successful or failed.

Expand Down